AaronCameron.net

Because you all make me very, very tired.

• 
• 
• 
• 
• 

Not a Member? - Login or Create an Account

Thursday the 24th of May 2012 @ 01:44am

Front Page Journal Projects Your Profile 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 cGuiElement.h Go to the documentation of this file. /************************************************************************ Nova-2 Library (libN2L, or simply n2l) Game development C++ Library Copyright (C) 2002 Aaron Cameron This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA A copy of the GNU Lesser General Public License has been provided with this library in the file 'COPYING'. Contact information for the author of this library has been provided with this library in the file 'AUTHOR'. ************************************************************************/ #ifndef _n2l4_cGuiElement_H #define _n2l4_cGuiElement_H #include "n2l/n2l.h" #include "n2l/timing.h" #include "n2l/geometry.h" #include "gui/types.h" #include <list> #include <map> /******************************************************************************/ namespace n2l { class cGuiCanvas; class cVfsNodeInterface; class cDynVar; class cGuiFill; class cGuiTextStyle; class cEventInterface; class cGuiSEInt; class cGuiACInt; class cGuiElement { public: typedef std::list<cAutoPtr<cGuiElement> > tOElementList; cGuiElement(); cGuiElement( const tGuiPos &iPos, const tGuiPos &iSize, const tString &iName = "" ); virtual ~cGuiElement(); //-------------------------------------------------------- // Basic Properties virtual const tGuiPos &pos() const; virtual void pos( const tGuiPos &iPos ); virtual const tGuiPos &size() const; virtual void size( const tGuiPos &iSize ); virtual const tGuiPos &bottomRightPadding() const; virtual void padding( const tGuiPos &iTopLeft, const tGuiPos &iBottomRight ); virtual const tGuiPos &topLeftPadding() const; virtual const tString &name() const; virtual void name( const tString &iName ); virtual void renderOrder( const tSint iOrder ); virtual const tSint &renderOrder() const; virtual void prop( const tString &iName, const cDynVar &iVal, const tString &iInnerKey = "" ); virtual const cDynVar prop( const tString &iName, const tString &iInnerKey = "" ) const; //-------------------------------------------------------- // Element Action Methods virtual const tActionBindingID bindUserAction( const tGuiActionType iType, const cAutoPtr<cGuiACInt> &i_ioAction ); virtual void unbindUserAction( const tActionBindingID iID ); virtual void clearUserActions(); //-------------------------------------------------------- // System Event handling virtual void systemEvent( const cAutoPtr<const cEventInterface> &i_iEvent ); virtual void systemEventOutside( const cAutoPtr<const cEventInterface> &i_iEvent ); //-------------------------------------------------------- // Focus handling virtual const tBool focus() const; virtual void focus( const tBool iFocus ); virtual const tBool wantsFocus() const; //-------------------------------------------------------- // General virtual void update( const tUint iTimePassed ); virtual void draw() const; virtual tOElementList getByType( const type_info &iType ); virtual tOElementList &getByType( tOElementList &oList, const type_info &iType ); virtual const cAutoPtr<cGuiElement> get( const tGuiName &iName ); virtual const cAutoPtr<cGuiElement> mustGet( const tGuiName &iName ); virtual const tBool hasChildren() const; //-------------------------------------------------------- // Resource Management support virtual void load( const cVfsNodeInterface &iNode ); virtual void load( const cDynVar &iDefinition ); virtual const cAutoPtr<cGuiElement> clone() const = 0; template <class TSEClass> static const cAutoPtr<cGuiElement> loadNew( const cDynVar &iDef ) { return new TSEClass( iDef ); } //---------------------------------------------------------------- // Special Effect code below virtual void addEffect( const cAutoPtr<cGuiSEInt> &i_ioEffect ); virtual void clearEffects(); virtual const tUint numEffects() const; virtual cGuiCanvas *const canvas(); virtual void commitSuicide() { mSuicide = true; } virtual const tBool &suicidal() const { return mSuicide; } inline const tGuiPos &outerPos() const { return mPos; } inline const tGuiPos &outerSize() const { return mSize; } inline const tGuiPos &innerPos() const { return mInnerPos; } inline const tGuiPos &innerSize() const { return mInnerSize; } protected: typedef std::list<cAutoPtr<cGuiSEInt> > tSpecialEffectContainer; tGuiPos mPos; tGuiPos mSize; tGuiPos mTopLeftPadding; tGuiPos mBottomRightPadding; tBool mHasFocus; tString mName; tSint mRenderOrder; cGuiCanvas *mMyCanvas; tSpecialEffectContainer mEffects; const tUint nextElementNumber(); friend class cGuiCanvas; virtual void canvas( cGuiCanvas *const iCanvas ); // This method is called when size or position are changed // or when the parent canvas's resolution mapping changes. // It is specifically provided for children classes to redefine // with whatever cache changes need to be made if these values // change. // It is good behaviour to call the parent's version of the // method before any child work is done. virtual void dimensionChanged(); // This method is called when focus or name are changed // Hotspot also calls this method if the over/out/down state // changes for an item. // This method is designed specifically for children classes to // redefine to catch changes in their parent class. // It is good behaviour to call the parent's version of the // method before any child work is done. virtual void stateChanged(); // This method should be called when an externally selectable // property changes. It is never called by this class, and // is provided only as an interface. virtual void propertyChanged(); virtual void cloneInto( const cAutoPtr<cGuiElement> &i_ioElement ) const; friend class cGuiFill; friend class cGuiTextStyle; static void validateAndDecode( cDynVar &oDefinition, const cVfsNodeInterface &iNode, const tString &iRequiredHeader ); //--------------------------------------------------------------- // Internal Element Action Methods virtual const tActionBindingID bindAction( const tGuiActionType iType, const cAutoPtr<cGuiACInt> &i_ioAction, const tBool iUser ); virtual void unbindAction( const tActionBindingID iID, const tBool iUser ); virtual void broadcastAction( const tGuiActionType iType, const tActionData &iData ); private: typedef std::map<tActionBindingID, cAutoPtr<cGuiACInt> > tActionList; tActionList mActions[ GuiActionType_NumActionTypes ]; static const tActionBindingID FirstUserActionID; static const tActionBindingID FirstSystemActionID; static tUint smNextElementNumber; tGuiPos mInnerPos; tGuiPos mInnerSize; tActionBindingID mNextSystemActionID; tActionBindingID mNextUserActionID; tBool mFirstUpdateDone; tBool mSuicide; void boundCheckActionType( const tUint &iType ) const; }; } // namespace n2l #endif

©2012 Aaron Cameron