Class: Wx::AUI::AuiToolBar

Inherits:
Control show all
Defined in:
lib/wx/doc/gen/aui/aui_tool_bar.rb

Overview

AuiToolBar is a dockable toolbar, part of the Wx::AUI class framework.

See also wxAUI Overview. The appearance of this class is configurable and can be changed by calling #set_art_provider. By default, native art provider is used if available (currently only in WXMSW) and Wx::AuiGenericToolBarArt otherwise.

Styles

This class supports the following styles:

Events emitted by this class

The following event-handler methods redirect the events to member method or handler blocks for AuiToolBarEvent events. Event handler methods for events emitted by this class:

Category: Window Docking (wxAUI)

Requires:

  • USE_AUI

Instance Method Summary collapse

Methods inherited from Control

#command, ellipsize, escape_mnemonics, #get_label, #get_label_text, #get_size_from_text, #get_size_from_text_size, remove_mnemonics, #set_label, #set_label_markup, #set_label_text

Methods inherited from Window

#accepts_focus, #accepts_focus_from_keyboard, #accepts_focus_recursively, #add_child, #adjust_for_layout_direction, #always_show_scrollbars, #begin_repositioning_children, #cache_best_size, #can_accept_focus, #can_accept_focus_from_keyboard, #can_scroll, #can_set_transparent, #capture_mouse, #center, #center_on_parent, #centre, #centre_on_parent, #clear_background, #client_to_screen, #client_to_window_size, #close, #convert_dialog_to_pixels, #convert_pixels_to_dialog, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_touch_events, #enable_visible_focus, #end_repositioning_children, find_focus, #find_window_by_id, find_window_by_id, #find_window_by_label, find_window_by_label, #find_window_by_name, find_window_by_name, #fit, #fit_inside, #freeze, #from_dip, from_dip, #from_phys, from_phys, #get_accelerator_table, #get_auto_layout, #get_background_colour, #get_background_style, #get_best_height, #get_best_size, #get_best_virtual_size, #get_best_width, #get_border, get_capture, #get_caret, #get_char_height, #get_char_width, #get_children, get_class_default_attributes, #get_client_area_origin, #get_client_rect, #get_client_size, #get_containing_sizer, #get_content_scale_factor, #get_cursor, #get_default_attributes, #get_dpi, #get_dpi_scale_factor, #get_drop_target, #get_effective_min_size, #get_event_handler, #get_extra_style, #get_font, #get_foreground_colour, #get_grand_parent, #get_help_text, #get_help_text_at_point, #get_id, #get_label, #get_layout_direction, #get_max_client_size, #get_max_height, #get_max_size, #get_max_width, #get_min_client_size, #get_min_height, #get_min_size, #get_min_width, #get_name, #get_next_sibling, #get_parent, #get_popup_menu_selection_from_user, #get_position, #get_prev_sibling, #get_rect, #get_screen_position, #get_screen_rect, #get_scroll_pos, #get_scroll_range, #get_scroll_thumb, #get_size, #get_sizer, #get_text_extent, #get_theme_enabled, #get_tool_tip, #get_tool_tip_text, #get_update_client_rect, #get_update_region, #get_validator, #get_virtual_size, #get_window_border_size, #get_window_style, #get_window_variant, #handle_as_navigation_key, #handle_window_event, #has_capture, #has_extra_style, #has_flag, #has_focus, #has_multiple_pages, #has_scrollbar, #has_transparent_background, #hide, #hide_with_effect, #hit_test, #inform_first_direction, #inherit_attributes, #inherits_background_colour, #inherits_foreground_colour, #init_dialog, #invalidate_best_size, #is_being_deleted, #is_descendant, #is_double_buffered, #is_enabled, #is_exposed, #is_focusable, #is_frozen, #is_retained, #is_scrollbar_always_shown, #is_shown, #is_shown_on_screen, #is_this_enabled, #is_top_level, #is_transparent_background_supported, #layout, #line_down, #line_up, #locked, #lower_window, #move, #move_after_in_tab_order, #move_before_in_tab_order, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #pop_event_handler, #popup_menu, #post_size_event, #post_size_event_to_parent, #process_window_event, #process_window_event_locally, #push_event_handler, #raise_window, #refresh, #refresh_rect, #register_hot_key, #release_mouse, #remove_child, #remove_event_handler, #reparent, #screen_to_client, #scroll_lines, #scroll_pages, #scroll_window, #send_size_event, #send_size_event_to_parent, #set_accelerator_table, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_double_buffered, #set_drop_target, #set_event_handler, #set_extra_style, #set_focus, #set_focus_from_kbd, #set_foreground_colour, #set_help_text, #set_id, #set_initial_size, #set_label, #set_layout_direction, #set_max_client_size, #set_max_size, #set_min_client_size, #set_min_size, #set_name, #set_next_handler, #set_own_background_colour, #set_own_font, #set_own_foreground_colour, #set_position, #set_previous_handler, #set_scroll_pos, #set_scrollbar, #set_size, #set_size_hints, #set_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #set_transparent, #set_validator, #set_virtual_size, #set_window_style, #set_window_variant, #should_inherit_colours, #show, #show_with_effect, #switch_sizer, #thaw, #to_dip, to_dip, #to_phys, to_phys, #toggle_window_style, #transfer_data_from_window, #transfer_data_to_window, #unregister_hot_key, unreserve_control_id, #unset_tool_tip, #update, #update_window_ui, #use_background_colour, #use_bg_col, #use_foreground_colour, #validate, #warp_pointer, #window_to_client_size

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::AUI::AuiToolBar #initialize(parent, id = Wx::StandardID::ID_ANY, position = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiToolBarStyle::AUI_TB_DEFAULT_STYLE) ⇒ Wx::AUI::AuiToolBar

