wxToolBoxItem Class Reference

Class for storing information about toolbox items. More...

#include <wxToolBox.h>

Inheritance diagram for wxToolBoxItem:

List of all members.

Public Member Functions
void	CancelHover ()
	Cancells processing of mouse movement.
bool	CanStartDrag (wxPoint pt)
	Returns true if item can be dragged from given point (dragging is not implemented).
bool	GetAllowDrag ()
	Returns 'allow dragging' flag (dragging is not implemented).
wxString	GetCaption ()
	Returns item's caption.
bool	GetDeletable ()
	Returns 'deletable' flag.
bool	GetDragging ()
	Returns 'is dragging' flag (dragging is not implemented).
bool	GetEnabled ()
	Returns 'enabled' flag.
wxWindowID	GetID ()
	Returns ID of tool item.
int	GetImageIndex ()
	Returns item's image index.
bool	GetMouseDown ()
	Returns 'mouse down' flag.
bool	GetMouseHover ()
	Returns 'mouse hover' flag.
bool	GetMovable ()
	Returns 'movable' flag.
wxToolBox *	GetParent ()
	Returns pointer to parent control.
wxToolBoxTab *	GetParentTab ()
	Returns pointer to parent tab.
bool	GetRenamable ()
	Returns 'renamable' flag.
bool	GetSelected ()
	Returns selection flag.
bool	HitTest (wxPoint pt)
	Returns true if given point is inside item's rectangle.
void	Invalidate ()
	Invalidates item's rectangle.
wxToolBoxItem	operator= (wxToolBoxItem item)
	Equating operator.
void	Rename ()
	Renames item.
void	SetAllowDrag (bool allowdrag)
	Sets 'allow dragging' flag (dragging is not implemented).
void	SetCaption (wxString caption)
	Sets item's caption.
void	SetDeletable (bool deletable)
	Sets 'deletable' flag.
void	SetDragging (bool dragging)
	Sets 'is dragging' flag (dragging is not implemented).
virtual void	SetEnabled (bool enabled)
	Sets 'enabled' flag.
void	SetID (wxWindowID value)
	Sets ID of tool item.
void	SetImageIndex (int imageindex)
	Sets item's image index.
void	SetMouseDown (bool mousedown)
	Sets 'mouse down' flag.
void	SetMouseDownLocation (wxPoint pt)
	Sets dragging rectangle (dragging is not implemented).
void	SetMouseHover (bool mousehover)
	Sets 'mouse hover' flag.
void	SetMovable (bool movable)
	Sets 'movable' flag.
void	SetParent (wxToolBox *parent)
	Sets parent control for item.
void	SetParentTab (wxToolBoxTab *parenttab)
	Sets parent tab.
void	SetRenamable (bool renamable)
	Sets 'renamable' flag.
virtual void	SetSelected (bool selected)
	Sets selection flag.
	wxToolBoxItem (const wxToolBoxItem &item)
	Copy constructor.
	wxToolBoxItem (wxString caption, wxWindowID id=wxID_ANY, int imageindex=-1)
	Parametrized constructor.
	wxToolBoxItem ()
	Default constructor.
Protected Attributes
bool	m_AllowDrag
	Indicates if dragging of current item is allowed (dragging is not implemented).
wxString	m_Caption
	Item's caption (label).
bool	m_Deletable
	Indicates if current item is deletable.
bool	m_Enabled
	Indicates if current item is enabled.
int	m_ImageIndex
	Item's image index.
bool	m_IsDragging
	Indicates if user drags current item (dragging is not implemented).
bool	m_MouseDown
	Indicates if user pressed mouse button on current item.
bool	m_MouseHover
	Indcates if user moves mouse pointer over current item.
bool	m_Movable
	Indicates if current item is movable.
wxToolBox *	m_Parent
	Parent component.
bool	m_Renamable
	Indicates if current item is renamable.
bool	m_Selected
	Indicates if current item is selected.

---

Detailed Description

Class for storing information about toolbox items.

---

Constructor & Destructor Documentation

wxToolBoxItem::wxToolBoxItem	(	wxString	caption,
		wxWindowID	id = wxID_ANY,
		int	imageindex = -1
	)

Parametrized constructor.

Parameters:

	caption	- caption (label) of item
	id	- ID of item
	imageindex	- item's image index

---

Member Function Documentation

void wxToolBoxItem::SetAllowDrag

(

bool

allowdrag

)

[inline]

Sets 'allow dragging' flag (dragging is not implemented).

Parameters:

allowdrag

- new value of 'allow dragging' flag

void wxToolBoxItem::SetCaption

(

wxString

caption

)

[inline]

Sets item's caption.

Parameters:

caption

- new value of item's caption

void wxToolBoxItem::SetDeletable

(

bool

deletable

)

[inline]

Sets 'deletable' flag.

Parameters:

deletable

- new value of 'deletable' flag

void wxToolBoxItem::SetDragging

(

bool

dragging

)

[inline]

Sets 'is dragging' flag (dragging is not implemented).

Parameters:

dragging

- new value of 'is dragging' flag

virtual void wxToolBoxItem::SetEnabled

(

bool

enabled

)

[inline, virtual]

Sets 'enabled' flag.

Parameters:

enabled

- new value of 'enabled' flag

Reimplemented in wxToolBoxTab.

void wxToolBoxItem::SetID

(

wxWindowID

value

)

[inline]

Sets ID of tool item.

Parameters:

value

- new ID of tool item

void wxToolBoxItem::SetImageIndex

(

int

imageindex

)

[inline]

Sets item's image index.

Parameters:

imageindex

- new image index

void wxToolBoxItem::SetMouseDown

(

bool

mousedown

)

[inline]

Sets 'mouse down' flag.

Parameters:

mousedown

- new value of 'mouse down' flag

void wxToolBoxItem::SetMouseHover

(

bool

mousehover

)

[inline]

Sets 'mouse hover' flag.

Parameters:

mousehover

- new value of 'mouse hover' flag

void wxToolBoxItem::SetMovable

(

bool

movable

)

[inline]

Sets 'movable' flag.

Parameters:

movable

- new value of 'movable' flag

void wxToolBoxItem::SetParent

(

wxToolBox *

parent

)

[inline]

Sets parent control for item.

Parameters:

parent

- pointer to new parent control

void wxToolBoxItem::SetParentTab

(

wxToolBoxTab *

parenttab

)

[inline]

Sets parent tab.

Parameters:

parenttab

- pointer to parent tab

void wxToolBoxItem::SetRenamable

(

bool

renamable

)

[inline]

Sets 'renamable' flag.

Parameters:

renamable

- new value of 'renamable' flag

virtual void wxToolBoxItem::SetSelected

(

bool

selected

)

[virtual]

Sets selection flag.

Parameters:

selected

- new value of selection flag

Reimplemented in wxToolBoxTab.

---