Because you all make me very, very tired.

Not a Member? - Login or Create an Account

Tuesday the 6th of January 2009 @ 07:37am

News Journal Creative Writing Projects Your JW About

LibN2L N2L Home Older News Downloads Documentation (n2l5) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Documentation (libN2L-4) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Bugtracker Project Page Report a Bug Bug List Related Things Life 2130 Devel Game Journal

LibN2L-4 Library Code Reference Classes Compounds Files Members Method Index Full Reference n2l::cGuiSButton Class Reference A simple textured push button which supports different visualizations for different states, and a textured text label. More... #include <cGuiSButton.h> Inheritance diagram for n2l::cGuiSButton: [legend]Collaboration diagram for n2l::cGuiSButton: [legend]List of all members. Public Types enum tType { Type_Push, Type_Toggle, Type_NumTypes } Public Member Functions cGuiSButton () cGuiSButton (const cVfsNodeInterface &iNode) cGuiSButton (const cDynVar &iDef) virtual ~cGuiSButton () virtual void load (const cVfsNodeInterface &iNode) Load this elements properties from the provided VFS Node. virtual void load (const cDynVar &iDef) Load this elements properties from the provided definition. virtual void draw () const Draw ourselves on the screen. virtual void fill (const cGuiFill &iFill) virtual const cGuiFill & fill () const virtual void label (const tString &iLabel) virtual const tString & label () const virtual void textStyle (const cGuiTextStyle &iStyle) virtual const cGuiTextStyle & textStyle () const virtual void type (const tType iType) virtual const tType type () const virtual void toggledOn (const tBool iToggled) virtual const tBool toggledOn () const virtual void enabled (const tBool iEnabled) virtual const tBool enabled () const virtual void setAccel (const tKey &iKey, const tKeyMods &iMods) virtual void clearAccel () virtual void prop (const tString &iName, const cDynVar &iVal, const tString &iInnerKey="") Set a property by name. virtual const cDynVar prop (const tString &iName, const tString &iInnerKey="") const virtual const cAutoPtr< cGuiElement > clone () const Return a new element using this element as a template for its construction. Protected Member Functions virtual void cloneInto (const cAutoPtr< cGuiSButton > &ioElement) const virtual void addExtraClickedData (tActionData &oData) virtual void addExtraOverData (tActionData &oData) Methods to add data to action data arrays. virtual void addExtraOutData (tActionData &oData) virtual void addExtraPressedData (tActionData &oData) virtual void addExtraReleasedData (tActionData &oData) virtual void addExtraDisabledData (tActionData &oData) Protected Attributes tString mLabel cGuiFill mFill cGuiTextStyle mTextStyle tType mType tBool mToggledOn tBool mEnabled tBool mUseAccel Description for the keyboard accelerator for this button. tKey mKey tKeyMods mKeyMod Friends class cGuiSButtonSelectBox Detailed Description A simple textured push button which supports different visualizations for different states, and a textured text label. Definition at line 46 of file cGuiSButton.h. Member Enumeration Documentation enum n2l::cGuiSButton::tType   Enumerator: Type_Push  Type_Toggle  Type_NumTypes  Definition at line 49 of file cGuiSButton.h. Constructor & Destructor Documentation n2l::cGuiSButton::cGuiSButton (   )    Definition at line 46 of file cGuiSButton.cpp. n2l::cGuiSButton::cGuiSButton (  const cVfsNodeInterface &  iNode  )    Definition at line 52 of file cGuiSButton.cpp. References load(). n2l::cGuiSButton::cGuiSButton (  const cDynVar &  iDef  )    Definition at line 59 of file cGuiSButton.cpp. References load(). n2l::cGuiSButton::~cGuiSButton (   )  [virtual]   Definition at line 66 of file cGuiSButton.cpp. Member Function Documentation void n2l::cGuiSButton::addExtraClickedData (  tActionData &  oData  )  [protected, virtual]   Reimplemented from n2l::cGuiInteractive. Definition at line 389 of file cGuiSButton.cpp. References n2l::cGuiInteractive::addExtraClickedData(), n2l::cDynVar::insert(), mEnabled, mToggledOn, mType, and Type_Toggle. void n2l::cGuiSButton::addExtraDisabledData (  tActionData &  oData  )  [protected, virtual]   Definition at line 442 of file cGuiSButton.cpp. References n2l::cDynVar::insert(), and mEnabled. Referenced by enabled(). void n2l::cGuiSButton::addExtraOutData (  tActionData &  oData  )  [protected, virtual]   Reimplemented from n2l::cGuiInteractive. Definition at line 412 of file cGuiSButton.cpp. References n2l::cGuiInteractive::addExtraOutData(), n2l::cDynVar::insert(), mEnabled, mToggledOn, mType, and Type_Toggle. void n2l::cGuiSButton::addExtraOverData (  tActionData &  oData  )  [protected, virtual]   Methods to add data to action data arrays. These methods may be overridden by children to add extra information to the data structure sent along with an action. Note: Good behaviour here is to call your parents version of this method before adding your own data. Reimplemented from n2l::cGuiInteractive. Definition at line 402 of file cGuiSButton.cpp. References n2l::cGuiInteractive::addExtraOverData(), n2l::cDynVar::insert(), mEnabled, mToggledOn, mType, and Type_Toggle. void n2l::cGuiSButton::addExtraPressedData (  tActionData &  oData  )  [protected, virtual]   Reimplemented from n2l::cGuiInteractive. Definition at line 422 of file cGuiSButton.cpp. References n2l::cGuiInteractive::addExtraPressedData(), n2l::cDynVar::insert(), mEnabled, mToggledOn, mType, and Type_Toggle. void n2l::cGuiSButton::addExtraReleasedData (  tActionData &  oData  )  [protected, virtual]   Reimplemented from n2l::cGuiInteractive. Definition at line 432 of file cGuiSButton.cpp. References n2l::cGuiInteractive::addExtraReleasedData(), n2l::cDynVar::insert(), mEnabled, mToggledOn, mType, and Type_Toggle. void n2l::cGuiSButton::clearAccel (   )  [virtual]   Definition at line 246 of file cGuiSButton.cpp. References mUseAccel. const cAutoPtr< cGuiElement > n2l::cGuiSButton::clone (   )  const [virtual]   Return a new element using this element as a template for its construction. Reimplemented from n2l::cGuiInteractive. Definition at line 300 of file cGuiSButton.cpp. References cloneInto(). Referenced by n2l::cGuiSButtonSelectBox::addButton(). void n2l::cGuiSButton::cloneInto (  const cAutoPtr< cGuiSButton > &  ioElement  )  const [protected, virtual]   Definition at line 308 of file cGuiSButton.cpp. References n2l::cGuiInteractive::cloneInto(), enabled(), fill(), label(), mKey, mKeyMod, mUseAccel, textStyle(), toggledOn(), and type(). Referenced by clone(). void n2l::cGuiSButton::draw (   )  const [virtual]   Draw ourselves on the screen. Note: This method does not set the projection matrix. Reimplemented from n2l::cGuiElement. Definition at line 143 of file cGuiSButton.cpp. References n2l::cGuiTextStyle::draw(), n2l::cGuiFill::draw(), n2l::cString::empty(), n2l::cGuiElement::innerPos(), n2l::cGuiElement::innerSize(), mFill, mLabel, mTextStyle, n2l::cGuiElement::outerPos(), and n2l::cGuiElement::outerSize(). const tBool n2l::cGuiSButton::enabled (   )  const [virtual]   Definition at line 232 of file cGuiSButton.cpp. References mEnabled. Referenced by cloneInto(), and load(). void n2l::cGuiSButton::enabled (  const tBool  iEnabled  )  [virtual]   Definition at line 221 of file cGuiSButton.cpp. References addExtraDisabledData(), n2l::cDynVar::Array, n2l::cGuiElement::broadcastAction(), n2l::GuiActionType_DisableChanged, and mEnabled. const cGuiFill & n2l::cGuiSButton::fill (   )  const [virtual]   Definition at line 158 of file cGuiSButton.cpp. References mFill. Referenced by cloneInto(), load(), and prop(). void n2l::cGuiSButton::fill (  const cGuiFill &  iFill  )  [virtual]   Definition at line 152 of file cGuiSButton.cpp. References mFill. const tString & n2l::cGuiSButton::label (   )  const [virtual]   Definition at line 170 of file cGuiSButton.cpp. References mLabel. Referenced by cloneInto(), load(), and prop(). void n2l::cGuiSButton::label (  const tString &  iLabel  )  [virtual]   Definition at line 164 of file cGuiSButton.cpp. References mLabel. void n2l::cGuiSButton::load (  const cDynVar &  iDef  )  [virtual]   Load this elements properties from the provided definition. Reimplemented from n2l::cGuiInteractive. Definition at line 79 of file cGuiSButton.cpp. References enabled(), fill(), n2l::cDynVar::isArray(), n2l::Key_Unknown, n2l::KMod_Alt, n2l::KMod_Ctrl, n2l::KMod_Meta, n2l::KMod_None, n2l::KMod_Shift, label(), n2l::cGuiInteractive::load(), n2l::cEventTypeLookups::lookupTypeByName(), setAccel(), textStyle(), toggledOn(), and type(). void n2l::cGuiSButton::load (  const cVfsNodeInterface &  iNode  )  [virtual]   Load this elements properties from the provided VFS Node. Reimplemented from n2l::cGuiElement. Definition at line 71 of file cGuiSButton.cpp. References n2l::cGuiElement::validateAndDecode(). Referenced by cGuiSButton(). const cDynVar n2l::cGuiSButton::prop (  const tString &  iName, const tString &  iInnerKey = "" )  const [virtual]   Reimplemented from n2l::cGuiElement. Definition at line 282 of file cGuiSButton.cpp. References n2l::cString::empty(), label(), mFill, n2l::cDynVar::Null, n2l::cGuiElement::prop(), and n2l::cGuiFill::prop(). void n2l::cGuiSButton::prop (  const tString &  iName, const cDynVar &  iVal, const tString &  iInnerKey = "" )  [virtual]   Set a property by name. Which properites are supported and the format for each set is renegotiated as required. Note: Each derived class needs to reimplement this method to support its own properties. Parent classes should be called AFTER the derived class checks, not before which is opposite to most similar classes. Reimplemented from n2l::cGuiElement. Definition at line 252 of file cGuiSButton.cpp. References n2l::cString::empty(), fill(), n2l::cDynVar::isArray(), label(), mFill, mTextStyle, n2l::cGuiElement::prop(), n2l::cGuiTextStyle::prop(), n2l::cGuiFill::prop(), and textStyle(). void n2l::cGuiSButton::setAccel (  const tKey &  iKey, const tKeyMods &  iMods )  [virtual]   Definition at line 238 of file cGuiSButton.cpp. References mKey, mKeyMod, and mUseAccel. Referenced by load(). const cGuiTextStyle & n2l::cGuiSButton::textStyle (   )  const [virtual]   Definition at line 176 of file cGuiSButton.cpp. References mTextStyle. Referenced by cloneInto(), load(), and prop(). void n2l::cGuiSButton::textStyle (  const cGuiTextStyle &  iStyle  )  [virtual]   Definition at line 182 of file cGuiSButton.cpp. References mTextStyle. const tBool n2l::cGuiSButton::toggledOn (   )  const [virtual]   Definition at line 215 of file cGuiSButton.cpp. References mToggledOn. Referenced by cloneInto(), and load(). void n2l::cGuiSButton::toggledOn (  const tBool  iToggled  )  [virtual]   Definition at line 209 of file cGuiSButton.cpp. References mToggledOn. const cGuiSButton::tType n2l::cGuiSButton::type (   )  const [virtual]   Definition at line 203 of file cGuiSButton.cpp. References mType. Referenced by cloneInto(), and load(). void n2l::cGuiSButton::type (  const tType  iType  )  [virtual]   Definition at line 196 of file cGuiSButton.cpp. References mType. Friends And Related Function Documentation friend class cGuiSButtonSelectBox [friend]   Definition at line 95 of file cGuiSButton.h. Member Data Documentation tBool n2l::cGuiSButton::mEnabled [protected]   Definition at line 105 of file cGuiSButton.h. Referenced by addExtraClickedData(), addExtraDisabledData(), addExtraOutData(), addExtraOverData(), addExtraPressedData(), addExtraReleasedData(), and enabled(). cGuiFill n2l::cGuiSButton::mFill [protected]   Definition at line 100 of file cGuiSButton.h. Referenced by draw(), fill(), and prop(). tKey n2l::cGuiSButton::mKey [protected]   Definition at line 110 of file cGuiSButton.h. Referenced by cloneInto(), and setAccel(). tKeyMods n2l::cGuiSButton::mKeyMod [protected]   Definition at line 111 of file cGuiSButton.h. Referenced by cloneInto(), and setAccel(). tString n2l::cGuiSButton::mLabel [protected]   Definition at line 98 of file cGuiSButton.h. Referenced by draw(), and label(). cGuiTextStyle n2l::cGuiSButton::mTextStyle [protected]   Definition at line 101 of file cGuiSButton.h. Referenced by draw(), prop(), and textStyle(). tBool n2l::cGuiSButton::mToggledOn [protected]   Definition at line 104 of file cGuiSButton.h. Referenced by addExtraClickedData(), addExtraOutData(), addExtraOverData(), addExtraPressedData(), addExtraReleasedData(), and toggledOn(). tType n2l::cGuiSButton::mType [protected]   Definition at line 103 of file cGuiSButton.h. Referenced by addExtraClickedData(), addExtraOutData(), addExtraOverData(), addExtraPressedData(), addExtraReleasedData(), and type(). tBool n2l::cGuiSButton::mUseAccel [protected]   Description for the keyboard accelerator for this button. Definition at line 109 of file cGuiSButton.h. Referenced by clearAccel(), cloneInto(), and setAccel(). The documentation for this class was generated from the following files: cGuiSButton.h cGuiSButton.cpp

©2009 Aaron Cameron

Benchmarks

Start	0.000s
Left Sidebar Start	0.037s
Left Sidebar End	0.063s
Finished	0.021s
Total:	0.121s