[]Jimmy's World.org
I care not for your petty politics.
[]
Jimmy's World Games
Not a Member? - Login or Create an Account
[] Tuesday the 6th of January 2009 @ 12:44am
News Journal Creative Writing Projects Your JW About

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cGuiButtonSelectBox Class Reference

A gui element which will draw at the current mouse location to act as a mouse point`er. More...

#include <cGuiButtonSelectBox.h>

Inheritance diagram for n2l::cGuiButtonSelectBox:

Inheritance graph
[legend]
Collaboration diagram for n2l::cGuiButtonSelectBox:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Static Public Attributes

Protected Member Functions

Classes

  • class cItemSelectedAction

Detailed Description

A gui element which will draw at the current mouse location to act as a mouse point`er.

Definition at line 47 of file cGuiButtonSelectBox.h.


Constructor & Destructor Documentation

n2l::cGuiButtonSelectBox::cGuiButtonSelectBox  ) 
 

Definition at line 52 of file cGuiButtonSelectBox.cpp.

n2l::cGuiButtonSelectBox::cGuiButtonSelectBox const cVfsNodeInterface iNode  ) 
 

Definition at line 58 of file cGuiButtonSelectBox.cpp.

References load().

n2l::cGuiButtonSelectBox::cGuiButtonSelectBox const cDynVar iDef  ) 
 

Definition at line 65 of file cGuiButtonSelectBox.cpp.

References load().

n2l::cGuiButtonSelectBox::~cGuiButtonSelectBox  )  [virtual]
 

Definition at line 72 of file cGuiButtonSelectBox.cpp.


Member Function Documentation

void n2l::cGuiButtonSelectBox::addButton const cDynVar iValue,
const tString iLabel,
const cGuiButton iButtonTemplate
[virtual]
 

Definition at line 174 of file cGuiButtonSelectBox.cpp.

References n2l::cGuiButton::clone(), n2l::cString::empty(), n2l::GuiActionType_Clicked, n2l::cAutoPtr< TPtr >::isSet(), n2l::cGuiButton::Type_Toggle, and n2l::cVector2< TComponent, TComponentDiff, TMagnitude >::y().

Referenced by load().

void n2l::cGuiButtonSelectBox::clearButtons  )  [virtual]
 

Definition at line 299 of file cGuiButtonSelectBox.cpp.

References n2l::cAutoPtr< TPtr >::isSet(), NoSelection, and n2l::cVector2< TComponent, TComponentDiff, TMagnitude >::set().

void n2l::cGuiButtonSelectBox::clearSelections  )  [virtual]
 

Definition at line 281 of file cGuiButtonSelectBox.cpp.

References NoSelection.

const cAutoPtr< cGuiElement > n2l::cGuiButtonSelectBox::clone  )  const [virtual]
 

Return a new element using this element as a template for its construction.

Reimplemented from n2l::cGuiInteractive.

Definition at line 465 of file cGuiButtonSelectBox.cpp.

References cloneInto().

void n2l::cGuiButtonSelectBox::cloneInto const cAutoPtr< cGuiButtonSelectBox > &  i_ioElement  )  const [protected, virtual]
 

Definition at line 473 of file cGuiButtonSelectBox.cpp.

References n2l::cGuiInteractive::cloneInto(), NoSelection, and noUnselect().

Referenced by clone().

void n2l::cGuiButtonSelectBox::dimensionChanged  )  [protected, virtual]
 

Re-map the children elements to fit within our new dimentions.

Reimplemented from n2l::cGuiElement.

Definition at line 498 of file cGuiButtonSelectBox.cpp.

References n2l::cGuiElement::dimensionChanged(), n2l::cGuiElement::innerPos(), n2l::cGuiElement::innerSize(), n2l::cAutoPtr< TPtr >::isSet(), and n2l::cGuiElement::size().

Referenced by slider().

void n2l::cGuiButtonSelectBox::draw  )  const [virtual]
 

Draw ourselves on the screen.

Note:
This method does not set the projection matrix.

Reimplemented from n2l::cGuiElement.

Definition at line 149 of file cGuiButtonSelectBox.cpp.

References n2l::cAutoPtr< TPtr >::isSet().

const cAutoPtr< cGuiButton > & n2l::cGuiButtonSelectBox::getButton const cDynVar iValue  )  [virtual]
 

Definition at line 408 of file cGuiButtonSelectBox.cpp.

References getButtonByIndex().

const cAutoPtr< cGuiButton > & n2l::cGuiButtonSelectBox::getButtonByIndex const tUint iIndex  )  [virtual]
 

Definition at line 432 of file cGuiButtonSelectBox.cpp.

Referenced by getButton(), and getButtonByLabel().

const cAutoPtr< cGuiButton > & n2l::cGuiButtonSelectBox::getButtonByLabel const cDynVar iLabel  )  [virtual]
 

Definition at line 420 of file cGuiButtonSelectBox.cpp.

References getButtonByIndex().

const cDynVar & n2l::cGuiButtonSelectBox::getValueByLabel const cDynVar iValue  )  [virtual]
 

Definition at line 331 of file cGuiButtonSelectBox.cpp.

References n2l::cDynVar::Null.

virtual const tBool n2l::cGuiButtonSelectBox::isAnySelected  )  const [inline, virtual]
 

Definition at line 123 of file cGuiButtonSelectBox.h.

References NoSelection.

void n2l::cGuiButtonSelectBox::load const cDynVar iDef  )  [virtual]
 

Load this elements properties from the provided definition.

Reimplemented from n2l::cGuiInteractive.

