Class: Wx::AUI::AuiToolBarItem

Inherits:

Object

• Object
• Wx::AUI::AuiToolBarItem

Defined in:

lib/wx/doc/gen/aui/aui_tool_bar_item.rb

Overview

AuiToolBarItem is part of the Wx::AUI class framework, representing a toolbar element.

See also AuiToolBar and wxAUI Overview. It has a unique id (except for the separators which always have id = -1), 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 (currently not implemented).

Category: Window Docking (wxAUI)

Requires:

• USE_AUI

Instance Method Summary

• #assign(c) ⇒ void

  Assigns the properties of the AuiToolBarItem “c” to this.

• #can_be_toggled ⇒ Boolean (also: #can_be_toggled?)

  Returns whether the toolbar item can be toggled.

• #get_alignment ⇒ Integer (also: #alignment)
• #get_bitmap ⇒ Wx::Bitmap (also: #bitmap)
• #get_disabled_bitmap ⇒ Wx::Bitmap (also: #disabled_bitmap)
• #get_hover_bitmap ⇒ Wx::Bitmap (also: #hover_bitmap)
• #get_id ⇒ Integer (also: #id)

  Returns the toolbar item identifier.

• #get_kind ⇒ Integer (also: #kind)

  Returns the toolbar item kind.

• #get_label ⇒ Wx::String (also: #label)
• #get_long_help ⇒ Wx::String (also: #long_help)
• #get_min_size ⇒ Wx::Size (also: #min_size)
• #get_proportion ⇒ Integer (also: #proportion)
• #get_short_help ⇒ Wx::String (also: #short_help)
• #get_sizer_item ⇒ Wx::SizerItem (also: #sizer_item)
• #get_spacer_pixels ⇒ Integer (also: #spacer_pixels)
• #get_state ⇒ Integer (also: #state)

  Gets the current state of the toolbar item.

• #get_user_data ⇒ Integer (also: #user_data)
• #get_window ⇒ Wx::Window (also: #window)

  Returns the Window* associated to the toolbar item.

• #has_drop_down ⇒ Boolean (also: #has_drop_down?)

  Returns whether the toolbar item has an associated drop down button.

• #initialize(*args) ⇒ AuiToolBarItem constructor

  A new instance of AuiToolBarItem.

• #is_active ⇒ Boolean (also: #active?)
• #is_sticky ⇒ Boolean (also: #sticky?)
• #set_active(b) ⇒ void (also: #active=)
• #set_alignment(l) ⇒ void (also: #alignment=)
• #set_bitmap(bmp) ⇒ void (also: #bitmap=)
• #set_disabled_bitmap(bmp) ⇒ void (also: #disabled_bitmap=)
• #set_has_drop_down(b) ⇒ void (also: #has_drop_down=)

  Set whether this tool has a drop down button.

• #set_hover_bitmap(bmp) ⇒ void (also: #hover_bitmap=)
• #set_id(new_id) ⇒ void (also: #id=)

  Sets the toolbar item identifier.

• #set_kind(new_kind) ⇒ void (also: #kind=)

  Sets the AuiToolBarItem kind.

• #set_label(s) ⇒ void (also: #label=)
• #set_long_help(s) ⇒ void (also: #long_help=)
• #set_min_size(s) ⇒ void (also: #min_size=)
• #set_proportion(p) ⇒ void (also: #proportion=)
• #set_short_help(s) ⇒ void (also: #short_help=)
• #set_sizer_item(s) ⇒ void (also: #sizer_item=)
• #set_spacer_pixels(s) ⇒ void (also: #spacer_pixels=)
• #set_state(new_state) ⇒ void (also: #state=)

  Set the current state of the toolbar item.

• #set_sticky(b) ⇒ void (also: #sticky=)
• #set_user_data(l) ⇒ void (also: #user_data=)
• #set_window(w) ⇒ void (also: #window=)

  Assigns a window to the toolbar item.

Constructor Details

#initialize ⇒ Wx::AUI::AuiToolBarItem #initialize(c) ⇒ Wx::AUI::AuiToolBarItem

Returns a new instance of AuiToolBarItem.

Overloads:

• #initialize ⇒ Wx::AUI::AuiToolBarItem

  Default Constructor.
• #initialize(c) ⇒ Wx::AUI::AuiToolBarItem

  Assigns the properties of the Wx::AUI::AuiToolBarItem “c” to this.

  Parameters:

  • c (Wx::AUI::AuiToolBarItem)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 28

def initialize(*args) end

Instance Method Details

#assign(c) ⇒ void

This method returns an undefined value.

Assigns the properties of the Wx::AUI::AuiToolBarItem “c” to this.

Parameters:

• c (Wx::AUI::AuiToolBarItem)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 33

def assign(c) end

#can_be_toggled ⇒ Boolean Also known as: can_be_toggled?

Returns whether the toolbar item can be toggled.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 224

def can_be_toggled; end

#get_alignment ⇒ Integer Also known as: alignment

Returns:

• (Integer)

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

def get_alignment; end

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

Returns:

• (Wx::Bitmap)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 107

def get_bitmap; end

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

Returns:

• (Wx::Bitmap)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 116

def get_disabled_bitmap; end

#get_hover_bitmap ⇒ Wx::Bitmap Also known as: hover_bitmap

Returns:

• (Wx::Bitmap)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 125

def get_hover_bitmap; end

#get_id ⇒ Integer Also known as: id

Returns the toolbar item identifier.

Returns:

• (Integer)

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

def get_id; end

