Planeshift
Public Member Functions

EEditFPSToolbox Class Reference

This handles the displaying of FPS and controlling the cap. More...

#include <eeditfpstoolbox.h>

List of all members.

Public Member Functions

 EEditFPSToolbox ()
float GetFPS () const
 Retrieves the current FPS.
virtual const char * GetName () const
 Gets the name of the toolbox.
float GetTargetFPS () const
 Retrieves the current target FPS.
virtual size_t GetType () const
 Gets the toolbox type.
virtual bool OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
 Called whenever a button is pressed.
virtual bool PostSetup ()
 This is called after the widget and all of it's children have been created.
virtual void Update (unsigned int elapsed)
 Updates the toobox.
virtual ~EEditFPSToolbox ()

Detailed Description

This handles the displaying of FPS and controlling the cap.

Definition at line 46 of file eeditfpstoolbox.h.


Constructor & Destructor Documentation

EEditFPSToolbox::EEditFPSToolbox ( )
virtual EEditFPSToolbox::~EEditFPSToolbox ( ) [virtual]

Member Function Documentation

float EEditFPSToolbox::GetFPS ( ) const

Retrieves the current FPS.

Returns:
The current FPS.
virtual const char* EEditFPSToolbox::GetName ( ) const [virtual]

Gets the name of the toolbox.

Returns:
the toolbox name

Implements EEditToolbox.

float EEditFPSToolbox::GetTargetFPS ( ) const

Retrieves the current target FPS.

Returns:
The current target FPS.
virtual size_t EEditFPSToolbox::GetType ( ) const [virtual]

Gets the toolbox type.

Returns:
the toolbox type

Implements EEditToolbox.

virtual bool EEditFPSToolbox::OnButtonPressed ( int  button,
int  keyModifier,
pawsWidget widget 
) [virtual]

Called whenever a button is pressed.

Parameters:
buttonThe button pressed.
keyModifierModifier key in effect.
widgetThe widget the button belongs to.
Returns:
bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool EEditFPSToolbox::PostSetup ( ) [virtual]

This is called after the widget and all of it's children have been created.

Remarks:
This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

virtual void EEditFPSToolbox::Update ( unsigned int  elapsed) [virtual]

Updates the toobox.

Parameters:
elapsedthe time elapsed in milliseconds.

Reimplemented from EEditToolbox.


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