Class: Wx::ToolBarToolBase

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

Overview

A toolbar tool represents one item on the toolbar.

It has a unique id (except for the separators), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar. Notice that the toolbar can not be modified by changing its tools via the (intentionally undocumented here) setter methods of this class, all the modifications must be done using the methods of ToolBar itself.

Requires:

  • USE_TOOLBAR

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(tbar = nil, toolid = Wx::StandardID::ID_SEPARATOR, label = (''), bmpNormal = Wx::NULL_BITMAP, bmpDisabled = Wx::NULL_BITMAP, kind = Wx::ItemKind::ITEM_NORMAL, clientData = nil, shortHelpString = (''), longHelpString = ('')) ⇒ Wx::ToolBarToolBase #initialize(tbar, control, label) ⇒ Wx::ToolBarToolBase

Returns a new instance of ToolBarToolBase.

Overloads:

  • #initialize(tbar = nil, toolid = Wx::StandardID::ID_SEPARATOR, label = (''), bmpNormal = Wx::NULL_BITMAP, bmpDisabled = Wx::NULL_BITMAP, kind = Wx::ItemKind::ITEM_NORMAL, clientData = nil, shortHelpString = (''), longHelpString = ('')) ⇒ Wx::ToolBarToolBase

    Parameters:

  • #initialize(tbar, control, label) ⇒ Wx::ToolBarToolBase

    Parameters:



779
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 779

def initialize(*args) end

Instance Method Details

#can_be_toggled ⇒ Boolean Also known as: can_be_toggled?

Returns:

  • (Boolean) 


833
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 833

def can_be_toggled; end

#get_bitmap ⇒ Wx::Bitmap Also known as: bitmap

Returns:



859
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 859

def get_bitmap; end

#get_client_data ⇒ Wx::Object Also known as: client_data

Returns:



875
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 875

def get_client_data; end

#get_control ⇒ Wx::Control Also known as: control

Returns:



786
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 786

def get_control; end

#get_disabled_bitmap ⇒ Wx::Bitmap Also known as: disabled_bitmap

Returns:



855
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 855

def get_disabled_bitmap; end

#get_disabled_bitmap_bundle ⇒ Wx::BitmapBundle Also known as: disabled_bitmap_bundle

Return the bundle containing disabled tool bitmaps.

This bundle may be invalid if the tool doesn’t show a bitmap or doesn’t have a specific disabled bitmap creates one automatically from the normal bitmap.

Returns:



847
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 847

def get_disabled_bitmap_bundle; end

#get_dropdown_menu ⇒ Wx::Menu Also known as: dropdown_menu

Returns:



884
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 884

def get_dropdown_menu; end

#get_id ⇒ Integer Also known as: id

Returns:

  • (Integer) 


782
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 782

def get_id; end

#get_kind ⇒ Wx::ItemKind Also known as: kind

Returns:



818
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 818

def get_kind; end

#get_label ⇒ Wx::String Also known as: label

Returns:

  • (Wx::String) 


863
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 863

def get_label; end

#get_long_help ⇒ Wx::String Also known as: long_help

Returns:

  • (Wx::String) 


871
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 871

def get_long_help; end

#get_normal_bitmap ⇒ Wx::Bitmap Also known as: normal_bitmap

Returns:



851
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 851

def get_normal_bitmap; end

#get_normal_bitmap_bundle ⇒ Wx::BitmapBundle Also known as: normal_bitmap_bundle

Return the bundle containing normal tool bitmaps.

This bundle may be invalid if the tool doesn’t show a bitmap.

Returns:



840
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 840

def get_normal_bitmap_bundle; end

#get_short_help ⇒ Wx::String Also known as: short_help

Returns:

  • (Wx::String) 


867
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 867

def get_short_help; end

#get_style ⇒ Integer Also known as: style

Returns:

  • (Integer) 


814
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 814

def get_style; end

#get_tool_bar ⇒ Wx::ToolBar Also known as: tool_bar

Returns:



790
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 790

def get_tool_bar; end

#is_button ⇒ Boolean Also known as: button?

Returns:

  • (Boolean) 


798
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 798

def is_button; end

#is_control ⇒ Boolean Also known as: control?

Returns:

  • (Boolean) 


802
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 802

def is_control; end

#is_enabled ⇒ Boolean Also known as: enabled?

Returns:

  • (Boolean) 


825
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 825

def is_enabled; end

#is_separator ⇒ Boolean Also known as: separator?

Returns:

  • (Boolean) 


806
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 806

def is_separator; end

#is_stretchable ⇒ Boolean Also known as: stretchable?

Returns:

  • (Boolean) 


794
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 794

def is_stretchable; end

#is_stretchable_space ⇒ Boolean Also known as: stretchable_space?

Returns:

  • (Boolean) 


810
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 810

def is_stretchable_space; end

#is_toggled ⇒ Boolean Also known as: toggled?

Returns:

  • (Boolean) 


829
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 829

def is_toggled; end

#make_stretchable ⇒ void

This method returns an undefined value.



822
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 822

def make_stretchable; end

#set_dropdown_menu(menu) ⇒ void Also known as: dropdown_menu=

This method returns an undefined value.

Parameters:



880
 
# File 'lib/wx/doc/gen/tool_bar.rb', line 880

def set_dropdown_menu(menu) end