Returns a new instance of AuiToolBar.

Overloads:

  • #initialize ⇒ Wx::AUI::AuiToolBar

    Default constructor, use #create later.

  • #initialize(parent, id = Wx::StandardID::ID_ANY, position = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiToolBarStyle::AUI_TB_DEFAULT_STYLE) ⇒ Wx::AUI::AuiToolBar

    Constructor creating and initializing the object.

    Parameters:

    • parent (Wx::Window)
    • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
    • position (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
    • style (Integer) (defaults to: Wx::AUI::AuiToolBarStyle::AUI_TB_DEFAULT_STYLE) 


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

def initialize(*args) end

Instance Method Details

#add_control(control, label = ('')) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • control (Wx::Control)
  • label (String) (defaults to: (''))

Returns:



159
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 159

def add_control(control, label=('')) end

#add_label(toolId, label = (''), width = -1)) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • toolId (Integer)
  • label (String) (defaults to: (''))
  • width (Integer) (defaults to: -1))

Returns:



154
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 154

def add_label(toolId, label=(''), width=-1) end

#add_separator ⇒ Wx::AUI::AuiToolBarItem

Returns:



162
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 162

def add_separator; end

#add_spacer(pixels) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • pixels (Integer)

Returns:



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

def add_spacer(pixels) end

#add_stretch_spacer(proportion = 1) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • proportion (Integer) (defaults to: 1)

Returns:



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

def add_stretch_spacer(proportion=1) end

#add_tool(toolId, label, bitmap, short_help_string = (''), kind = Wx::ItemKind::ITEM_NORMAL) ⇒ Wx::AUI::AuiToolBarItem #add_tool(toolId, label, bitmap, disabled_bitmap, kind, short_help_string, long_help_string, client_data) ⇒ Wx::AUI::AuiToolBarItem #add_tool(toolId, bitmap, disabled_bitmap, toggle = false, client_data = nil, short_help_string = (''), long_help_string = ('')) ⇒ Wx::AUI::AuiToolBarItem

Overloads:



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

def add_tool(*args) end

#clear ⇒ void

This method returns an undefined value.



196
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 196

def clear; end

#clear_tools ⇒ void

This method returns an undefined value.



193
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 193

def clear_tools; end

#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::AUI::AuiToolBarStyle::AUI_TB_DEFAULT_STYLE) ⇒ Boolean

Really create Wx::AUI::AuiToolBar created using default constructor.

Parameters:

  • parent (Wx::Window)
  • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: Wx::AUI::AuiToolBarStyle::AUI_TB_DEFAULT_STYLE)

Returns:

  • (Boolean) 


81
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 81

def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::AUI::AuiToolBarStyle::AUI_TB_DEFAULT_STYLE) end

#delete_by_index(idx) ⇒ Boolean

Removes the tool at the given position from the toolbar.

