editor::page::Page Class Reference

Base class for all editor pages. More...

#include <Page.hpp>

Inheritance diagram for editor::page::Page:

Public Member Functions
	Page (core::system::Systems &systems)
	Construct a new Page. More...
virtual	~Page ()=default
	Destroy the Page. More...
virtual void	update (float dt)=0
	Any custom page update logic outside of event callbacks goes here. More...
bl::gui::Box::Ptr	getContent ()
	Returns the content to put in the editor. More...
void	registerGui (bl::gui::GUI *parent)
	Registers the parent GUI. More...

Protected Attributes
core::system::Systems &	systems
bl::gui::Box::Ptr	content
bl::gui::GUI *	parent

Detailed Description

Base class for all editor pages.

Definition at line 32 of file Page.hpp.

Constructor & Destructor Documentation

Page()

editor::page::Page::Page

(

core::system::Systems &

systems

)

Construct a new Page.

Parameters

systems

The primary systems object

Definition at line 7 of file Page.cpp.

~Page()

virtual editor::page::Page::~Page ( )

virtualdefault

Destroy the Page.

Member Function Documentation

getContent()

bl::gui::Box::Ptr editor::page::Page::getContent

(

)

Returns the content to put in the editor.

Definition at line 11 of file Page.cpp.

registerGui()

void editor::page::Page::registerGui

(

bl::gui::GUI *

parent

)

Registers the parent GUI.

Parameters

parent

The parent GUI object

Definition at line 13 of file Page.cpp.

update()

virtual void editor::page::Page::update ( float  dt )

pure virtual

Any custom page update logic outside of event callbacks goes here.

Parameters

dt	Time elapsed in seconds

Implemented in editor::page::VariousEditors, editor::page::Scripts, editor::page::Peoplemon, editor::page::Moves, editor::page::Map, editor::page::Items, and editor::page::Credits.

Member Data Documentation

content

bl::gui::Box::Ptr editor::page::Page::content

protected

Definition at line 69 of file Page.hpp.

parent

bl::gui::GUI* editor::page::Page::parent

protected

Definition at line 70 of file Page.hpp.

systems

core::system::Systems& editor::page::Page::systems

protected

Definition at line 68 of file Page.hpp.

---

The documentation for this class was generated from the following files:

• include/Editor/Pages/Page.hpp
• src/Editor/Pages/Page.cpp