#get_kind ⇒ Integer Also known as: kind

Returns the toolbar item kind.

one of ItemKind::ITEM_NORMAL, ItemKind::ITEM_CHECK or ItemKind::ITEM_RADIO, ItemKind::ITEM_SEPARATOR, ITEM_CONTROL, ITEM_SPACER, ITEM_LABEL,

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 67

def get_kind; end

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

Returns:

• (Wx::String)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 98

def get_label; end

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

Returns:

• (Wx::String)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 143

def get_long_help; end

#get_min_size ⇒ Wx::Size Also known as: min_size

Returns:

• (Wx::Size)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 152

def get_min_size; end

#get_proportion ⇒ Integer Also known as: proportion

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 170

def get_proportion; end

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

Returns:

• (Wx::String)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 134

def get_short_help; end

#get_sizer_item ⇒ Wx::SizerItem Also known as: sizer_item

Returns:

• (Wx::SizerItem)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 89

def get_sizer_item; end

#get_spacer_pixels ⇒ Integer Also known as: spacer_pixels

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 161

def get_spacer_pixels; end

#get_state ⇒ Integer Also known as: state

Gets the current state of the toolbar item.

an or’d combination of flags from Wx::AUI::AuiPaneButtonState representing the current state

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 80

def get_state; end

#get_user_data ⇒ Integer Also known as: user_data

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 210

def get_user_data; end

#get_window ⇒ Wx::Window Also known as: window

Returns the Window* associated to the toolbar item.

Returns:

• (Wx::Window)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 43

def get_window; end

#has_drop_down ⇒ Boolean Also known as: has_drop_down?

Returns whether the toolbar item has an associated drop down button.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 192

def has_drop_down; end

#is_active ⇒ Boolean Also known as: active?

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 179

def is_active; end

#is_sticky ⇒ Boolean Also known as: sticky?

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 201

def is_sticky; end

#set_active(b) ⇒ void Also known as: active=

This method returns an undefined value.

Parameters:

• b (Boolean)

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

def set_active(b) end

#set_alignment(l) ⇒ void Also known as: alignment=

This method returns an undefined value.

Parameters:

• l (Integer)

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

def set_alignment(l) end

#set_bitmap(bmp) ⇒ void Also known as: bitmap=

This method returns an undefined value.

Parameters:

• bmp (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 103

def set_bitmap(bmp) end

#set_disabled_bitmap(bmp) ⇒ void Also known as: disabled_bitmap=

This method returns an undefined value.

Parameters:

• bmp (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 112

def set_disabled_bitmap(bmp) end

#set_has_drop_down(b) ⇒ void Also known as: has_drop_down=

This method returns an undefined value.

Set whether this tool has a drop down button.

This is only valid for ItemKind::ITEM_NORMAL tools.

Parameters:

• b (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 187

def set_has_drop_down(b) end

#set_hover_bitmap(bmp) ⇒ void Also known as: hover_bitmap=

This method returns an undefined value.

Parameters:

• bmp (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 121

def set_hover_bitmap(bmp) end

#set_id(new_id) ⇒ void Also known as: id=

This method returns an undefined value.

Sets the toolbar item identifier.

Parameters:

• new_id (Integer)

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

def set_id(new_id) end

#set_kind(new_kind) ⇒ void Also known as: kind=

This method returns an undefined value.

Sets the Wx::AUI::AuiToolBarItem kind.

Parameters:

• new_kind (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 60

def set_kind(new_kind) end

#set_label(s) ⇒ void Also known as: label=

This method returns an undefined value.

Parameters:

• s (String)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 94

def set_label(s) end

#set_long_help(s) ⇒ void Also known as: long_help=

This method returns an undefined value.

Parameters:

• s (String)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 139

def set_long_help(s) end

#set_min_size(s) ⇒ void Also known as: min_size=

This method returns an undefined value.

Parameters:

• s (Array(Integer, Integer), Wx::Size)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 148

def set_min_size(s) end

#set_proportion(p) ⇒ void Also known as: proportion=

This method returns an undefined value.

Parameters:

• p (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 166

def set_proportion(p) end

#set_short_help(s) ⇒ void Also known as: short_help=

This method returns an undefined value.

Parameters:

• s (String)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 130

def set_short_help(s) end

#set_sizer_item(s) ⇒ void Also known as: sizer_item=

This method returns an undefined value.

Parameters:

• s (Wx::SizerItem)

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

def set_sizer_item(s) end

#set_spacer_pixels(s) ⇒ void Also known as: spacer_pixels=

This method returns an undefined value.

Parameters:

• s (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 157

def set_spacer_pixels(s) end

#set_state(new_state) ⇒ void Also known as: state=

This method returns an undefined value.

Set the current state of the toolbar item.

Parameters:

• new_state (Integer) —

  is an or’d combination of flags from Wx::AUI::AuiPaneButtonState

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 73

def set_state(new_state) end

#set_sticky(b) ⇒ void Also known as: sticky=

This method returns an undefined value.

Parameters:

• b (Boolean)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 197

def set_sticky(b) end

#set_user_data(l) ⇒ void Also known as: user_data=

This method returns an undefined value.

Parameters:

• l (Integer)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 206

def set_user_data(l) end

#set_window(w) ⇒ void Also known as: window=

This method returns an undefined value.

Assigns a window to the toolbar item.

Parameters:

• w (Wx::Window)

# File 'lib/wx/doc/gen/aui/aui_tool_bar_item.rb', line 38

def set_window(w) end