GUI_Page Class Reference

A class that is an empty GUI element used to group children. More...

Inheritance diagram for GUI_Page:

Public Member Functions
	GUI_Page (RECT mRect, int _id, GUI_ElementStyle *_style, bool drawbackground=false)
void	DrawMe (SURFHANDLE _tgt, int xoffset, int yoffset, RECT &drawablerect)
	Draws this element. More...
virtual void	AddChild (GUI_BaseElement *child)
	Adds a child to this element. More...
Public Member Functions inherited from GUI_BaseElement
	GUI_BaseElement (RECT _rect, int _id, GUI_ElementStyle *_style)
virtual void	Draw (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
	Draws the element and its children to a SURFHANDLE. More...
virtual bool	Update ()
	Checks if this element or any of its children need to be redrawn. More...
int	ProcessMouse (GUI_MOUSE_EVENT _event, int _x, int _y)
	Checks if the element or any of its children have been clicked. More...
void	GetRect (RECT &mRect)
	Copies the elements rect to the passed reference. More...
GUI_ElementStyle *	GetStyle ()
int	GetWidth ()
int	GetHeight ()
int	GetId ()
GUI_ELEMENT_TYPE	GetType ()
virtual void	SetVisible (bool _visible)
	Sets if the elements and its children are drawn or not. More...
bool	GetVisible ()
virtual void	SetFixed (bool fixed)
bool	GetFixed ()
virtual void	SetNoBlit (bool noblit)
bool	GetNoBlit ()
SURFHANDLE	GetSurface ()
void	AddPlugin (GUIplugin *plugin)
	Adds a GUIplugin as a child of this element. More...
void	RemovePlugin (GUIplugin *plugin)
	Unplugs a plugin from this element. More...

Protected Member Functions
bool	ProcessMe (GUI_MOUSE_EVENT _event, int _x, int _y)
	Processes events for this element. More...
void	reSize ()
	Forces the page to stretch its size to include all current children. More...
Protected Member Functions inherited from GUI_BaseElement
virtual void	DrawChildren (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
	Draws all direct children of this element, and tells them to draw theirs. More...
virtual int	ProcessChildren (GUI_MOUSE_EVENT _event, int _x, int _y)
	Forwards event to its children. More...
virtual bool	updateMe ()
	used for checking whether this element needs a redraw although it didn't have any user input More...
virtual bool	updateChildren ()
	checks if any of the children need a redraw More...
void	calculateBlitData (int xoffset, int yoffset, RECT &drawablerect, BLITDATA &OUT_blitdata)
	Calculates the positional and dimensional data needed for blitting, both for source as well as target surface. More...
void	calculateMyDrawableRect (RECT &drawablerect_parent, int xoffset, int yoffset, RECT &OUT_mydrawablerect)
	calculates the real drawable rect of this element considering the drawable rect of the parent. More...

Protected Attributes
bool	expandwithchildren = false
	If true, the page will expand its own size when a child is added that does not fit. This is merely used to avoid clipping problems. If the page is set to draw a background, there will be problems!
Protected Attributes inherited from GUI_BaseElement
GUI_ELEMENT_TYPE	type
	The type of this element.
RECT	rect
	Rect the element should draw on, relative to parent.
int	width
	The width of the element.
int	height
	The height of the element.
int	id
	The locally unique identifier of the element.
SURFHANDLE	src = NULL
	Source surface to draw the element on. When the element is drawn on the panel, it will be blitted from this surface.
bool	noBlitting = false
	Some elements might not have to blit themselves because they are static part of the background. This is not the same as !visible, as the element still processes events and still draws children, it just doesn't draw itself.
vector< GUI_BaseElement * >	children
	List containing all direct children of this element.
vector< GUIplugin * >	plugins
	List containing all GUIplugins currently pluged into this element.
GUI_font *	font
	The font used by this element.
GUI_ElementStyle *	style
	The style used by this element.
bool	visible
	Whether the element is visible or not (if false, element and any of its children will neither draw nor process events)
bool	isfixed = false
	Whether the element retains a fixed position in a scrolling frame.

Private Member Functions
void	createPage ()
	Draws the page to its source surface, if it was created with a drawable background.

Detailed Description

A class that is an empty GUI element used to group children.

A GUI_Page can draw a background if you need it to, but most of the time it's not necessary

Note

Specialised menu implementations usually inherit this class.

Constructor & Destructor Documentation

GUI_Page::GUI_Page	(	RECT	mRect,
		int	_id,
		GUI_ElementStyle *	_style,
		bool	drawbackground = false
	)

Parameters

mRect	Parent-relative position and dimensions
_id	Identifier of the element, locally unique to the containing GUIentity
_style	The style to render the page in, if drawbackground is true
drawbackground	Pass true if you need this page to draw background and borders

Note

The option to draw the background cannot be set retroactively, it must be decided at creation. The page will not bother to allocate texture memory for itself if this option is not set.

See also

ScrollablePage

Member Function Documentation

void GUI_Page::AddChild ( GUI_BaseElement *  child )

virtual

Adds a child to this element.

Parameters

child

A pointer to the element to add as a child of this.

Note

It is technically possible for an element to be the child of multiple elements, but there's a high probability that it will lead to undesired side effects.

Reimplemented from GUI_BaseElement.

Reimplemented in GUI_ScrollablePage.

void GUI_Page::DrawMe ( SURFHANDLE  _tgt, int  xoffset, int  yoffset, RECT &  drawablerect  )

virtual

Draws this element.

Separated from DrawChildren so it can be freely overloaded

Parameters

_tgt	The target surface to draw to
xoffset	The offset between this element rects left edge and the left panel edge, in pixel
yoffset	The offset between this element rects top edge and the top panel edge, in pixel
drawablerect	The total drawable rect of this element. Serves as clipping rect.

Reimplemented from GUI_BaseElement.

Reimplemented in GUI_ScrollablePage.

bool GUI_Page::ProcessMe ( GUI_MOUSE_EVENT  _event, int  _x, int  _y  )

protectedvirtual

Processes events for this element.

Separated from ProcessChildren() so either can be freely overloaded without the other

Parameters

_event	The mouse event that triggered the call
_x	the x coordinate of the click, relative to the panel
_y	the y coordinate of the click, relative to the panel

Returns

True if this element has consumed the event

Reimplemented from GUI_BaseElement.

void GUI_Page::reSize ( )

protected

Forces the page to stretch its size to include all current children.

Note

Does not resize the background in case The page is drawn with a background!

---

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

• C:/Orbiter2016/Orbitersdk/IMS2/GUI_Page.h
• C:/Orbiter2016/Orbitersdk/IMS2/GUI_Page.cpp