Button properties. Button_skin_childs Skin childs. Button widget description should be here. More...

#include <MyGUI_Button.h>

Inheritance diagram for MyGUI::Button:

Public Types
typedef RTTIBase	Base

typedef Button	RTTIBase

Public Types inherited from MyGUI::TextBox
typedef RTTIBase	Base

typedef TextBox	RTTIBase

Public Types inherited from MyGUI::Widget
typedef RTTIBase	Base

typedef Widget	RTTIBase

Public Types inherited from MyGUI::IObject
typedef IObject	RTTIBase

Public Member Functions
virtual const std::string &	getTypeName () const

virtual bool	isType (const std::type_info &_type) const

template<typename Type >
bool	isType () const

	Button ()

void	setStateSelected (bool _value)
	Set button selected state. More...

bool	getStateSelected () const
	Get buton selected. More...

void	setModeImage (bool _value)

bool	getModeImage () const

void	setImageResource (const std::string &_name)

void	setImageGroup (const std::string &_name)

void	setImageName (const std::string &_name)

void	_setMouseFocus (bool _focus)

ImageBox *	_getImageBox ()

Public Member Functions inherited from MyGUI::TextBox
template<typename Type >
bool	isType () const

	TextBox ()

virtual IntCoord	getTextRegion ()

virtual IntSize	getTextSize ()

virtual void	setCaption (const UString &_value)

virtual const UString &	getCaption ()

virtual void	setFontName (const std::string &_value)

const std::string &	getFontName ()

virtual void	setFontHeight (int _value)

int	getFontHeight ()

virtual void	setTextAlign (Align _value)

Align	getTextAlign ()

virtual void	setTextColour (const Colour &_value)

const Colour &	getTextColour ()

void	setCaptionWithReplacing (const std::string &_value)

virtual void	setTextShadowColour (const Colour &_value)

const Colour &	getTextShadowColour ()

virtual void	setTextShadow (bool _value)

bool	getTextShadow ()

Public Member Functions inherited from MyGUI::Widget
template<typename Type >
bool	isType () const

	Widget ()

Widget *	createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")

Widget *	createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")

Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")

Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")

template<typename T >
T *	createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")

template<typename T >
T *	createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")

template<typename T >
T *	createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")

template<typename T >
T *	createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")

Widget *	createWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

template<typename T >
T *	createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

virtual void	setPosition (const IntPoint &_value)

virtual void	setSize (const IntSize &_value)

virtual void	setCoord (const IntCoord &_value)

void	setPosition (int _left, int _top)

void	setSize (int _width, int _height)

void	setCoord (int _left, int _top, int _width, int _height)

void	setRealPosition (const FloatPoint &_value)

void	setRealSize (const FloatSize &_value)

void	setRealCoord (const FloatCoord &_value)

void	setRealPosition (float _left, float _top)

void	setRealSize (float _width, float _height)

void	setRealCoord (float _left, float _top, float _width, float _height)

const std::string &	getName () const
	Get name of widget. More...

virtual void	setVisible (bool _value)

bool	getVisible () const

void	setDepth (int _value)

int	getDepth () const

bool	getInheritedVisible () const

virtual void	setAlign (Align _value)

Align	getAlign () const

void	setAlpha (float _value)

float	getAlpha () const

void	setInheritsAlpha (bool _value)

bool	getInheritsAlpha () const

void	setColour (const Colour &_value)

bool	isRootWidget () const

Widget *	getParent () const

IntSize	getParentSize () const

EnumeratorWidgetPtr	getEnumerator () const

size_t	getChildCount ()

Widget *	getChildAt (size_t _index)

Widget *	findWidget (const std::string &_name)

void	findWidgets (const std::string &_name, VectorWidgetPtr &_result)

virtual void	setEnabled (bool _value)

void	setEnabledSilent (bool _value)

bool	getEnabled () const

bool	getInheritedEnabled () const

IntCoord	getClientCoord ()

Widget *	getClientWidget ()

void	detachFromWidget (const std::string &_layer="")

void	attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")

void	changeWidgetSkin (const std::string &_skinName)

void	setWidgetStyle (WidgetStyle _style, const std::string &_layer="")

WidgetStyle	getWidgetStyle () const

void	setProperty (const std::string &_key, const std::string &_value)

virtual size_t	_getItemIndex (Widget *_item)

void	_forcePick (Widget *_widget)

void	_initialise (WidgetStyle _style, const IntCoord &_coord, const std::string &_skinName, Widget _parent, ICroppedRectangle _croppedParent, const std::string &_name)

void	_shutdown ()

void	_destroyChildWidget (Widget *_widget)

void	_setContainer (Widget *_value)

Widget *	_getContainer ()

void	_setAlign (const IntSize &_oldsize, const IntSize &_newSize)

bool	_checkPoint (int _left, int _top) const

Widget *	_createSkinWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

virtual void	_resetContainer (bool _update)

bool	_setWidgetState (const std::string &_value)

