wxToolBoxScrollButton Class Reference

Stores information about toolbox button objects (toolbox has 2 scroll buttons - for upward and downward scrolling). More...

#include <wxToolBox.h>

Inheritance diagram for wxToolBoxScrollButton:

List of all members.

Public Member Functions
bool	GetEnabled ()
	Returns true if toolbox button is enabled, otherwise returns false.
bool	GetMouseDown ()
	Returns MouseDown flag of button.
bool	GetMouseHover ()
	Returns MouseHover flag of button.
wxScrollDirection	GetSrollDirection ()
	Returns scrolling direction.
bool	HitTest (wxCoord x, wxCoord y)
	Returns true if button's rectangle contains the point with specified coordinates.
void	Invalidate ()
	Repaints button.
void	Paint (wxDC &dc, const wxRect &clipRect)
	Draws button on specified device context.
void	SetEnabled (bool value)
	Enables/disables button.
void	SetMouseDown (bool value)
	Sets MouseDown flag of button.
void	SetMouseHover (bool value)
	Sets MouseHover flag of button.
void	SetScrollDirection (wxScrollDirection value)
	Sets scrolling direction of toolbox button.
void	SetX (int x)
	Sets X coordinate of toolbox button.
void	SetY (int y)
	Sets Y coordinate of toolbox button.
	wxToolBoxScrollButton (wxToolBox *parent, wxScrollDirection dir, wxSize size)
	Constructor.

---

Detailed Description

Stores information about toolbox button objects (toolbox has 2 scroll buttons - for upward and downward scrolling).

---

Constructor & Destructor Documentation

wxToolBoxScrollButton::wxToolBoxScrollButton	(	wxToolBox *	parent,
		wxScrollDirection	dir,
		wxSize	size
	)

Constructor.

Parameters:

	parent	- pointer to parent component
	dir	- direction
	size	- button size

---

Member Function Documentation

bool wxToolBoxScrollButton::HitTest	(	wxCoord	x,
		wxCoord	y
	)

Returns true if button's rectangle contains the point with specified coordinates.

Parameters:

	x	- X coordinate of point
	y	- Y coordinate of point

void wxToolBoxScrollButton::Paint	(	wxDC &	dc,
		const wxRect &	clipRect
	)

Draws button on specified device context.

Parameters:

	dc	- device context to draw to
	clipRect	- clipping rectangle

void wxToolBoxScrollButton::SetEnabled

(

bool

value

)

[inline]

Enables/disables button.

Parameters:

value

- new value of MouseHover flag

void wxToolBoxScrollButton::SetMouseDown

(

bool

value

)

[inline]

Sets MouseDown flag of button.

Parameters:

value

- new value of MouseDown flag

void wxToolBoxScrollButton::SetMouseHover

(

bool

value

)

[inline]

Sets MouseHover flag of button.

Parameters:

value

- new value of MouseHover flag

void wxToolBoxScrollButton::SetScrollDirection

(

wxScrollDirection

value

)

[inline]

Sets scrolling direction of toolbox button.

Parameters:

value

- new value of scrolling direction

void wxToolBoxScrollButton::SetX

(

int

x

)

[inline]

Sets X coordinate of toolbox button.

Parameters:

x

- new value of X coordinate

void wxToolBoxScrollButton::SetY

(

int

y

)

[inline]

Sets Y coordinate of toolbox button.

Parameters:

y

- new value of Y coordinate

---