Note that if this tool was added by #add_control, the associated control is not deleted and must either be reused (e.g. by reparenting it under a different window) or destroyed by caller. If this behaviour is unwanted, prefer using #destroy_tool_by_index instead.

true if the tool was removed or false otherwise, e.g. if the provided index is out of range.

Parameters:

  • idx (Integer) —

    The index, or position, of a previously added tool.

Returns:

  • (Boolean) 


228
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 228

def delete_by_index(idx) end

#delete_tool(toolId) ⇒ Boolean

Removes the tool with the given ID from the toolbar.

Note that if this tool was added by #add_control, the associated control is not deleted and must either be reused (e.g. by reparenting it under a different window) or destroyed by caller. If this behaviour is unwanted, prefer using #destroy_tool instead.

true if the tool was removed or false otherwise, e.g. if the tool with the given ID was not found.

Parameters:

  • toolId (Integer) —

    ID of a previously added tool.

Returns:

  • (Boolean) 


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

def delete_tool(toolId) end

#destroy_tool(toolId) ⇒ Boolean

Destroys the tool with the given ID and its associated window, if any.

true if the tool was destroyed or false otherwise, e.g. if the tool with the given ID was not found.

Parameters:

  • toolId (Integer) —

    ID of a previously added tool.

Returns:

  • (Boolean) 


203
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 203

def destroy_tool(toolId) end

#destroy_tool_by_index(idx) ⇒ Boolean

Destroys the tool at the given position and its associated window, if any.

true if the tool was destroyed or false otherwise, e.g. if the provided index is out of range.

Parameters:

  • idx (Integer) —

    The index, or position, of a previously added tool.

Returns:

  • (Boolean) 


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

def destroy_tool_by_index(idx) end

#enable_tool(toolId, state) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • state (Boolean) 


319
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 319

def enable_tool(toolId, state) end

#find_control(window_id) ⇒ Wx::Control

Parameters:

  • window_id (Integer)

Returns:



177
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 177

def find_control(window_id) end

#find_tool(toolId) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • toolId (Integer)

Returns:



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

def find_tool(toolId) end

#find_tool_by_index(idx) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • idx (Integer)

Returns:



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

def find_tool_by_index(idx) end

#find_tool_by_position(x, y) ⇒ Wx::AUI::AuiToolBarItem

Parameters:

  • x (Integer)
  • y (Integer)

Returns:



182
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 182

def find_tool_by_position(x, y) end

#get_art_provider ⇒ Wx::AUI::AuiToolBarArt Also known as: art_provider

Returns:



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

def get_art_provider; end

#get_gripper_visible ⇒ Boolean Also known as: gripper_visible

Returns:

  • (Boolean) 


298
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 298

def get_gripper_visible; end

#get_hint_size(dock_direction) ⇒ Wx::Size Also known as: hint_size

get size of hint rectangle for a particular dock location

Parameters:

  • dock_direction (Integer)

Returns:



457
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 457

def get_hint_size(dock_direction) end

#get_overflow_visible ⇒ Boolean Also known as: overflow_visible

Returns:

  • (Boolean) 


289
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 289

def get_overflow_visible; end

#get_tool_bar_fits ⇒ Boolean Also known as: tool_bar_fits

Returns:

  • (Boolean) 


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

def get_tool_bar_fits; end

#get_tool_bitmap(toolId) ⇒ Wx::Bitmap Also known as: tool_bitmap

Parameters:

  • toolId (Integer)

Returns:



412
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 412

def get_tool_bitmap(toolId) end

#get_tool_bitmap_size ⇒ Wx::Size Also known as: tool_bitmap_size

Returns:



285
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 285

def get_tool_bitmap_size; end

#get_tool_border_padding ⇒ Integer Also known as: tool_border_padding

Returns:

  • (Integer) 


350
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 350

def get_tool_border_padding; end

#get_tool_count ⇒ Integer Also known as: tool_count

Returns:

  • (Integer) 


231
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 231

def get_tool_count; end

#get_tool_drop_down(toolId) ⇒ Boolean Also known as: tool_drop_down

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

Parameters:

  • toolId (Integer)

Returns:

  • (Boolean)

See Also:



341
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 341

def get_tool_drop_down(toolId) end

#get_tool_enabled(toolId) ⇒ Boolean Also known as: tool_enabled

