Class: Wx::RBN::RibbonToolBar
- Inherits:
-
RibbonControl
- Object
- Object
- EvtHandler
- Window
- Control
- RibbonControl
- Wx::RBN::RibbonToolBar
- Defined in:
- lib/wx/doc/gen/rbn/ribbon_tool_bar.rb,
lib/wx/doc/rbn/ribbon_tool_bar.rb
Overview
A ribbon tool bar is similar to a traditional toolbar which has no labels.
It contains one or more tool groups, each of which contains one or more tools. Each tool is represented by a (generally small, i.e. 16x15) bitmap.
Events emitted by this class
The following event-handler methods redirect the events to member method or handler blocks for RibbonToolBarEvent events. Event handler methods for events emitted by this class:
-
EvtHandler#evt_ribbontoolbar_clicked(id, meth = nil, &block): Triggered when the normal (non-dropdown) region of a tool on the tool bar is clicked.
-
EvtHandler#evt_ribbontoolbar_dropdown_clicked(id, meth = nil, &block): Triggered when the dropdown region of a tool on the tool bar is clicked. Wx::RBN::RibbonToolBarEvent#popup_menu should be called by the event handler if it wants to display a popup menu (which is what most dropdown tools should be doing).
Category: Ribbon User Interface
Instance Method Summary collapse
-
#add_dropdown_tool(tool_id, bitmap, help_string = ('')) ⇒ Integer
Add a dropdown tool to the tool bar (simple version).
-
#add_hybrid_tool(tool_id, bitmap, help_string = ('')) ⇒ Integer
Add a hybrid tool to the tool bar (simple version).
-
#add_separator ⇒ Integer
Add a separator to the tool bar.
-
#add_toggle_tool(tool_id, bitmap, help_string) ⇒ Integer
Add a toggle tool to the tool bar (simple version).
- #add_tool(*args) ⇒ Object
-
#clear_tools ⇒ void
Deletes all the tools in the toolbar.
-
#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Boolean
Create a tool bar in two-step tool bar construction.
-
#delete_tool(tool_id) ⇒ Boolean
Removes the specified tool from the toolbar and deletes it.
-
#delete_tool_by_pos(pos) ⇒ Boolean
This function behaves like #delete_tool but it deletes the tool at the specified position and not the one with the given id.
-
#enable_tool(tool_id, enable = true) ⇒ void
Enable or disable a single tool on the bar.
-
#get_active_tool ⇒ Integer
(also: #active_tool)
Returns the active item of the tool bar or nil if there is none.
-
#get_dropdown_key_tip(tool_id) ⇒ String
(also: #dropdown_key_tip)
Returns the dropdown KeyTip of the given tool, or an empty string.
-
#get_key_tip(tool_id) ⇒ String
(also: #key_tip)
Returns the KeyTip of the given tool, or an empty string.
- #get_tool_by_pos(*args) ⇒ Object (also: #tool_by_pos)
-
#get_tool_client_data(tool_id) ⇒ Object
(also: #tool_client_data)
Get any client data associated with the tool.
-
#get_tool_count ⇒ Integer
(also: #tool_count)
Returns the number of tools in the toolbar.
-
#get_tool_enabled(tool_id) ⇒ Boolean
(also: #tool_enabled)
Called to determine whether a tool is enabled (responds to user input).
-
#get_tool_help_string(tool_id) ⇒ String
(also: #tool_help_string)
Returns the help string for the given tool.
-
#get_tool_kind(tool_id) ⇒ Wx::RibbonButtonKind
(also: #tool_kind)
Return the kind of the given tool.
-
#get_tool_pos(tool_id) ⇒ Integer
(also: #tool_pos)
Returns the tool position in the toolbar, or NOT_FOUND if the tool is not found.
-
#get_tool_rect(tool_id) ⇒ Wx::Rect
(also: #tool_rect)
Returns the tool's rect with coordinates relative to the toolbar's parent, or a default-constructed rect if the tool is not found.
-
#get_tool_state(tool_id) ⇒ Boolean
(also: #tool_state)
Gets the on/off state of a toggle tool.
-
#initialize(*args) ⇒ RibbonToolBar
constructor
A new instance of RibbonToolBar.
-
#insert_dropdown_tool(pos, tool_id, bitmap, help_string = ('')) ⇒ Integer
Insert a dropdown tool to the tool bar (simple version) as the specified position.
-
#insert_hybrid_tool(pos, tool_id, bitmap, help_string = ('')) ⇒ Integer
Insert a hybrid tool to the tool bar (simple version) as the specified position.
-
#insert_separator(pos) ⇒ Integer
Insert a separator to the tool bar at the specified position.
-
#insert_toggle_tool(pos, tool_id, bitmap, help_string = ('')) ⇒ Integer
Insert a toggle tool to the tool bar (simple version) as the specified position.
- #insert_tool(*args) ⇒ Object
-
#realize ⇒ Boolean
Calculate tool layouts and positions.
-
#set_dropdown_key_tip(tool_id, keytip) ⇒ void
Assigns the KeyTip used to open a hybrid tool's dropdown menu.
-
#set_key_tip(tool_id, keytip) ⇒ void
Assigns the KeyTip used to click the given tool.
-
#set_rows(nMin, nMax = -1)) ⇒ void
(also: #rows=)
Set the number of rows to distribute tool groups over.
-
#set_tool_client_data(tool_id, clientData) ⇒ void
Sets the client data associated with the tool.
-
#set_tool_disabled_bitmap(tool_id, bitmap) ⇒ void
Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.
-
#set_tool_help_string(tool_id, helpString) ⇒ void
Sets the help string shown in tooltip for the given tool.
-
#set_tool_normal_bitmap(tool_id, bitmap) ⇒ void
Sets the bitmap to be used by the tool with the given ID.
-
#toggle_tool(tool_id, checked) ⇒ void
Set a toggle tool to the checked or unchecked state.
-
#tools {|tool_id| ... } ⇒ Object, Enumerator
Iterate tool items if block given or return enumerator.
Methods inherited from RibbonControl
#dismiss_key_tips, #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_prepare_update_window_ui, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_focus_from_keyboard, #enable_input_method, #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_cursor_bundle, #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_id_at_point, #get_help_text, #get_help_text_at_point, #get_id, #get_input_method_cursor_rect, #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_size_from_known_direction, #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_scrollbar_size, #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_input_method_enabled, #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_accessible_name, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_cursor_bundle, #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_input_method_cursor_rect, #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_minimize, #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_backstage_clicked, #evt_backstage_item_clicked, #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_label_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_label_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_webview_browsing_data_cleared, #evt_webview_created, #evt_webview_error, #evt_webview_fullscreen_changed, #evt_webview_loaded, #evt_webview_navigated, #evt_webview_navigating, #evt_webview_newwindow, #evt_webview_newwindow_features, #evt_webview_pdf_saved, #evt_webview_script_message_received, #evt_webview_script_result, #evt_webview_title_changed, #evt_webview_window_close_requested, #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, #make_shared, #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
Constructor Details
#initialize ⇒ Wx::RBN::RibbonToolBar #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Wx::RBN::RibbonToolBar #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) {|win| ... } ⇒ Wx::RBN::RibbonToolBar
Returns a new instance of RibbonToolBar.
58 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 58 def initialize(*args) end |
Instance Method Details
#add_dropdown_tool(tool_id, bitmap, help_string = ('')) ⇒ Integer
Add a dropdown tool to the tool bar (simple version).
103 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 103 def add_dropdown_tool(tool_id, bitmap, help_string=('')) end |
#add_hybrid_tool(tool_id, bitmap, help_string = ('')) ⇒ Integer
Add a hybrid tool to the tool bar (simple version).
113 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 113 def add_hybrid_tool(tool_id, bitmap, help_string=('')) end |
#add_separator ⇒ Integer
Add a separator to the tool bar.
Separators are used to separate tools into groups. As such, a separator is not explicitly drawn, but is visually seen as the gap between tool groups.
129 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 129 def add_separator; end |
#add_toggle_tool(tool_id, bitmap, help_string) ⇒ Integer
Add a toggle tool to the tool bar (simple version).
123 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 123 def add_toggle_tool(tool_id, bitmap, help_string) end |
#add_tool(tool_id, bitmap, help_string, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) ⇒ Integer #add_tool(tool_id, bitmap, bitmap_disabled = Wx::NULL_BITMAP, help_string = (''), kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, clientData = nil) ⇒ Integer
93 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 93 def add_tool(*args) end |
#clear_tools ⇒ void
This method returns an undefined value.
Deletes all the tools in the toolbar.
206 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 206 def clear_tools; end |
#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Boolean
Create a tool bar in two-step tool bar construction.
Should only be called when the default constructor is used, and arguments have the same meaning as in the full constructor.
69 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 69 def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0) end |
#delete_tool(tool_id) ⇒ Boolean
Removes the specified tool from the toolbar and deletes it.
true if the tool was deleted, false otherwise.
214 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 214 def delete_tool(tool_id) end |
#delete_tool_by_pos(pos) ⇒ Boolean
This function behaves like #delete_tool but it deletes the tool at the specified position and not the one with the given id.
Useful to delete separators.
221 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 221 def delete_tool_by_pos(pos) end |
#enable_tool(tool_id, enable = true) ⇒ void
This method returns an undefined value.
Enable or disable a single tool on the bar.
347 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 347 def enable_tool(tool_id, enable=true) end |
#get_active_tool ⇒ Integer Also known as: active_tool
Returns the active item of the tool bar or nil if there is none.
The active tool is the one being clicked.
248 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 248 def get_active_tool; end |
#get_dropdown_key_tip(tool_id) ⇒ String Also known as: dropdown_key_tip
Returns the dropdown KeyTip of the given tool, or an empty string.
381 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 381 def get_dropdown_key_tip(tool_id) end |
#get_key_tip(tool_id) ⇒ String Also known as: key_tip
Returns the KeyTip of the given tool, or an empty string.
367 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 367 def get_key_tip(tool_id) end |
#get_tool_by_pos(pos) ⇒ Integer #get_tool_by_pos(x, y) ⇒ Integer Also known as: tool_by_pos
236 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 236 def get_tool_by_pos(*args) end |
#get_tool_client_data(tool_id) ⇒ Object Also known as: tool_client_data
Get any client data associated with the tool.
Client data, or nil if there is none.
256 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 256 def get_tool_client_data(tool_id) end |
#get_tool_count ⇒ Integer Also known as: tool_count
Returns the number of tools in the toolbar.
241 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 241 def get_tool_count; end |
#get_tool_enabled(tool_id) ⇒ Boolean Also known as: tool_enabled
Called to determine whether a tool is enabled (responds to user input).
true if the tool is enabled, false otherwise.
265 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 265 def get_tool_enabled(tool_id) end |
#get_tool_help_string(tool_id) ⇒ String Also known as: tool_help_string
Returns the help string for the given tool.
271 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 271 def get_tool_help_string(tool_id) end |
#get_tool_kind(tool_id) ⇒ Wx::RibbonButtonKind Also known as: tool_kind
Return the kind of the given tool.
277 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 277 def get_tool_kind(tool_id) end |
#get_tool_pos(tool_id) ⇒ Integer Also known as: tool_pos
Returns the tool position in the toolbar, or NOT_FOUND if the tool is not found.
283 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 283 def get_tool_pos(tool_id) end |
#get_tool_rect(tool_id) ⇒ Wx::Rect Also known as: tool_rect
Returns the tool's rect with coordinates relative to the toolbar's parent, or a default-constructed rect if the tool is not found.
289 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 289 def get_tool_rect(tool_id) end |
#get_tool_state(tool_id) ⇒ Boolean Also known as: tool_state
Gets the on/off state of a toggle tool.
true if the tool is toggled on, false otherwise.
298 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 298 def get_tool_state(tool_id) end |
#insert_dropdown_tool(pos, tool_id, bitmap, help_string = ('')) ⇒ Integer
Insert a dropdown tool to the tool bar (simple version) as the specified position.
169 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 169 def insert_dropdown_tool(pos, tool_id, bitmap, help_string=('')) end |
#insert_hybrid_tool(pos, tool_id, bitmap, help_string = ('')) ⇒ Integer
Insert a hybrid tool to the tool bar (simple version) as the specified position.
181 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 181 def insert_hybrid_tool(pos, tool_id, bitmap, help_string=('')) end |
#insert_separator(pos) ⇒ Integer
Insert a separator to the tool bar at the specified position.
202 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 202 def insert_separator(pos) end |
#insert_toggle_tool(pos, tool_id, bitmap, help_string = ('')) ⇒ Integer
Insert a toggle tool to the tool bar (simple version) as the specified position.
193 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 193 def insert_toggle_tool(pos, tool_id, bitmap, help_string=('')) end |
#insert_tool(pos, tool_id, bitmap, help_string, kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL) ⇒ Integer #insert_tool(pos, tool_id, bitmap, bitmap_disabled = Wx::NULL_BITMAP, help_string = (''), kind = Wx::RBN::RibbonButtonKind::RIBBON_BUTTON_NORMAL, clientData = nil) ⇒ Integer
157 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 157 def insert_tool(*args) end |
#realize ⇒ Boolean
Calculate tool layouts and positions.
Must be called after tools are added to the tool bar, as otherwise the newly added tools will not be displayed.
305 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 305 def realize; end |
#set_dropdown_key_tip(tool_id, keytip) ⇒ void
This method returns an undefined value.
Assigns the KeyTip used to open a hybrid tool's dropdown menu.
This is separate from the KeyTip of the tool's main click area, set by #set_key_tip, and has no effect on non-hybrid tools.
376 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 376 def set_dropdown_key_tip(tool_id, keytip) end |
#set_key_tip(tool_id, keytip) ⇒ void
This method returns an undefined value.
Assigns the KeyTip used to click the given tool.
Pass an empty string to remove it. The KeyTip is stored uppercased. Disabled tools don't show a KeyTip.
362 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 362 def set_key_tip(tool_id, keytip) end |
#set_rows(nMin, nMax = -1)) ⇒ void Also known as: rows=
This method returns an undefined value.
Set the number of rows to distribute tool groups over.
Tool groups can be distributed over a variable number of rows. The way in which groups are assigned to rows is not specified, and the order of groups may change, but they will be distributed in such a way as to minimise the overall size of the tool bar.
313 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 313 def set_rows(nMin, nMax=-1) end |
#set_tool_client_data(tool_id, clientData) ⇒ void
This method returns an undefined value.
Sets the client data associated with the tool.
320 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 320 def set_tool_client_data(tool_id, clientData) end |
#set_tool_disabled_bitmap(tool_id, bitmap) ⇒ void
This method returns an undefined value.
Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.
326 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 326 def set_tool_disabled_bitmap(tool_id, bitmap) end |
#set_tool_help_string(tool_id, helpString) ⇒ void
This method returns an undefined value.
Sets the help string shown in tooltip for the given tool.
335 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 335 def set_tool_help_string(tool_id, helpString) end |
#set_tool_normal_bitmap(tool_id, bitmap) ⇒ void
This method returns an undefined value.
Sets the bitmap to be used by the tool with the given ID.
341 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 341 def set_tool_normal_bitmap(tool_id, bitmap) end |
#toggle_tool(tool_id, checked) ⇒ void
This method returns an undefined value.
Set a toggle tool to the checked or unchecked state.
353 |
# File 'lib/wx/doc/gen/rbn/ribbon_tool_bar.rb', line 353 def toggle_tool(tool_id, checked) end |
#tools {|tool_id| ... } ⇒ Object, Enumerator
Iterate tool items if block given or return enumerator.
17 |
# File 'lib/wx/doc/rbn/ribbon_tool_bar.rb', line 17 def tools; end |