OGRE  1.12.5
Object-Oriented Graphics Rendering Engine
OgreBites::CheckBox Class Reference

Basic check box widget. More...

#include <OgreTrays.h>

+ Inheritance diagram for OgreBites::CheckBox:

Public Member Functions

 CheckBox (const Ogre::String &name, const Ogre::DisplayString &caption, Ogre::Real width)
 Do not instantiate any widgets directly. Use TrayManager. More...
 
void _assignListener (TrayListener *listener)
 
void _assignToTray (TrayLocation trayLoc)
 
void _cursorMoved (const Ogre::Vector2 &cursorPos, float wheelDelta)
 
void _cursorPressed (const Ogre::Vector2 &cursorPos)
 
virtual void _cursorReleased (const Ogre::Vector2 &cursorPos)
 
void _focusLost ()
 
void cleanup ()
 
const Ogre::DisplayStringgetCaption ()
 
const Ogre::StringgetName ()
 
Ogre::OverlayElementgetOverlayElement ()
 
TrayLocation getTrayLocation ()
 
void hide ()
 
bool isChecked ()
 
bool isVisible ()
 
void setCaption (const Ogre::DisplayString &caption)
 
void setChecked (bool checked, bool notifyListener=true)
 
void show ()
 
void toggle (bool notifyListener=true)
 

Static Public Member Functions

static Ogre::Vector2 cursorOffset (Ogre::OverlayElement *element, const Ogre::Vector2 &cursorPos)
 Static utility method used to get the cursor's offset from the center of an overlay element in pixels. More...
 
static void fitCaptionToArea (const Ogre::DisplayString &caption, Ogre::TextAreaOverlayElement *area, Ogre::Real maxWidth)
 Static utility method to cut off a string to fit in a text area. More...
 
static Ogre::Real getCaptionWidth (const Ogre::DisplayString &caption, Ogre::TextAreaOverlayElement *area)
 Static utility method used to get the width of a caption in a text area. More...
 
static bool isCursorOver (Ogre::OverlayElement *element, const Ogre::Vector2 &cursorPos, Ogre::Real voidBorder=0)
 Static utility method to check if the cursor is over an overlay element. More...
 
static void nukeOverlayElement (Ogre::OverlayElement *element)
 Static utility method to recursively delete an overlay element plus all of its children from the system. More...
 

Detailed Description

Basic check box widget.

Constructor & Destructor Documentation

◆ CheckBox()

OgreBites::CheckBox::CheckBox ( const Ogre::String name,
const Ogre::DisplayString caption,
Ogre::Real  width 
)

Do not instantiate any widgets directly. Use TrayManager.

Member Function Documentation

◆ getCaption()

const Ogre::DisplayString& OgreBites::CheckBox::getCaption ( )
inline

◆ setCaption()

void OgreBites::CheckBox::setCaption ( const Ogre::DisplayString caption)

◆ isChecked()

bool OgreBites::CheckBox::isChecked ( )
inline

◆ setChecked()

void OgreBites::CheckBox::setChecked ( bool  checked,
bool  notifyListener = true 
)

◆ toggle()

void OgreBites::CheckBox::toggle ( bool  notifyListener = true)

◆ _cursorPressed()

void OgreBites::CheckBox::_cursorPressed ( const Ogre::Vector2 cursorPos)
virtual

Reimplemented from OgreBites::Widget.

◆ _cursorMoved()

void OgreBites::CheckBox::_cursorMoved ( const Ogre::Vector2 cursorPos,
float  wheelDelta 
)
virtual

Reimplemented from OgreBites::Widget.

◆ _focusLost()

void OgreBites::CheckBox::_focusLost ( )
virtual

Reimplemented from OgreBites::Widget.

◆ cleanup()

void OgreBites::Widget::cleanup ( )
inherited

◆ nukeOverlayElement()

static void OgreBites::Widget::nukeOverlayElement ( Ogre::OverlayElement element)
staticinherited

Static utility method to recursively delete an overlay element plus all of its children from the system.

◆ isCursorOver()

static bool OgreBites::Widget::isCursorOver ( Ogre::OverlayElement element,
const Ogre::Vector2 cursorPos,
Ogre::Real  voidBorder = 0 
)
staticinherited

Static utility method to check if the cursor is over an overlay element.

◆ cursorOffset()

static Ogre::Vector2 OgreBites::Widget::cursorOffset ( Ogre::OverlayElement element,
const Ogre::Vector2 cursorPos 
)
staticinherited

Static utility method used to get the cursor's offset from the center of an overlay element in pixels.

◆ getCaptionWidth()

static Ogre::Real OgreBites::Widget::getCaptionWidth ( const Ogre::DisplayString caption,
Ogre::TextAreaOverlayElement area 
)
staticinherited

Static utility method used to get the width of a caption in a text area.

◆ fitCaptionToArea()

static void OgreBites::Widget::fitCaptionToArea ( const Ogre::DisplayString caption,
Ogre::TextAreaOverlayElement area,
Ogre::Real  maxWidth 
)
staticinherited

Static utility method to cut off a string to fit in a text area.

◆ getOverlayElement()

Ogre::OverlayElement* OgreBites::Widget::getOverlayElement ( )
inlineinherited

◆ getName()

const Ogre::String& OgreBites::Widget::getName ( void  )
inlineinherited

◆ getTrayLocation()

TrayLocation OgreBites::Widget::getTrayLocation ( )
inlineinherited

◆ hide()

void OgreBites::Widget::hide ( )
inlineinherited

◆ show()

void OgreBites::Widget::show ( )
inlineinherited

◆ isVisible()

bool OgreBites::Widget::isVisible ( void  )
inlineinherited

◆ _cursorReleased()

virtual void OgreBites::Widget::_cursorReleased ( const Ogre::Vector2 cursorPos)
inlinevirtualinherited

◆ _assignToTray()

void OgreBites::Widget::_assignToTray ( TrayLocation  trayLoc)
inlineinherited

◆ _assignListener()

void OgreBites::Widget::_assignListener ( TrayListener listener)
inlineinherited

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