Parameters:

  • toolId (Integer)

Returns:

  • (Boolean) 


323
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 323

def get_tool_enabled(toolId) end

#get_tool_fits(toolId) ⇒ Boolean Also known as: tool_fits

Parameters:

  • toolId (Integer)

Returns:

  • (Boolean) 


246
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 246

def get_tool_fits(toolId) end

#get_tool_fits_by_index(toolId) ⇒ Boolean Also known as: tool_fits_by_index

Parameters:

  • toolId (Integer)

Returns:

  • (Boolean) 


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

def get_tool_fits_by_index(toolId) end

#get_tool_index(toolId) ⇒ Integer Also known as: tool_index

Parameters:

  • toolId (Integer)

Returns:

  • (Integer) 


241
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 241

def get_tool_index(toolId) end

#get_tool_label(toolId) ⇒ String Also known as: tool_label

Parameters:

  • toolId (Integer)

Returns:

  • (String) 


402
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 402

def get_tool_label(toolId) end

#get_tool_long_help(toolId) ⇒ String Also known as: tool_long_help

Parameters:

  • toolId (Integer)

Returns:

  • (String) 


432
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 432

def get_tool_long_help(toolId) end

#get_tool_packing ⇒ Integer Also known as: tool_packing

Returns:

  • (Integer) 


368
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 368

def get_tool_packing; end

#get_tool_pos(toolId) ⇒ Integer Also known as: tool_pos

Parameters:

  • toolId (Integer)

Returns:

  • (Integer) 


236
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 236

def get_tool_pos(toolId) end

#get_tool_proportion(toolId) ⇒ Integer Also known as: tool_proportion

Parameters:

  • toolId (Integer)

Returns:

  • (Integer) 


378
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 378

def get_tool_proportion(toolId) end

#get_tool_rect(toolId) ⇒ Wx::Rect Also known as: tool_rect

Parameters:

  • toolId (Integer)

Returns:



251
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 251

def get_tool_rect(toolId) end

#get_tool_separation ⇒ Integer Also known as: tool_separation

Returns:

  • (Integer) 


387
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 387

def get_tool_separation; end

#get_tool_short_help(toolId) ⇒ String Also known as: tool_short_help

Parameters:

  • toolId (Integer)

Returns:

  • (String) 


422
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 422

def get_tool_short_help(toolId) end

#get_tool_sticky(toolId) ⇒ Boolean Also known as: tool_sticky

Parameters:

  • toolId (Integer)

Returns:

  • (Boolean) 


397
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 397

def get_tool_sticky(toolId) end

#get_tool_text_orientation ⇒ Integer Also known as: tool_text_orientation

Returns:

  • (Integer) 


359
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 359

def get_tool_text_orientation; end

#get_tool_toggled(toolId) ⇒ Boolean Also known as: tool_toggled

Parameters:

  • toolId (Integer)

Returns:

  • (Boolean) 


313
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 313

def get_tool_toggled(toolId) end

#get_window_style_flag ⇒ Integer Also known as: window_style_flag

Gets the window style that was passed to the constructor or #create method.

Window#get_window_style is another name for the same function.

Returns:

  • (Integer) 


97
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 97

def get_window_style_flag; end

#is_pane_valid(pane) ⇒ Boolean Also known as: pane_valid?

Parameters:

Returns:

  • (Boolean) 


462
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 462

def is_pane_valid(pane) end

#realize ⇒ Boolean

Returns:

  • (Boolean) 


173
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 173

def realize; end

#set_art_provider(art) ⇒ void Also known as: art_provider=

This method returns an undefined value.

Parameters:



102
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 102

def set_art_provider(art) end

#set_custom_overflow_items(prepend, append) ⇒ void

This method returns an undefined value.

Add toolbar items that are always displayed in the overflow menu.

If there are custom items set, then the overflow menu will be displayed even if there are no items from the main toolbar that overflow.

Note:

The toolbar must have the Wx::AUI::AuiToolBarStyle::AUI_TB_OVERFLOW style.

Parameters:



452
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 452

def set_custom_overflow_items(prepend, append) end

#set_font(font) ⇒ Boolean Also known as: font=

Sets the font for this window.

