Crazy Eddie's GUI System  ${CEGUI_VERSION}
CEGuiRendererSelector Class Referenceabstract

Base class for the renderer selection dialog class. More...

Inherited by CLICEGuiRendererSelector, GTK2CEGuiRendererSelector, MacCEGuiRendererSelector, and Win32CEGuiRendererSelector.

Public Member Functions

 CEGuiRendererSelector ()
 Constructor.
 
virtual ~CEGuiRendererSelector ()
 Destructor.
 
virtual bool invokeDialog ()=0
 Displays a dialog allowing the user to select a renderer to be used. More...
 
CEGuiRendererType getSelectedRendererType ()
 Return the CEGuiRendererType value of the renderer most recently selected by the user. More...
 
void setRendererAvailability (CEGuiRendererType rendererType, bool available=true)
 Set whether or not a specific renderer type will be available for selection from the dialog the next time it is displayed. More...
 

Protected Attributes

CEGuiRendererType d_lastSelected
 Holds the last selected renderer type.
 
bool d_rendererAvailability [RendererTypeCount]
 Holds availability of renderer types.
 

Detailed Description

Base class for the renderer selection dialog class.

This should be sub-classed to do something useful. Initialisation should happen in the constructor and cleanup in the destructor. The invokeDialog should only display the dialog (and not return until the dialog is dismissed).

Member Function Documentation

◆ getSelectedRendererType()

CEGuiRendererType CEGuiRendererSelector::getSelectedRendererType ( )

Return the CEGuiRendererType value of the renderer most recently selected by the user.

Returns
One of the CEGuiRendererType enumerated values.

References d_lastSelected.

Referenced by SamplesFrameworkBase::initialise().

◆ invokeDialog()

virtual bool CEGuiRendererSelector::invokeDialog ( )
pure virtual

Displays a dialog allowing the user to select a renderer to be used.

Returns
false if the user cancelled.

Implemented in Win32CEGuiRendererSelector, CLICEGuiRendererSelector, MacCEGuiRendererSelector, and GTK2CEGuiRendererSelector.

Referenced by SamplesFrameworkBase::initialise().

◆ setRendererAvailability()

void CEGuiRendererSelector::setRendererAvailability ( CEGuiRendererType  rendererType,
bool  available = true 
)

Set whether or not a specific renderer type will be available for selection from the dialog the next time it is displayed.

Parameters
rendererTypeOne of the CEGuiRendererType enumerated values representing the renderer whos availability will be set.
available
  • true if this renderer should be available to the user.
  • false if this renderer should not be available.

References d_rendererAvailability.

Referenced by SamplesFrameworkBase::initialise().