Definition at line 85 of file cGuiButtonSelectBox.cpp.

References addButton(), n2l::cDynVar::end(), n2l::cResourceManager::getGuiElement(), n2l::cDynVar::keyExists(), n2l::cGuiInteractive::load(), multiple(), noUnselect(), selected(), and slider().

void n2l::cGuiButtonSelectBox::load const cVfsNodeInterface iNode  )  [virtual]
 

Load this elements properties from the provided VFS Node.

Reimplemented from n2l::cGuiElement.

Definition at line 77 of file cGuiButtonSelectBox.cpp.

References n2l::cGuiElement::validateAndDecode().

Referenced by cGuiButtonSelectBox().

const tBool n2l::cGuiButtonSelectBox::multiple  )  const [virtual]
 

Definition at line 210 of file cGuiButtonSelectBox.cpp.

Referenced by load(), selected(), and selectedByIndex().

void n2l::cGuiButtonSelectBox::multiple const tBool  iMultiple  )  [virtual]
 

Definition at line 204 of file cGuiButtonSelectBox.cpp.

const tBool n2l::cGuiButtonSelectBox::noUnselect  )  const [virtual]
 

Definition at line 222 of file cGuiButtonSelectBox.cpp.

Referenced by cloneInto(), load(), and selectedByIndex().

void n2l::cGuiButtonSelectBox::noUnselect const tBool  iUnselectable  )  [virtual]
 

Warning:
The No Unselect property is ignored for multiselect selection boxes. No exceptions will be thrown.

Definition at line 216 of file cGuiButtonSelectBox.cpp.

const tUint n2l::cGuiButtonSelectBox::numButtons  )  const [virtual]
 

Definition at line 228 of file cGuiButtonSelectBox.cpp.

const cDynVar & n2l::cGuiButtonSelectBox::selected  )  const [virtual]
 

Get the currently selected value, or false if nothing.

Definition at line 444 of file cGuiButtonSelectBox.cpp.

References n2l::cDynVar::Array, n2l::cDynVar::insert(), multiple(), NoSelection, and n2l::cDynVar::Null.

Referenced by load(), selectNext(), and selectPrev().

void n2l::cGuiButtonSelectBox::selected const cDynVar iValue  )  [virtual]
 

Set the currently selected item, or in a multiselect, add this item to the selection.

Definition at line 311 of file cGuiButtonSelectBox.cpp.

References selectedByIndex().

void n2l::cGuiButtonSelectBox::selectedByIndex const tUint iIndex  )  [virtual]
 

Definition at line 340 of file cGuiButtonSelectBox.cpp.

References multiple(), NoSelection, and noUnselect().

Referenced by selected(), and selectedByLabel().

void n2l::cGuiButtonSelectBox::selectedByLabel const cDynVar iValue  )  [virtual]
 

Set the currently selected item, or in a multiselect, add this item to the selection - instead of using the value, however, use the label.

Definition at line 321 of file cGuiButtonSelectBox.cpp.

References selectedByIndex().

void n2l::cGuiButtonSelectBox::selectNext  )  [virtual]
 

Definition at line 376 of file cGuiButtonSelectBox.cpp.

References NoSelection, and selected().

void n2l::cGuiButtonSelectBox::selectPrev  )  [virtual]
 

Definition at line 392 of file cGuiButtonSelectBox.cpp.

References NoSelection, and selected().

void n2l::cGuiButtonSelectBox::slider const cGuiSlider iSliderTemplate  )  [virtual]
 

Definition at line 165 of file cGuiButtonSelectBox.cpp.

References n2l::cGuiSlider::clone(), and dimensionChanged().

Referenced by load().

void n2l::cGuiButtonSelectBox::systemEvent const cAutoPtr< const cEventInterface > &  i_iEvent  )  [virtual]
 

Tell the element that a system event has occured.

Reimplemented from n2l::cGuiInteractive.

Definition at line 234 of file cGuiButtonSelectBox.cpp.

References n2l::cGuiInteractive::collides(), n2l::EventType_MouseButton, n2l::cGuiInteractive::focus(), n2l::cGuiInteractive::isOver(), n2l::cAutoPtr< TPtr >::isSet(), n2l::MouseButton_Down, n2l::MouseButton_Up, and n2l::cGuiInteractive::systemEvent().

void n2l::cGuiButtonSelectBox::systemEventOutside const cAutoPtr< const cEventInterface > &  i_iEvent  )  [virtual]
 

Inform the element that a system event took place outside of its scope.

Generally this is only used to register the release of mouse buttons, or a mouse out action when the mouse moves off of a clipped canvas.

Reimplemented from n2l::cGuiInteractive.

Definition at line 271 of file cGuiButtonSelectBox.cpp.

References n2l::cAutoPtr< TPtr >::isSet(), and n2l::cGuiInteractive::systemEventOutside().

const tBool n2l::cGuiButtonSelectBox::wantsFocus  )  const [virtual]
 

This method should return true if the element wants to be able to get the focus via a TAB or SHIFT-TAB.

Note:
Default defined here is no.

Reimplemented from n2l::cGuiElement.

Definition at line 459 of file cGuiButtonSelectBox.cpp.


Member Data Documentation

const tUint n2l::cGuiButtonSelectBox::NoSelection [static]
 

Definition at line 50 of file cGuiButtonSelectBox.h.

Referenced by clearButtons(), clearSelections(), cloneInto(), isAnySelected(), selected(), selectedByIndex(), selectNext(), and selectPrev().


The documentation for this class was generated from the following files:
©2009 Aaron Cameron
Benchmarks