Class: Wx::RBN::RibbonButtonBar

Inherits:
RibbonControl show all
Defined in:
lib/wx/doc/gen/rbn/ribbon_button_bar.rb,
lib/wx/doc/rbn/ribbon_button_bar.rb

Overview

A ribbon button bar is similar to a traditional toolbar.

It contains one or more buttons (button bar buttons, not Buttons), each of which has a label and an icon. It differs from a RibbonToolBar in several ways:

  • Individual buttons can grow and contract.

  • Buttons have labels as well as bitmaps.

  • Bitmaps are typically larger (at least 32x32 pixels) on a button bar compared to a tool bar (which typically has 16x15).

  • There is no grouping of buttons on a button bar

  • A button bar typically has a border around each individual button, whereas a tool bar typically has a border around each group of buttons.

Events emitted by this class

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

Category: Ribbon User Interface

Requires:

  • USE_RIBBON

Instance Method Summary collapse

Methods inherited from RibbonControl

#get_ancestor_ribbon_bar, #get_art_provider, #get_best_size_for_parent_size, #get_next_larger_size, #get_next_smaller_size, #is_sizing_continuous, #realise, #set_art_provider

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_style_flag, #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, #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_font, #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_style_flag, #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_display_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_capture_changed, #evt_mouse_capture_lost, #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_command, #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, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::RBN::RibbonButtonBar #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Wx::RBN::RibbonButtonBar

Returns a new instance of RibbonButtonBar.

Overloads:

  • #initialize ⇒ Wx::RBN::RibbonButtonBar

    Default constructor.

    With this constructor, #create should be called in order to create the button bar.

  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Wx::RBN::RibbonButtonBar

    Construct a ribbon button bar with the given parameters.

    Parameters:

    • parent (Wx::Window) —

      Parent window for the button bar (typically a Wx::RBN::RibbonPanel).

    • id (Integer) (defaults to: Wx::StandardID::ID_ANY) —

      An identifier for the button bar. StandardID::ID_ANY is taken to mean a default.

    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION) —

      Initial position of the button bar.

    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE) —

      Initial size of the button bar.

    • style (Integer) (defaults to: 0) —

      Button bar style, currently unused.



122
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 122

def initialize(*args) end

Instance Method Details

#add_button(button_id, label, bitmap, help_string, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) ⇒ Integer #add_button(button_id, label, bitmap, bitmap_small = Wx::NULL_BITMAP, bitmap_disabled = Wx::NULL_BITMAP, bitmap_small_disabled = Wx::NULL_BITMAP, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, help_string = ('')) ⇒ Integer

