Class: Wx::TaskBarButton

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 taskbar button that associated with the window under Windows 7 or later.

It is used to access the functionality including thumbnail representations, thumbnail toolbars, notification and status overlays, and progress indicators.

Note:

This class is only created and initialized in the internal implementation of Frame by design. You can only get the pointer of the instance which associated with the frame by calling Frame#msw_get_task_bar_button.

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

See Also:

Requires:

  • WXMSW
  • USE_TASKBARBUTTON

Instance Method Summary collapse

Instance Method Details

#append_separator_in_thumb_bar ⇒ Boolean

Appends a separator to the taskbar thumbnail toolbar.

Note:

The number of buttons and separators is limited to 7.

Returns:

  • (Boolean)

See Also:



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

def append_separator_in_thumb_bar; end

#append_thumb_bar_button(button) ⇒ Boolean

Appends a button to the taskbar thumbnail toolbar.

Note:

The number of buttons and separators is limited to 7.

Parameters:

Returns:

  • (Boolean)

See Also:



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

def append_thumb_bar_button(button) end

#hide ⇒ void

This method returns an undefined value.

Hide in the taskbar.



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

def hide; end

#insert_thumb_bar_button(pos, button) ⇒ Boolean

Inserts the given button before the position pos to the taskbar thumbnail toolbar.

Note:

The number of buttons and separators is limited to 7.

Parameters:

Returns:

  • (Boolean)

See Also:



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

def insert_thumb_bar_button(pos, button) end

#pulse_progress ⇒ void

This method returns an undefined value.

Makes the progress indicator run in indeterminate mode.

The first call to this method starts showing the indeterminate progress indicator if it hadn’t been shown yet. Call SetProgressRange(0) to stop showing the progress indicator.



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

def pulse_progress; end

#remove_thumb_bar_button(button) ⇒ Wx::ThumbBarButton #remove_thumb_bar_button(id) ⇒ Wx::ThumbBarButton

Overloads:

  • #remove_thumb_bar_button(button) ⇒ Wx::ThumbBarButton

    Removes the thumbnail toolbar button from the taskbar button but doesn’t delete the associated c++ object.

    A pointer to the button which was detached from the taskbar button.

    Parameters:

    Returns:

  • #remove_thumb_bar_button(id) ⇒ Wx::ThumbBarButton

    Removes the thumbnail toolbar button from the taskbar button but doesn’t delete the associated c++ object.

    A pointer to the button which was detached from the taskbar button.

    Parameters:

    • id (Integer) —

      The identifier of the thumbnail toolbar button to remove.

    Returns:



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

def remove_thumb_bar_button(*args) end

#set_overlay_icon(icon, description = ('')) ⇒ void Also known as: overlay_icon=

This method returns an undefined value.

Set an overlay icon to indicate application status or a notification top the user.

Parameters:

  • icon (Wx::Icon) —

    This should be a small icon, measuring 16x16 pixels at 96 dpi. If an overlay icon is already applied to the taskbar button, that existing overlay is replaced. Setting with NULL_ICON to remove.

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

    The property holds the description of the overlay for accessibility purposes.



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

def set_overlay_icon(icon, description=('')) end

#set_progress_range(range) ⇒ void Also known as: progress_range=

This method returns an undefined value.

Starts showing a determinate progress indicator.

Call #set_progress_value after this call to update the progress indicator. If range is 0, the progress indicator is dismissed.

Parameters:

  • range (Integer) 


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

def set_progress_range(range) end

#set_progress_state(state) ⇒ void Also known as: progress_state=

This method returns an undefined value.

Set the state of the progress indicator displayed on a taskbar button.

Parameters:

  • state (Wx::TaskBarButtonState)

See Also:

  • Wx::TaskBarButtonState


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

def set_progress_state(state) end

#set_progress_value(value) ⇒ void Also known as: progress_value=

This method returns an undefined value.

Update the progress indicator, setting the progress to the new value .

Parameters:

  • value (Integer) —

    Must be in the range from 0 to the argument to the last #set_progress_range call. When it is equal to the range, the progress bar is dismissed.



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

def set_progress_value(value) end

#set_thumbnail_clip(rect) ⇒ void Also known as: thumbnail_clip=

This method returns an undefined value.

Selects a portion of a window’s client area to display as that window’s thumbnail in the taskbar.

Parameters:

  • rect (Wx::Rect) —

    The portion inside of the window. Setting with an empty Rect will restore the default display of the thumbnail.



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

def set_thumbnail_clip(rect) end

#set_thumbnail_contents(child) ⇒ void Also known as: thumbnail_contents=

This method returns an undefined value.

Selects the child window area to display as that window’s thumbnail in the taskbar.

Parameters:



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

def set_thumbnail_contents(child) end

#set_thumbnail_tooltip(tooltip) ⇒ void Also known as: thumbnail_tooltip=

This method returns an undefined value.

Specifies or updates the text of the tooltip that is displayed when the mouse pointer rests on an individual preview thumbnail in a taskbar button flyout.

Parameters:

  • tooltip (String) 


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

def set_thumbnail_tooltip(tooltip) end

#show(show = true) ⇒ void

This method returns an undefined value.

Show in the taskbar.

Parameters:

  • show (Boolean) (defaults to: true) 


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

def show(show=true) end