This function should not be called for the parent window if you don’t want its font to be inherited by its children, use Window#set_own_font instead in this case and see Window#inherit_attributes for more explanations. Please notice that the given font is not automatically used for PaintDC objects associated with this window, you need to call DC#set_font too. However this font is used by any standard controls for drawing their text as well as by Window#get_text_extent.

true if the font was really changed, false if it was already set to this font and nothing was done.

Parameters:

Returns:

  • (Boolean)

See Also:



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

def set_font(font) end

#set_gripper_visible(visible) ⇒ void Also known as: gripper_visible=

This method returns an undefined value.

Parameters:

  • visible (Boolean) 


303
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 303

def set_gripper_visible(visible) end

#set_margins(size) ⇒ void #set_margins(x, y) ⇒ void #set_margins(left, right, top, bottom) ⇒ void Also known as: margins=

Overloads:

  • #set_margins(size) ⇒ void

    This method returns an undefined value.

    Parameters:

    • size (Array(Integer, Integer), Wx::Size)
  • #set_margins(x, y) ⇒ void

    This method returns an undefined value.

    Parameters:

    • x (Integer)
    • y (Integer)
  • #set_margins(left, right, top, bottom) ⇒ void

    This method returns an undefined value.

    Parameters:

    • left (Integer)
    • right (Integer)
    • top (Integer)
    • bottom (Integer) 


276
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 276

def set_margins(*args) end

#set_overflow_visible(visible) ⇒ void Also known as: overflow_visible=

This method returns an undefined value.

Parameters:

  • visible (Boolean) 


294
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 294

def set_overflow_visible(visible) end

#set_tool_bitmap(toolId, bitmap) ⇒ void

This method returns an undefined value.

Parameters:



418
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 418

def set_tool_bitmap(toolId, bitmap) end

#set_tool_bitmap_size(size) ⇒ void Also known as: tool_bitmap_size=

This method returns an undefined value.

Parameters:

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


281
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 281

def set_tool_bitmap_size(size) end

#set_tool_border_padding(padding) ⇒ void Also known as: tool_border_padding=

This method returns an undefined value.

Parameters:

  • padding (Integer) 


346
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 346

def set_tool_border_padding(padding) end

#set_tool_drop_down(toolId, dropdown) ⇒ void

This method returns an undefined value.

Set whether the specified toolbar item has a drop down button.

This is only valid for ItemKind::ITEM_NORMAL tools.

Parameters:

  • toolId (Integer)
  • dropdown (Boolean)

See Also:



333
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 333

def set_tool_drop_down(toolId, dropdown) end

#set_tool_label(toolId, label) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • label (String) 


408
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 408

def set_tool_label(toolId, label) end

#set_tool_long_help(toolId, help_string) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • help_string (String) 


438
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 438

def set_tool_long_help(toolId, help_string) end

#set_tool_packing(packing) ⇒ void Also known as: tool_packing=

This method returns an undefined value.

Parameters:

  • packing (Integer) 


364
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 364

def set_tool_packing(packing) end

#set_tool_proportion(toolId, proportion) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • proportion (Integer) 


374
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 374

def set_tool_proportion(toolId, proportion) end

#set_tool_separation(separation) ⇒ void Also known as: tool_separation=

This method returns an undefined value.

Parameters:

  • separation (Integer) 


383
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 383

def set_tool_separation(separation) end

#set_tool_short_help(toolId, help_string) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • help_string (String) 


428
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 428

def set_tool_short_help(toolId, help_string) end

#set_tool_sticky(toolId, sticky) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • sticky (Boolean) 


393
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 393

def set_tool_sticky(toolId, sticky) end

#set_tool_text_orientation(orientation) ⇒ void Also known as: tool_text_orientation=

This method returns an undefined value.

Parameters:

  • orientation (Integer) 


355
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 355

def set_tool_text_orientation(orientation) end

#set_window_style_flag(style) ⇒ void Also known as: window_style_flag=

This method returns an undefined value.

Sets the style of the window.

Please note that some styles cannot be changed after the window creation and that Window#refresh might need to be called after changing the others for the change to take place immediately. See Window styles for more information about flags.

Parameters:

  • style (Integer)

See Also:



90
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 90

def set_window_style_flag(style) end

#toggle_tool(toolId, state) ⇒ void

This method returns an undefined value.

Parameters:

  • toolId (Integer)
  • state (Boolean) 


309
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar.rb', line 309

def toggle_tool(toolId, state) end