GuiSeparatorCtrl Class Reference

#include <guiSeparatorCtrl.h>

Inheritance diagram for GuiSeparatorCtrl:

Detailed Description

Renders a separator line with optional text.

Public Types

separatorTypeVertical = 0

Draw Vertical Separator.

separatorTypeHorizontal

Horizontal Separator.

enum separatorTypeOptions {
separatorTypeVertical = 0,
separatorTypeHorizontal
}

Public Member Functions

DECLARE_CONOBJECT (GuiSeparatorCtrl)

GuiSeparatorCtrl ()

void onRender (Point2I offset, const RectI &updateRect)

Called when this control is to render itself.

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Public Attributes

bool mInvisible

StringTableEntry mText

S32 mTextLeftMargin

S32 mMargin

S32 mSeparatorType

Private Types

typedef GuiControl Parent

Reimplemented from GuiControl.

Enumerator:

separatorTypeVertical	Draw Vertical Separator.
separatorTypeHorizontal	Horizontal Separator.

GuiSeparatorCtrl::GuiSeparatorCtrl ( )

GuiSeparatorCtrl::DECLARE_CONOBJECT ( GuiSeparatorCtrl )

static void GuiSeparatorCtrl::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDeprecatedField(), addGroup(), endGroup()

Reimplemented from GuiControl.

void GuiSeparatorCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[virtual]`

Called when this control is to render itself.

Parameters:

	offset	The location this control is to begin rendering
	updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.