Class: Wx::ThumbBarButton

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/task_bar_button.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

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

Category: Miscellaneous Availability: only available for the WXMSW port.

See Also:

Requires:

  • WXMSW
  • USE_TASKBARBUTTON

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::ThumbBarButton #initialize(id, icon, tooltip = (''), enable = true, dismissOnClick = false, hasBackground = true, shown = true, interactive = true) ⇒ Wx::ThumbBarButton

Returns a new instance of ThumbBarButton.

Overloads:

  • #initialize ⇒ Wx::ThumbBarButton

    Default constructor to allow 2-phase creation.

  • #initialize(id, icon, tooltip = (''), enable = true, dismissOnClick = false, hasBackground = true, shown = true, interactive = true) ⇒ Wx::ThumbBarButton

    Constructs the thumbnail toolbar button.

    Parameters:

    • id (Integer) —

      The identifier for the control.

    • icon (Wx::Icon) —

      The icon used as the button image.

    • tooltip (String) (defaults to: ('')) —

      The text of the button’s tooltip, displayed when the mouse pointer hovers over the button.

    • enable (Boolean) (defaults to: true) —

      If 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.

    • dismissOnClick (Boolean) (defaults to: false) —

      If true, when the button is clicked, the taskbar button’s flyout closes immediately. false by default.

    • hasBackground (Boolean) (defaults to: true) —

      If false, the button border is not drawn. true by default.

    • shown (Boolean) (defaults to: true) —

      If false, the button is not shown to the user. true by default.

    • interactive (Boolean) (defaults to: true) —

      If 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.



175
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 175

def initialize(*args) end

Instance Method Details

#create(id, icon, tooltip = (''), enable = true, dismissOnClick = false, hasBackground = true, shown = true, interactive = true) ⇒ Boolean

Parameters:

  • id (Integer)
  • icon (Wx::Icon)
  • tooltip (String) (defaults to: (''))
  • enable (Boolean) (defaults to: true)
  • dismissOnClick (Boolean) (defaults to: false)
  • hasBackground (Boolean) (defaults to: true)
  • shown (Boolean) (defaults to: true)
  • interactive (Boolean) (defaults to: true)

Returns:

  • (Boolean) 


186
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 186

def create(id, icon, tooltip=(''), enable=true, dismissOnClick=false, hasBackground=true, shown=true, interactive=true) end

#disable ⇒ void

This method returns an undefined value.

Equivalent to calling Wx::ThumbBarButton#enable(false).



215
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 215

def disable; end

#disable_dimiss_on_click ⇒ void

This method returns an undefined value.

Equivalent to calling Wx::ThumbBarButton#disable_dimiss_on_click(false).



229
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 229

def disable_dimiss_on_click; end

#enable(enable = true) ⇒ void

This method returns an undefined value.

Enables or disables the thumbnail toolbar button.

Parameters:

  • enable (Boolean) (defaults to: true) 


211
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 211

def enable(enable=true) end

#enable_dismiss_on_click(enable = true) ⇒ void

This method returns an undefined value.

Whether the window thumbnail is dismissed after a button click.

Parameters:

  • enable (Boolean) (defaults to: true) 


225
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 225

def enable_dismiss_on_click(enable=true) end

#get_icon ⇒ Wx::Icon Also known as: icon

Returns the icon associated with this control.

Returns:



195
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 195

def get_icon; end

#get_id ⇒ Integer Also known as: id

Returns the identifier associated with this control.

Returns:

  • (Integer) 


190
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 190

def get_id; end

#get_tooltip ⇒ Wx::String Also known as: tooltip

Returns the tooltip.

Returns:

  • (Wx::String) 


200
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 200

def get_tooltip; end

#has_background ⇒ Boolean Also known as: has_background?

Returns true if the button has button border.

Returns:

  • (Boolean) 


233
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 233

def has_background; end

#hide ⇒ void

This method returns an undefined value.

Hide the thumbnail toolbar button.

Equivalent to calling Wx::ThumbBarButton#show(false).



256
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 256

def hide; end

#is_dismiss_on_click ⇒ Boolean Also known as: dismiss_on_click?

Returns true if the button will dismiss on click.

Returns:

  • (Boolean) 


219
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 219

def is_dismiss_on_click; end

#is_enable ⇒ Boolean Also known as: enable?

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

Returns:

  • (Boolean) 


205
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 205

def is_enable; end

#is_interactive ⇒ Boolean Also known as: interactive?

Returns true if the button is interactive.

Returns:

  • (Boolean) 


260
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 260

def is_interactive; end

#is_shown ⇒ Boolean Also known as: shown?

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

Returns:

  • (Boolean) 


244
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 244

def is_shown; end

#set_has_background(has = true) ⇒ void Also known as: has_background=

This method returns an undefined value.

Set the property that whether the button has background.

Parameters:

  • has (Boolean) (defaults to: true) 


239
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 239

def set_has_background(has=true) end

#set_interactive(interactive = true) ⇒ void Also known as: interactive=

This method returns an undefined value.

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.

Parameters:

  • interactive (Boolean) (defaults to: true) 


268
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 268

def set_interactive(interactive=true) end

#show(shown = true) ⇒ void

This method returns an undefined value.

Show or hide the thumbnail toolbar button.

Parameters:

  • shown (Boolean) (defaults to: true) 


250
 
# File 'lib/wx/doc/gen/task_bar_button.rb', line 250

def show(shown=true) end