Overloads:

  • #add_button(button_id, label, bitmap, help_string, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) ⇒ Integer

    Add a button to the button bar (simple version).

    Parameters:

    • button_id (Integer)
    • label (String)
    • bitmap (Wx::Bitmap)
    • help_string (String)
    • kind (Wx::RibbonButtonKind) (defaults to: Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL)

    Returns:

    • (Integer)
  • #add_button(button_id, label, bitmap, bitmap_small = Wx::NULL_BITMAP, bitmap_disabled = Wx::NULL_BITMAP, bitmap_small_disabled = Wx::NULL_BITMAP, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, help_string = ('')) ⇒ Integer

    Add a button to the button bar.

    An opaque pointer which can be used only with other button bar methods.

    Parameters:

    • button_id (Integer) —

      ID of the new button (used for event callbacks).

    • label (String) —

      Label of the new button.

    • bitmap (Wx::Bitmap) —

      Large bitmap of the new button. Must be the same size as all other large bitmaps used on the button bar.

    • bitmap_small (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Small bitmap of the new button. If left as null, then a small bitmap will be automatically generated. Must be the same size as all other small bitmaps used on the button bar.

    • bitmap_disabled (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Large bitmap of the new button when it is disabled. If left as null, then a bitmap will be automatically generated from bitmap.

    • bitmap_small_disabled (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Small bitmap of the new button when it is disabled. If left as null, then a bitmap will be automatically generated from bitmap_small.

    • kind (Wx::RibbonButtonKind) (defaults to: Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) —

      The kind of button to add.

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

      The UI help string to associate with the new button.

    Returns:

    • (Integer)

    See Also:



161
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 161

def add_button(*args) end

#add_dropdown_button(button_id, label, bitmap, help_string = ('')) ⇒ Integer

Add a dropdown button to the button bar (simple version).

Parameters:

  • button_id (Integer)
  • label (String)
  • bitmap (Wx::Bitmap)
  • help_string (String) (defaults to: (''))

Returns:

  • (Integer)

See Also:



172
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 172

def add_dropdown_button(button_id, label, bitmap, help_string=('')) end

#add_hybrid_button(button_id, label, bitmap, help_string = ('')) ⇒ Integer

Add a hybrid button to the button bar (simple version).

Parameters:

  • button_id (Integer)
  • label (String)
  • bitmap (Wx::Bitmap)
  • help_string (String) (defaults to: (''))

Returns:

  • (Integer)

See Also:



183
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 183

def add_hybrid_button(button_id, label, bitmap, help_string=('')) end

#add_toggle_button(button_id, label, bitmap, help_string = ('')) ⇒ Integer

Add a toggle button to the button bar (simple version).

Parameters:

  • button_id (Integer)
  • label (String)
  • bitmap (Wx::Bitmap)
  • help_string (String) (defaults to: (''))

Returns:

  • (Integer)

See Also:



194
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 194

def add_toggle_button(button_id, label, bitmap, help_string=('')) end

#clear_buttons ⇒ void

This method returns an undefined value.

Delete all buttons from the button bar.

See Also:



324
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 324

def clear_buttons; end

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

Create a button bar in two-step button bar construction.

Should only be called when the default constructor is used, and arguments have the same meaning as in the full 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: 0)

Returns:

  • (Boolean) 


133
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 133

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

#delete_button(button_id) ⇒ Boolean

Delete a single button from the button bar.

The corresponding button is deleted by this function, so any pointers to it previously obtained by #get_item or get_item_by_id become invalid.

Parameters:

  • button_id (Integer)

Returns:

  • (Boolean)

See Also:



332
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 332

def delete_button(button_id) end

#enable_button(button_id, enable = true) ⇒ void

This method returns an undefined value.

Enable or disable a single button on the bar.

Parameters:

  • button_id (Integer) —

    ID of the button to enable or disable.

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

    true to enable the button, false to disable it.



338
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 338

def enable_button(button_id, enable=true) end

#get_active_item ⇒ Integer Also known as: active_item

Returns the active item of the button bar or NULL if there is none.

The active button is the one being clicked.

Returns:

  • (Integer) 


419
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 419

def get_active_item; end

#get_button_count ⇒ Integer Also known as: button_count

Returns the number of buttons in this button bar.

Returns:

  • (Integer) 


281
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 281

def get_button_count; end

#get_hovered_item ⇒ Integer Also known as: hovered_item

Returns the hovered item of the button bar or NULL if there is none.

The hovered button is the one the mouse is over.

Returns:

  • (Integer) 


426
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 426

def get_hovered_item; end

#get_item(n) ⇒ Integer Also known as: item

Returns the N-th button of the bar.

Parameters:

  • n (Integer)

Returns:

  • (Integer)

See Also:



304
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 304

def get_item(n) end

#get_item_client_object(item) ⇒ Object Also known as: item_client_object

Get the client object associated with a button.

Parameters:

  • item (Integer)

Returns:



295
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 295

def get_item_client_object(item) end

#get_item_rect(button_id) ⇒ Wx::Rect Also known as: item_rect

Returns the items’s rect with coordinates relative to the button bar’s parent, or a default-constructed rect if the tool is not found.

Parameters:

  • button_id (Integer) —

    ID of the button in question.

Returns:



310
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 310

def get_item_rect(button_id) end

#get_show_tool_tips_for_disabled ⇒ Boolean Also known as: show_tool_tips_for_disabled

Sets whether tooltips should be shown for disabled buttons or not.

You may wish to show it to explain why a button is disabled or what it normally does when enabled.

Returns:

  • (Boolean) 


441
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 441

def get_show_tool_tips_for_disabled; end

#insert_button(pos, button_id, label, bitmap, help_string, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) ⇒ Integer #insert_button(pos, button_id, label, bitmap, bitmap_small = Wx::NULL_BITMAP, bitmap_disabled = Wx::NULL_BITMAP, bitmap_small_disabled = Wx::NULL_BITMAP, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, help_string = ('')) ⇒ Integer

Overloads:

  • #insert_button(pos, button_id, label, bitmap, help_string, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) ⇒ Integer

    Inserts a button to the button bar (simple version) at the given position.

    Parameters:

    • pos (Integer)
    • button_id (Integer)
    • label (String)
    • bitmap (Wx::Bitmap)
    • help_string (String)
    • kind (Wx::RibbonButtonKind) (defaults to: Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL)

    Returns:

    • (Integer)

    See Also:

  • #insert_button(pos, button_id, label, bitmap, bitmap_small = Wx::NULL_BITMAP, bitmap_disabled = Wx::NULL_BITMAP, bitmap_small_disabled = Wx::NULL_BITMAP, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, help_string = ('')) ⇒ Integer

    Insert a button to the button bar at the given position.

    An opaque pointer which can be used only with other button bar methods.

    Parameters:

    • pos (Integer) —

      Position of the new button in the button bar.

    • button_id (Integer) —

      ID of the new button (used for event callbacks).

    • label (String) —

      Label of the new button.

    • bitmap (Wx::Bitmap) —

      Large bitmap of the new button. Must be the same size as all other large bitmaps used on the button bar.

    • bitmap_small (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Small bitmap of the new button. If left as null, then a small bitmap will be automatically generated. Must be the same size as all other small bitmaps used on the button bar.

    • bitmap_disabled (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Large bitmap of the new button when it is disabled. If left as null, then a bitmap will be automatically generated from bitmap.

    • bitmap_small_disabled (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

      Small bitmap of the new button when it is disabled. If left as null, then a bitmap will be automatically generated from bitmap_small.

    • kind (Wx::RibbonButtonKind) (defaults to: Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) —

      The kind of button to add.

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

      The UI help string to associate with the new button.

    Returns:

    • (Integer)

    See Also:



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

def insert_button(*args) end

#insert_dropdown_button(pos, button_id, label, bitmap, help_string = ('')) ⇒ Integer

Inserts a dropdown button to the button bar (simple version) at the given position.

Parameters:

  • pos (Integer)
  • button_id (Integer)
  • label (String)
  • bitmap (Wx::Bitmap)
  • help_string (String) (defaults to: (''))

Returns:

  • (Integer)

See Also:



245
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 245

def insert_dropdown_button(pos, button_id, label, bitmap, help_string=('')) end

#insert_hybrid_button(pos, button_id, label, bitmap, help_string = ('')) ⇒ Integer

Inserts a hybrid button to the button bar (simple version) at the given position.

Parameters:

  • pos (Integer)
  • button_id (Integer)
  • label (String)
  • bitmap (Wx::Bitmap)
  • help_string (String) (defaults to: (''))

Returns:

  • (Integer)

See Also:



261
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 261

def insert_hybrid_button(pos, button_id, label, bitmap, help_string=('')) end

#insert_toggle_button(pos, button_id, label, bitmap, help_string = ('')) ⇒ Integer

Inserts a toggle button to the button bar (simple version) at the given position.

Parameters:

  • pos (Integer)
  • button_id (Integer)
  • label (String)
  • bitmap (Wx::Bitmap)
  • help_string (String) (defaults to: (''))

Returns:

  • (Integer)

See Also:



277
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 277

def insert_toggle_button(pos, button_id, label, bitmap, help_string=('')) end

#items {|button_id| ... } ⇒ Object, Enumerator

Iterate button items if block given else return enumerator.

Yield Parameters:

  • button_id (Integer) —

    Id of a button item

Returns:

  • (Object, Enumerator) —

    result from last block execution or an enumerator



17
 
# File 'lib/wx/doc/rbn/ribbon_button_bar.rb', line 17

def items; end

#realize ⇒ Boolean

Calculate button layouts and positions.

Must be called after buttons are added to the button bar, as otherwise the newly added buttons will not be displayed. In normal situations, it will be called automatically when Wx::RBN::RibbonBar#realize is called.

Returns:

  • (Boolean) 


317
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 317

def realize; end

#set_button_icon(button_id, bitmap, bitmap_small = Wx::NULL_BITMAP, bitmap_disabled = Wx::NULL_BITMAP, bitmap_small_disabled = Wx::NULL_BITMAP) ⇒ void

This method returns an undefined value.

Changes the bitmap of an existing button.

Parameters:

  • button_id (Integer) —

    ID of the button to manipulate.

  • bitmap (Wx::Bitmap) —

    Large bitmap of the new button. Must be the same size as all other large bitmaps used on the button bar.

  • bitmap_small (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

    Small bitmap of the new button. If left as null, then a small bitmap will be automatically generated. Must be the same size as all other small bitmaps used on the button bar.

  • bitmap_disabled (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

    Large bitmap of the new button when it is disabled. If left as null, then a bitmap will be automatically generated from bitmap.

  • bitmap_small_disabled (Wx::Bitmap) (defaults to: Wx::NULL_BITMAP) —

    Small bitmap of the new button when it is disabled. If left as null, then a bitmap will be automatically generated from bitmap_small.



353
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 353

def set_button_icon(button_id, bitmap, bitmap_small=Wx::NULL_BITMAP, bitmap_disabled=Wx::NULL_BITMAP, bitmap_small_disabled=Wx::NULL_BITMAP) end

#set_button_max_size_class(button_id, max_size_class) ⇒ void

This method returns an undefined value.

Sets the maximum size class of a ribbon button.

You have to call #realize after calling this function to apply the given maximum size.

Parameters:



413
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 413

def set_button_max_size_class(button_id, max_size_class) end

#set_button_min_size_class(button_id, min_size_class) ⇒ void

This method returns an undefined value.

Sets the minimum size class of a ribbon button.

You have to call #realize after calling this function to apply the given minimum size.

Parameters:



405
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 405

def set_button_min_size_class(button_id, min_size_class) end

#set_button_text(button_id, label) ⇒ void

This method returns an undefined value.

Changes the label text of an existing button.

Remark:

If text size has changed, #realize must be called on the top level Wx::RBN::RibbonBar object to recalculate panel sizes. Use #set_button_text_min_width to avoid calling #realize after every change.

Parameters:

  • button_id (Integer) —

    ID of the button to manipulate.

  • label (String) —

    New label of the button.

See Also:

  • SetButtonTextMinWidth


366
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 366

def set_button_text(button_id, label) end

#set_button_text_min_width(button_id, min_width_medium, min_width_large) ⇒ void #set_button_text_min_width(button_id, label) ⇒ void

Overloads:

  • #set_button_text_min_width(button_id, min_width_medium, min_width_large) ⇒ void

    This method returns an undefined value.

    Sets the minimum width of the button label, to indicate to the Wx::RBN::RibbonArtProvider layout mechanism that this is the minimum required size.

    You have to call #realize after calling this function to apply the given minimum width.

    Remark:

    This function is used together with #set_button_text to change button labels on the fly without modifying the button bar layout.

    Parameters:

    • button_id (Integer) —

      ID of the button to manipulate.

    • min_width_medium (Integer) —

      Requested minimum width of the button text in pixel if the button is medium size.

    • min_width_large (Integer) —

      Requested minimum width of the button text in pixel if the button is large size.

    See Also:

  • #set_button_text_min_width(button_id, label) ⇒ void

    This method returns an undefined value.

    Sets the minimum width of the button label, to indicate to the Wx::RBN::RibbonArtProvider layout mechanism that this is the minimum required size.

    You have to call #realize after calling this function to apply the given minimum width.

    Remark:

    This function is used together with #set_button_text to change button labels on the fly without modifying the button bar layout.

    Parameters:

    • button_id (Integer) —

      ID of the button to manipulate.

    • label (String) —

      The minimum width is set to the width of this label.

    See Also:



397
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 397

def set_button_text_min_width(*args) end

#set_item_client_object(item, data) ⇒ void

This method returns an undefined value.

Set the client object associated with a button.

The button bar owns the given object and takes care of its deletion. Please, note that you cannot use both client object and client data.

Parameters:

  • item (Integer)
  • data (Object) 


290
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 290

def set_item_client_object(item, data) end

#set_show_tool_tips_for_disabled(show) ⇒ void Also known as: show_tool_tips_for_disabled=

This method returns an undefined value.

Indicates whether tooltips are shown for disabled buttons.

By default they are not shown.

Parameters:

  • show (Boolean) 


434
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 434

def set_show_tool_tips_for_disabled(show) end

#toggle_button(button_id, checked) ⇒ void

This method returns an undefined value.

Set a toggle button to the checked or unchecked state.

Parameters:

  • button_id (Integer) —

    ID of the toggle button to manipulate.

  • checked (Boolean) —

    true to set the button to the toggled/pressed/checked state, false to set it to the untoggled/unpressed/unchecked state.



344
 
# File 'lib/wx/doc/gen/rbn/ribbon_button_bar.rb', line 344

def toggle_button(button_id, checked) end