Version: 3.1.1
wxThumbBarButton Class Reference

#include <wx/taskbarbutton.h>

Detailed Description

A thumbnail toolbar button is a control that displayed in the thumbnail image of a window in a taskbar button flyout.

Library:  wxCore
Category:  Miscellaneous
Availability:  only available for the wxMSW port.
See also
wxTaskBarButton
Since
3.1.0

Public Member Functions

 wxThumbBarButton ()
 Default constructor to allow 2-phase creation. More...
 
 wxThumbBarButton (int id, const wxIcon &icon, const wxString &tooltip=wxString(), bool enable=true, bool dismissOnClick=false, bool hasBackground=true, bool shown=true, bool interactive=true)
 Constructs the thumbnail toolbar button. More...
 
bool Create (int id, const wxIcon &icon, const wxString &tooltip=wxString(), bool enable=true, bool dismissOnClick=false, bool hasBackground=true, bool shown=true, bool interactive=true)
 
virtual ~wxThumbBarButton ()
 
int GetID () const
 Returns the identifier associated with this control. More...
 
const wxIconGetIcon () const
 Returns the icon associated with this control. More...
 
const wxStringGetTooltip () const
 Returns the tooltip. More...
 
bool IsEnable () const
 Returns true if the button is enabled, false if it has been disabled. More...
 
void Enable (bool enable=true)
 Enables or disables the thumbnail toolbar button. More...
 
void Disable ()
 Equivalent to calling wxThumbBarButton::Enable(false). More...
 
bool IsDismissOnClick () const
 Returns true if the button will dismiss on click. More...
 
void EnableDismissOnClick (bool enable=true)
 Whether the window thumbnail is dismissed after a button click. More...
 
void DisableDimissOnClick ()
 Equivalent to calling wxThumbBarButton::DisableDimissOnClick(false). More...
 
bool HasBackground () const
 Returns true if the button has button border. More...
 
void SetHasBackground (bool has=true)
 Set the property that whether the button has background. More...
 
bool IsShown () const
 Returns true if the button is shown, false if it has been hidden. More...
 
void Show (bool shown=true)
 Show or hide the thumbnail toolbar button. More...
 
void Hide ()
 Hide the thumbnail toolbar button. More...
 
bool IsInteractive () const
 Returns true if the button is interactive. More...
 
void SetInteractive (bool interactive=true)
 Set the property which holds whether the button is interactive. More...
 

Constructor & Destructor Documentation

wxThumbBarButton::wxThumbBarButton ( )

Default constructor to allow 2-phase creation.

wxThumbBarButton::wxThumbBarButton ( int  id,
const wxIcon icon,
const wxString tooltip = wxString(),
bool  enable = true,
bool  dismissOnClick = false,
bool  hasBackground = true,
bool  shown = true,
bool  interactive = true 
)

Constructs the thumbnail toolbar button.

Parameters
idThe identifier for the control.
iconThe icon used as the button image.
tooltipThe text of the button's tooltip, displayed when the mouse pointer hovers over the button.
enableIf true (default), the button is active and available to the user. If false, the button is disabled. It is present, but has a visual state that indicates that it will not respond to user action.
dismissOnClickIf true, when the button is clicked, the taskbar button's flyout closes immediately. false by default.
hasBackgroundIf false, the button border is not drawn. true by default.
shownIf false, the button is not shown to the user. true by default.
interactiveIf false, the button is enabled but not interactive; no pressed button state is drawn. This flag is intended for instances where the button is used in a notification. true by default.
virtual wxThumbBarButton::~wxThumbBarButton ( )
virtual

Member Function Documentation

bool wxThumbBarButton::Create ( int  id,
const wxIcon icon,
const wxString tooltip = wxString(),
bool  enable = true,
bool  dismissOnClick = false,
bool  hasBackground = true,
bool  shown = true,
bool  interactive = true 
)
void wxThumbBarButton::Disable ( )

Equivalent to calling wxThumbBarButton::Enable(false).

void wxThumbBarButton::DisableDimissOnClick ( )

Equivalent to calling wxThumbBarButton::DisableDimissOnClick(false).

void wxThumbBarButton::Enable ( bool  enable = true)

Enables or disables the thumbnail toolbar button.

void wxThumbBarButton::EnableDismissOnClick ( bool  enable = true)

Whether the window thumbnail is dismissed after a button click.

const wxIcon& wxThumbBarButton::GetIcon ( ) const

Returns the icon associated with this control.

int wxThumbBarButton::GetID ( ) const

Returns the identifier associated with this control.

const wxString& wxThumbBarButton::GetTooltip ( ) const

Returns the tooltip.

bool wxThumbBarButton::HasBackground ( ) const

Returns true if the button has button border.

void wxThumbBarButton::Hide ( )

Hide the thumbnail toolbar button.

Equivalent to calling wxThumbBarButton::Show(false).

bool wxThumbBarButton::IsDismissOnClick ( ) const

Returns true if the button will dismiss on click.

bool wxThumbBarButton::IsEnable ( ) const

Returns true if the button is enabled, false if it has been disabled.

bool wxThumbBarButton::IsInteractive ( ) const

Returns true if the button is interactive.

bool wxThumbBarButton::IsShown ( ) const

Returns true if the button is shown, false if it has been hidden.

void wxThumbBarButton::SetHasBackground ( bool  has = true)

Set the property that whether the button has background.

void wxThumbBarButton::SetInteractive ( bool  interactive = true)

Set the property which holds whether the button is interactive.

A non-interactive thumbnail toolbar button does not react to user interaction, but is still visually enabled.

void wxThumbBarButton::Show ( bool  shown = true)

Show or hide the thumbnail toolbar button.