void	_updateChilds ()

Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool	isType () const

template<typename Type >
Type *	castType (bool _throw=true)

template<typename Type >
const Type *	castType (bool _throw=true) const

	IObject ()

virtual	~IObject ()

Public Member Functions inherited from MyGUI::ICroppedRectangle
	ICroppedRectangle ()

virtual	~ICroppedRectangle ()

ICroppedRectangle *	getCroppedParent ()

IntPoint	getPosition () const

IntSize	getSize () const

const IntCoord &	getCoord () const

const IntPoint &	getAbsolutePosition () const

IntRect	getAbsoluteRect () const

IntCoord	getAbsoluteCoord () const

int	getAbsoluteLeft () const

int	getAbsoluteTop () const

int	getLeft () const

int	getRight () const

int	getTop () const

int	getBottom () const

int	getWidth () const

int	getHeight () const

bool	_isMargin () const

int	_getViewLeft () const

int	_getViewRight () const

int	_getViewTop () const

int	_getViewBottom () const

int	_getViewWidth () const

int	_getViewHeight () const

void	_setCroppedParent (ICroppedRectangle *_parent)

const IntRect &	_getMargin () const

int	_getMarginLeft () const

int	_getMarginRight () const

int	_getMarginTop () const

int	_getMarginBottom () const

Public Member Functions inherited from MyGUI::UserData
	UserData ()

virtual	~UserData ()

void	setUserString (const std::string &_key, const std::string &_value)

const std::string &	getUserString (const std::string &_key) const

const MapString &	getUserStrings () const

bool	clearUserString (const std::string &_key)

bool	isUserString (const std::string &_key) const

void	clearUserStrings ()

void	setUserData (Any _data)

template<typename ValueType >
ValueType *	getUserData (bool _throw=true) const

void	_setInternalData (Any _data)

template<typename ValueType >
ValueType *	_getInternalData (bool _throw=true) const

Public Member Functions inherited from MyGUI::WidgetInput
	WidgetInput ()

virtual	~WidgetInput ()

void	setNeedToolTip (bool _value)

bool	getNeedToolTip () const

void	setPointer (const std::string &_value)

const std::string &	getPointer () const

void	setNeedKeyFocus (bool _value)

bool	getNeedKeyFocus () const

void	setNeedMouseFocus (bool _value)

bool	getNeedMouseFocus () const

void	setInheritsPick (bool _value)

bool	getInheritsPick () const

void	setMaskPick (const std::string &_filename)

void	setMaskPick (const MaskPickInfo &_info)

bool	isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const

bool	getRootMouseFocus () const

bool	getRootKeyFocus () const

void	_riseMouseLostFocus (Widget *_new)

void	_riseMouseSetFocus (Widget *_old)

void	_riseMouseDrag (int _left, int _top, MouseButton _id)

void	_riseMouseMove (int _left, int _top)

void	_riseMouseWheel (int _rel)

void	_riseMouseButtonPressed (int _left, int _top, MouseButton _id)

void	_riseMouseButtonReleased (int _left, int _top, MouseButton _id)

void	_riseMouseButtonClick ()

void	_riseMouseButtonDoubleClick ()

void	_riseKeyLostFocus (Widget *_new)

void	_riseKeySetFocus (Widget *_old)

void	_riseKeyButtonPressed (KeyCode _key, Char _char)

void	_riseKeyButtonReleased (KeyCode _key)

void	_riseMouseChangeRootFocus (bool _focus)

void	_riseKeyChangeRootFocus (bool _focus)

void	_setRootMouseFocus (bool _value)

void	_setRootKeyFocus (bool _value)

Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual	~IDelegateUnlink ()

	IDelegateUnlink ()

bool	compare (IDelegateUnlink *_unlink) const

Public Member Functions inherited from MyGUI::SkinItem
	SkinItem ()

ISubWidgetText *	getSubWidgetText ()

ISubWidgetRect *	getSubWidgetMain ()

void	_setTextureName (const std::string &_texture)

const std::string &	_getTextureName () const

Public Member Functions inherited from MyGUI::LayerItem
	LayerItem ()

virtual	~LayerItem ()

ILayer *	getLayer () const

ILayerNode *	getLayerNode () const

virtual void	attachItemToNode (ILayer _layer, ILayerNode _node)

virtual void	detachFromLayer ()

virtual void	upLayerItem ()

void	setRenderItemTexture (ITexture *_texture)

void	addChildItem (LayerItem *_item)

void	removeChildItem (LayerItem *_item)

void	addChildNode (LayerItem *_item)

void	removeChildNode (LayerItem *_item)

void	addRenderItem (ISubWidget *_item)

void	removeAllRenderItems ()

void	saveLayerItem ()

void	restoreLayerItem ()

Public Member Functions inherited from MyGUI::ILayerItem
virtual	~ILayerItem ()

Public Member Functions inherited from MyGUI::MemberObsolete< Widget >
bool	isEnabled ()

