class GmScrollbar

A scrollbar.

Inheritance:

Public Methods
Protected Fields
Protected Methods

Inherited from GmRangeWidget:

Public Methods
virtual void addLine()
virtual void addPage()
virtual float getCurrentPercentage()
virtual float getCurrentValue()
virtual float getLineStep()
virtual float getMaximumValue()
virtual float getMinimumValue()
virtual float getPageStep()
virtual void setCurrentPercentage(float currentPercentage)
virtual void setLineStep(float lineStep)
virtual void setMaximumValue(float maxValue)
virtual void setMinimumValue(float minValue)
virtual void setPageStep(float pageStep)
virtual void setRange(float minValue, float maxValue)
virtual void setSteps(float lineStep, float pageStep)
virtual void subtractLine()
virtual void subtractPage()

Protected Fields
float mCurrentValue
float mLineStep
float mMaximumValue
float mMinimumValue
float mPageStep

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 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 setCoordType(GmTypes::CoordinateType coordType)
virtual void setVisible(bool visible)

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:

Inherited from GmWidgetEventHandler:

Documentation

A scrollbar. Scrollbars provide a way for the user to visually slide between a defined range. They are commonly used in conjunction with text areas, list boxes, etc.

GmTypes::OrientationType mOrientation

The orientation of the scrollbar. This allows the object to know how it should draw itself.

float mBorderWidth

The width of the border around the scrollbar

GmGraphicButton* mIncrementButton

A button to increment the value of the scrollbar

GmGraphicButton* mDecrementButton

A button to decrement the value of the scrollbar

GmGraphicButton* mPositionButton

A button to show the current position of scrollbar

bool mNeedRefresh

Allows notification for realignment of scrollbar subcomponents.

GmScrollbar()

Standard constructor

virtual ~GmScrollbar()

Virtual destructor

virtual void setOrientation(GmTypes::OrientationType orientation)

Set the current orientation of the scrollbar. This informs the object how do draw itsef.


Parameters:: orientation -

virtual GmTypes::OrientationType getOrientation()

Get the current orientation of the scrollbar.


Returns:: the current orientation of the scrollbar

virtual void setBorderWidth(float borderWidth)

Sets the width of the border around the scrollbar. The border width is the total percentage that the border should visually encompass on the scrollbar.


Parameters:: border - the width of the border around the scrollbar. The value is the total percentage that the border should visually encompass the scrollbar

virtual float getBorderWidth()

Gets the width of the border around the scrollbar.


Returns:: the width of the border around the scrollbar

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

Sets the position of the drawable. The top-left most pixel of the rendered image will be located at the given point if the coordinate type is CT_ABSOLUTE. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.


Parameters:: - x the X position of the drawable object
- y the Y position of the drawable object
z - the Z position of the drawable object

virtual void setWidth(float width)

Sets the width of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.


Parameters:: width - the width to set the drawable object's width to.

virtual void setHeight(float height)

Sets the height of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.


Parameters:: height - the height to set the drawable object's height to.

virtual void setDepth(float depth)

Sets the depth of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.


Parameters:: depth - the depth to set the drawable object's depth to.

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

Sets the relative geometry to use for this drawable object. This method is provided merely for convenience. This method is intended for use with 2d layouts.


Parameters:: - x the absolute X value for this drawable
- y the absolute Y value for this drawable
width - the width of this drawable
height - the height of this drawable

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

Sets the relative geometry to use for this drawable object. This method is provided merely for convenience.


Parameters:: - x the absolute X value for this drawable
- y the absolute Y value for this drawable
z - the absolute Z value for this drawable
width - the width of this drawable
height - the height of this drawable
depth - the depth of this drawable

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

Repositions and resizes this component based on parameters passed into the method. These parameters are usually passed in by the parent class or parent layout manager.


Parameters:: minX - the starting X position of the constraint volume
minY - the starting Y position of the constraint volume
minZ - the starting Z position of the constraint volume
maxX - the ending X position of the constraint volume
maxY - the ending X position of the constraint volume
maxZ - the ending Z position of the constraint volume

virtual void setBaseColor(GlmColor4* color)

Sets the base color of the object.


Parameters:: color - the base color

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

Sets the base color of the object.


Parameters:: r - the red value
g - the green value
b - the blue value
a - the alpha value

virtual void setCurrentValue(float currentValue)

Set the currently set value for the range.


Parameters:: currentValue - the new current value

virtual void mousePressEvent(GmEvent* event)

Event processing function to process a mouse release event.


Parameters:: event - the mouse release event for this object to process

virtual void widgetEvent(GmEvent::WidgetEventType* widgetEvent)

Called whenever a sub-component radio button is selected. This method de-selects the previously selected component.


Parameters:: - widgetEvent the widget event, which includes all relevant user data.

virtual void render2d(GmTypes::RenderOptionType renderOptions)

Renders this scrollbar to a 2D image buffer.


Parameters:: renderOptions - the render options to use when rendering the scrollbar.

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

Renders this scrollbar to a 2D selection buffer.


Parameters:: renderOptions - the render options to use when rendering the scrollbar.

virtual void refresh()

Refreshes the positions of the three scrollbar components

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.

	GmScrollbar () Standard constructor
virtual void	applyLayout (float minX, float minY, float minZ, float maxX, float maxY, float maxZ) Repositions and resizes this component based on parameters passed into the method.
virtual float	getBorderWidth () Gets the width of the border around the scrollbar.
virtual GmTypes::OrientationType	getOrientation () Get the current orientation of the scrollbar.
virtual void	mousePressEvent (GmEvent* event) Event processing function to process a mouse release event.
virtual void	setBaseColor (GlmColor4* color) Sets the base color of the object.
virtual void	setBaseColor (float r, float g, float b, float a) Sets the base color of the object.
virtual void	setBorderWidth (float borderWidth) Sets the width of the border around the scrollbar.
virtual void	setCurrentValue (float currentValue) Set the currently set value for the range.
virtual void	setDepth (float depth) Sets the depth of the drawable object in units.
virtual void	setHeight (float height) Sets the height of the drawable object in units.
virtual void	setOrientation (GmTypes::OrientationType orientation) Set the current orientation of the scrollbar.
virtual void	setPosition (float x, float y, float z) Sets the position of the drawable.
virtual void	setRelativeGeometry (float x, float y, float z, float width, float height, float depth) Sets the relative geometry to use for this drawable object.
virtual void	setRelativeGeometry (float x, float y, float width, float height) Sets the relative geometry to use for this drawable object.
virtual void	setWidth (float width) Sets the width of the drawable object in units.
virtual void	widgetEvent (GmEvent::WidgetEventType* widgetEvent) Called whenever a sub-component radio button is selected.
virtual	~GmScrollbar () Virtual destructor

float	mBorderWidth The width of the border around the scrollbar
GmGraphicButton*	mDecrementButton A button to decrement the value of the scrollbar
GmGraphicButton*	mIncrementButton A button to increment the value of the scrollbar
bool	mNeedRefresh Allows notification for realignment of scrollbar subcomponents.
GmTypes::OrientationType	mOrientation The orientation of the scrollbar.
GmGraphicButton*	mPositionButton A button to show the current position of scrollbar

virtual void	refresh () Refreshes the positions of the three scrollbar components
virtual void	render2d (GmTypes::RenderOptionType renderOptions) Renders this scrollbar to a 2D image buffer.
virtual void	render2dSelect (GmTypes::RenderOptionType renderOptions) Renders this scrollbar to a 2D selection buffer.