The GmDialog is a container that represents a dialog with the user.

Inheritance:

Public Methods

	GmDialog () Standard constructor
virtual char*	getTitleText () Gets the title text that is currently associated with this dialog.
GlmColor4*	getTitleTextColor () Gets the color that is currently assigned to the title text.
void	getTitleTextJustification (GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical) Gets the type of justification for the title text of the dialog
float	getTitleTextPointSize () Gets the size of the title text in points.
virtual GlmColor4*	getTitlebarColor () Gets the color of the dailog's titlebar.
virtual void	setTitleText (char* titleText) Sets the title text of this dialog to the given text.
void	setTitleTextColor (GlmColor4* color) Sets the display color of the title text.
void	setTitleTextColor (float r, float g, float b, float a) Sets the display color of the title text to the given red, green, blue and alpha values.
void	setTitleTextJustification (GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical) Sets the horizontal and vertical title text justification for the dialog.
void	setTitleTextPointSize (float pointSize) Sets the point size of the title text, this will affect the size at which the font is rendered for the text string.
virtual void	setTitlebarColor (float r, float g, float b, float a) Sets the color of the dialog's titlebar.
virtual	~GmDialog () Virtual destructor

Protected Fields

GmTextWidget*	mTitleTextWidget Some text for labeling the title bar of the dialog
GlmColor4	mTitlebarColor The color of the titlebar

Inherited from GmContainer:

Public Methods

virtual void addComponent(GmDrawable* component)

virtual void applyLayout(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)

virtual int findComponent(float x, float y)

GmLayoutManager* getLayout()

void setLayout(GmLayoutManager* layoutManager)

Protected Fields

vector<GmDrawable*> mComponents

GmLayoutManager* mLayoutManager

Protected Methods

virtual void applyLayout()

virtual void render2d(GmTypes::RenderOptionType renderOptions)

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

Inherited from GmInteractiveWidget:

Public Fields

GmFocusEventHandler* focusEventHandler

GmKeyEventHandler* keyEventHandler

GmAnimation* mFocusGainAnim

GmAnimation* mFocusLoseAnim

GmTypes::FocusType mFocusState

unsigned int mFocusTimestamp

GmAnimation* mKeyPressAnim

GmAnimation* mKeyReleaseAnim

GmAnimation* mMouseExitAnim

GmAnimation* mMouseOverAnim

GmAnimation* mMousePressAnim

GmAnimation* mMouseReleaseAnim

WidgetIDType mWidgetId

GmToolTip* mWidgetToolTip

GmMouseEventHandler* mouseEventHandler

GmUserEventHandler* userEventHandler

GmWidgetEventHandler* widgetEventHandler

Public Methods

virtual void focusGainEvent(GmEvent* event)

virtual void focusLoseEvent(GmEvent* event)

virtual WidgetIDType getWidgetId()

virtual void keyPressEvent(GmEvent* event)

virtual void keyReleaseEvent(GmEvent* event)

virtual void mouseDragEvent(GmEvent* event)

virtual void mouseMoveEvent(GmEvent* event)

virtual void mousePressEvent(GmEvent* event)

virtual void mouseReleaseEvent(GmEvent* event)

virtual void setFocusEventHandler(GmFocusEventHandler* focusHandler, WidgetIDType widgetId)

virtual void setKeyEventHandler(GmKeyEventHandler* keyHandler, WidgetIDType widgetId)

virtual void setMouseEventHandler(GmMouseEventHandler* mouseHandler, WidgetIDType widgetId)

virtual void setToolTip(GmToolTip* tooltip)

virtual void setUserEventHandler(GmUserEventHandler* userHandler, WidgetIDType widgetId)

virtual void setWidgetEventHandler(GmWidgetEventHandler* widgetHandler, WidgetIDType widgetId)

virtual void userEvent(GmEvent* event)

virtual void wheelMoveEvent(GmEvent* event)

Protected Methods

virtual void render2dToolTip(GmTypes::RenderOptionType renderOptions)

Inherited from GmAnimatedWidget:

Public Methods

virtual void animationFinished(GmTypes::AnimationType animationType)

virtual void applyAnimationTransforms()

virtual void setEventAnimation(GmTypes::AnimationType animType, GmAnimation* animation)

Protected Fields

GmAnimation* mAppearAnimation

GmTypes::AnimationType mCurrentAnimation

GmAnimation* mIdleAnimation

GmAnimation* mVanishAnimation

Inherited from GmDrawable:

Public Methods

virtual GlmColor4* getBaseColor()

virtual GmTypes::CoordinateType getCoordType()

virtual float getDepth()

virtual float getGlDepth()

virtual void getGlExtents(float& width, float& height)

virtual float getGlHeight()

virtual GlmPoint3* getGlPosition()

virtual float getGlWidth()

virtual float getHeight()

virtual void getMinimumGeometry(float& width, float& height, float& depth)

virtual GlmPoint3* getPosition()

virtual bool getVisible()

virtual float getWidth()

virtual void render(GmTypes::RenderOptionType renderOptions)

virtual void setAbsoluteGeometry(float x, float y, float z, float width, float height, float depth)

virtual void setBaseColor(GlmColor4* color)

virtual void setBaseColor(float r, float g, float b, float a)

virtual void setCoordType(GmTypes::CoordinateType coordType)

virtual void setDepth(float depth)

virtual void setHeight(float height)

virtual void setPosition(float x, float y, float z)

virtual void setPosition(GlmPoint3* point)

virtual void setRelativeGeometry(float x, float y, float z, float width, float height, float depth)

virtual void setRelativeGeometry(float x, float y, float width, float height)

virtual void setVisible(bool visible)

virtual void setWidth(float width)

Protected Fields

GlmColor4 mBaseColor

GmTypes::CoordinateType mCoordType

float mDepth

bool mDisplayListGenerate

int mDisplayListId

float mGlDepth

float mGlHeight

GlmPoint3 mGlPosition

float mGlWidth

float mHeight

GlmPoint3 mPosition

bool mVisible

float mWidth

Protected Methods

virtual bool getDisplayListGenerate()

virtual int getDisplayListId()

virtual void setDisplayListGenerate(bool generate)

virtual void setDisplayListId(int id)

Inherited from GmObject:

Public Methods

unsigned short getObjectId()

Protected Fields

The object ID is used to uniquely identify each GmObject unsigned short mObjectId

Inherited from GmAnimationEventHandler:

Documentation

The GmDialog is a container that represents a dialog with the user. Things such as file selection, pop-up, progress meter, and the like would use a GmDialog as their base class.

GmTextWidget* mTitleTextWidget

Some text for labeling the title bar of the dialog

GlmColor4 mTitlebarColor

The color of the titlebar

GmDialog()

Standard constructor

virtual ~GmDialog()

Virtual destructor

virtual void setTitlebarColor(float r, float g, float b, float a)

Sets the color of the dialog's titlebar.

Parameters:

r - the red component of the color
g - the green component of the color
b - the blue component of the color
a - the alpha component of the color

virtual GlmColor4* getTitlebarColor()

Gets the color of the dailog's titlebar.

Returns:

the title text color as a GlmColor4 object, THIS IS A BORROWED POINTER, DO NOT DELETE IT!

virtual void setTitleText(char* titleText)

Sets the title text of this dialog to the given text.

Parameters:

text - the title text to set as this dialog's title bar

virtual char* getTitleText()

Gets the title text that is currently associated with this dialog.

Returns:

s a pointer to the text that this widget is set to display. THIS IS A BORROWED POINTER, DO NOT DELETE IT!

void setTitleTextColor(GlmColor4* color)

Sets the display color of the title text.

Parameters:

color - the color to set as the title text color

void setTitleTextColor(float r, float g, float b, float a)

Sets the display color of the title text to the given red, green, blue and alpha values.

Parameters:

r - the red component of the color
g - the green component of the color
b - the blue component of the color
a - the alpha component of the color

GlmColor4* getTitleTextColor()

Gets the color that is currently assigned to the title text.

Returns:

the title text color as a GlmColor4 object, THIS IS A BORROWED REFERENCE, DO NOT DELETE IT!

void setTitleTextPointSize(float pointSize)

Sets the point size of the title text, this will affect the size at which the font is rendered for the text string.

Parameters:

pointSize - the size of the title text in points

float getTitleTextPointSize()

Gets the size of the title text in points.

Returns:

the point size of the title text that is to be rendered by this widget.

void setTitleTextJustification(GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical)

Sets the horizontal and vertical title text justification for the dialog.

Parameters:

horizontal - the horizontal justification to use for the title text
vertical - the vertical justification to use for the title text

void getTitleTextJustification(GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical)

Gets the type of justification for the title text of the dialog

Parameters:

horizontal - the horizontal text justification for the title text
vertical - the vertical text justification for the title text

Direct child classes:

GmProgressDialog

Alphabetic index HTML hierarchy of classes or Java