bool	isInheritsAlpha ()

bool	isNeedKeyFocus ()

bool	isNeedMouseFocus ()

bool	isInheritsPick ()

bool	isVisible ()

Public Member Functions inherited from MyGUI::MemberObsolete< Button >
void	setButtonPressed (bool _value)

bool	getButtonPressed ()

void	setStateCheck (bool _value)

bool	getStateCheck ()

ImageBox *	getStaticImage ()

void	setImageIndex (size_t _value)

size_t	getImageIndex ()

Static Public Member Functions
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::TextBox
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::Widget
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::IObject
static const std::string &	getClassTypeName ()

Protected Member Functions
virtual void	initialiseOverride ()

virtual void	shutdownOverride ()

virtual void	onMouseLostFocus (Widget *_new)

virtual void	onMouseSetFocus (Widget *_old)

virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)

virtual void	baseUpdateEnable ()

bool	_setState (const std::string &_value)

virtual void	setPropertyOverride (const std::string &_key, const std::string &_value)

Additional Inherited Members
Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString	eventChangeProperty

EventHandle_WidgetVoid	eventChangeCoord

Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect	mMargin

IntCoord	mCoord

IntPoint	mAbsolutePosition

bool	mIsMargin

ICroppedRectangle *	mCroppedParent

Detailed Description

Button properties. Button_skin_childs Skin childs. Button widget description should be here.

Definition at line 19 of file MyGUI_Button.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::Button::Base

Definition at line 23 of file MyGUI_Button.h.

typedef Button MyGUI::Button::RTTIBase

Definition at line 23 of file MyGUI_Button.h.

Constructor & Destructor Documentation

MyGUI::Button::Button ( )

Definition at line 16 of file MyGUI_Button.cpp.

Member Function Documentation

ImageBox * MyGUI::Button::_getImageBox ( )

Definition at line 216 of file MyGUI_Button.cpp.

void MyGUI::Button::_setMouseFocus ( bool _focus )

Definition at line 120 of file MyGUI_Button.cpp.

bool MyGUI::Button::_setState ( const std::string & _value )

protected

Definition at line 141 of file MyGUI_Button.cpp.

void MyGUI::Button::baseUpdateEnable ( )

protectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 126 of file MyGUI_Button.cpp.

static const std::string& MyGUI::Button::getClassTypeName ( )

inlinestatic

Definition at line 23 of file MyGUI_Button.h.

bool MyGUI::Button::getModeImage ( ) const

Get Image mode flag

Definition at line 211 of file MyGUI_Button.cpp.

bool MyGUI::Button::getStateSelected ( ) const

Get buton selected.

Definition at line 206 of file MyGUI_Button.cpp.

virtual const std::string& MyGUI::Button::getTypeName ( ) const

inlinevirtual

Get type name as string

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 23 of file MyGUI_Button.h.

void MyGUI::Button::initialiseOverride ( )

protectedvirtual

skin clilds:: Image is child widget with type ImageBox. ��, � �� .

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuItem.

Definition at line 25 of file MyGUI_Button.cpp.

template<typename Type >

bool MyGUI::Button::isType ( ) const

inline

Compare with selected type

Definition at line 23 of file MyGUI_Button.h.

virtual bool MyGUI::Button::isType ( const std::type_info & _type ) const

inlinevirtual

Compare with selected type

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 23 of file MyGUI_Button.h.

void MyGUI::Button::onMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)

protectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 54 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseButtonReleased	(	int	_left,
		int	_top,
		MouseButton	_id
	)

protectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 65 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseLostFocus ( Widget * _new )

protectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 47 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseSetFocus ( Widget * _old )

protectedvirtual

Reimplemented from MyGUI::WidgetInput.

Definition at line 40 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageGroup ( const std::string & _name )

Definition at line 162 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageName ( const std::string & _name )

Definition at line 169 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageResource ( const std::string & _name )

Definition at line 155 of file MyGUI_Button.cpp.

void MyGUI::Button::setModeImage ( bool _value )

Enable or disable Image mode
Image mode: when button state changed Image on button also change it's picture.
Disabled (false) by default.

Definition at line 135 of file MyGUI_Button.cpp.

void MyGUI::Button::setPropertyOverride	(	const std::string &	_key,
		const std::string &	_value
	)

protectedvirtual

Properties:: StateSelected is Button property with type bool. Set state selected.

Properties:: ModeImage is Button property with type bool. �� , � �� .

Properties:: ImageResource is Button property with type string. �� .

Properties:: ImageGroup is Button property with type string. �� .

Properties:: ImageName is Button property with type string. �� .

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 175 of file MyGUI_Button.cpp.

void MyGUI::Button::setStateSelected ( bool _value )

Set button selected state.

Definition at line 111 of file MyGUI_Button.cpp.

void MyGUI::Button::shutdownOverride ( )

protectedvirtual

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuItem.

Definition at line 33 of file MyGUI_Button.cpp.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation