Class: Wx::RBN::RibbonGallery

Inherits:

RibbonControl

• Object
• Object
• EvtHandler
• Window
• Control
• RibbonControl
• Wx::RBN::RibbonGallery

Defined in:

lib/wx/doc/gen/rbn/ribbon_gallery.rb,
lib/wx/doc/rbn/ribbon_gallery.rb

Overview

A ribbon gallery is like a ListBox, but for bitmaps rather than strings.

It displays a collection of bitmaps arranged in a grid and allows the user to choose one. As there are typically more bitmaps in a gallery than can be displayed in the space used for a ribbon, a gallery always has scroll buttons to allow the user to navigate through the entire gallery. It also has an "extension" button, the behaviour of which is outside the scope of the gallery control itself, though it typically displays some kind of dialog related to the gallery.

Events emitted by this class

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

• EvtHandler#evt_ribbongallery_selected(id, meth = nil, &block): Triggered when the user selects an item from the gallery. Note that the ID is that of the gallery, not of the item.

• EvtHandler#evt_ribbongallery_clicked(id, meth = nil, &block): Similar to EVT_RIBBONGALLERY_SELECTED but triggered every time a gallery item is clicked, even if it is already selected. Note that the ID of the event is that of the gallery, not of the item, just as above. This event is available since wxWidgets 2.9.2.

• EvtHandler#evt_ribbongallery_hover_changed(id, meth = nil, &block): Triggered when the item being hovered over by the user changes. The item in the event will be the new item being hovered, or nil if there is no longer an item being hovered. Note that the ID is that of the gallery, not of the item.

Events emitted by this class

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

• EvtHandler#evt_button(id, meth = nil, &block): Triggered when the "extension" button of the gallery is pressed.

Category: Ribbon User Interface

Requires:

• USE_RIBBON

Instance Method Summary

• #append(*args) ⇒ Object
• #clear ⇒ void

  Remove all items from the gallery.

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

  Create a gallery in two-step gallery construction.

• #ensure_visible(item) ⇒ void

  Scroll the gallery to ensure that the given item is visible.

• #get_active_item ⇒ Integer (also: #active_item)

  Get the currently active item, or nil if there is none.

• #get_count ⇒ Integer (also: #count)

  Get the number of items in the gallery.

• #get_down_button_state ⇒ Wx::RibbonGalleryButtonState (also: #down_button_state)

  Get the state of the scroll down button.

• #get_extension_button_state ⇒ Wx::RibbonGalleryButtonState (also: #extension_button_state)

  Get the state of the "extension" button.

• #get_hovered_item ⇒ Integer (also: #hovered_item)

  Get the currently hovered item, or nil if there is none.

• #get_item(n) ⇒ Integer (also: #item)

  Get an item by index.

• #get_item_client_object(item) ⇒ Object (also: #item_client_object)

  Get the client object associated with a gallery item.

• #get_item_label(item) ⇒ String (also: #item_label)

  Return the label of a gallery item.

• #get_key_tip ⇒ String (also: #key_tip)

  Returns the KeyTip of this gallery, or an empty string.

• #get_selection ⇒ Integer (also: #selection)

  Get the currently selected item, or nil if there is none.

• #get_up_button_state ⇒ Wx::RibbonGalleryButtonState (also: #up_button_state)

  Get the state of the scroll up button.

• #initialize(*args) ⇒ RibbonGallery constructor

  A new instance of RibbonGallery.

• #is_empty ⇒ Boolean (also: #empty?)

  Query if the gallery has no items in it.

• #is_hovered ⇒ Boolean (also: #hovered?)

  Query is the mouse is currently hovered over the gallery.

• #items {|index| ... } ⇒ Object, Enumerator

  Iterate gallery items if block given else return enumerator.

• #scroll_lines(lines) ⇒ Boolean

  Scroll the gallery contents by some amount.

• #scroll_pixels(pixels) ⇒ Boolean

  Scroll the gallery contents by some fine-grained amount.

• #set_item_client_object(item, data) ⇒ void

  Set the client object associated with a gallery item.

• #set_item_label(item, label) ⇒ void

  Set the label of a gallery item.

• #set_key_tip(keytip) ⇒ void (also: #key_tip=)

  Assigns the KeyTip used to reach this gallery.

• #set_selection(item) ⇒ void (also: #selection=)

  Set the selection to the given item, or removes the selection if item == nil.

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, #realize, #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_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::RibbonGallery #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Wx::RBN::RibbonGallery #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) {|win| ... } ⇒ Wx::RBN::RibbonGallery

Returns a new instance of RibbonGallery.

Overloads:

• #initialize ⇒ Wx::RBN::RibbonGallery

  Default constructor.

  With this constructor, #create should be called in order to create the gallery.
• #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) ⇒ Wx::RBN::RibbonGallery

  Construct a ribbon gallery with the given parameters.

  Parameters:

  • parent (Wx::Window) —

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

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

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

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

    Initial position of the gallery.

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

    Initial size of the gallery.

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

    Gallery style, currently unused.

• #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0) {|win| ... } ⇒ Wx::RBN::RibbonGallery

  Construct a ribbon gallery with the given parameters.

  Parameters:

  • parent (Wx::Window) —

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

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

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

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

    Initial position of the gallery.

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

    Initial size of the gallery.

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

    Gallery style, currently unused.

  Yield Parameters:

  • win (Wx::RBN::RibbonGallery) —

    new instance

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 96

def initialize(*args) end

Instance Method Details

#append(bitmap, id) ⇒ Integer #append(bitmap, id, label) ⇒ Integer #append(bitmap, id, clientData) ⇒ Integer

Overloads:

• #append(bitmap, id) ⇒ Integer

  Add an item to the gallery (with no client data).

  Parameters:

  • bitmap (Wx::Bitmap) —

    The bitmap to display for the item. Note that all items must have equally sized bitmaps.

  • id (Integer) —

    ID number to associate with the item. Not currently used for anything important.

  Returns:

  • (Integer)
• #append(bitmap, id, label) ⇒ Integer

  Add an item to the gallery with a label.

  The label is not shown in the gallery itself, but it is used as the accessible name of the item, allowing the screen readers to announce it, so it is recommended to specify it for all the items.

  Parameters:

  • bitmap (Wx::Bitmap) —

    The bitmap to display for the item. Note that all items must have equally sized bitmaps.

  • id (Integer) —

    ID number to associate with the item. Not currently used for anything important.

  • label (String) —

    The label of the item.

  Returns:

  • (Integer)
• #append(bitmap, id, clientData) ⇒ Integer

  Add an item to the gallery (with complex client data).

  Parameters:

  • bitmap (Wx::Bitmap) —

    The bitmap to display for the item. Note that all items must have equally sized bitmaps.

  • id (Integer) —

    ID number to associate with the item. Not currently used for anything important.

  • clientData (Object) —

    An object which contains data to associate with the item. The item takes ownership of this pointer, and will delete it when the item client data is changed to something else, or when the item is destroyed.

  Returns:

  • (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 148

def append(*args) end

#clear ⇒ void

This method returns an undefined value.

Remove all items from the gallery.

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 111

def clear; end

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

Create a gallery in two-step gallery 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)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 107

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

#ensure_visible(item) ⇒ void

This method returns an undefined value.

Scroll the gallery to ensure that the given item is visible.

Parameters:

• item (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 244

def ensure_visible(item) end

#get_active_item ⇒ Integer Also known as: active_item

Get the currently active item, or nil if there is none.

The active item is the item being pressed by the user, and will thus become the selected item if the user releases the mouse button.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 202

def get_active_item; end

#get_count ⇒ Integer Also known as: count

Get the number of items in the gallery.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 120

def get_count; end

#get_down_button_state ⇒ Wx::RibbonGalleryButtonState Also known as: down_button_state

Get the state of the scroll down button.

Returns:

• (Wx::RibbonGalleryButtonState)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 212

def get_down_button_state; end

#get_extension_button_state ⇒ Wx::RibbonGalleryButtonState Also known as: extension_button_state

Get the state of the "extension" button.

Returns:

• (Wx::RibbonGalleryButtonState)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 217

def get_extension_button_state; end

#get_hovered_item ⇒ Integer Also known as: hovered_item

Get the currently hovered item, or nil if there is none.

The hovered item is the item underneath the mouse cursor.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 195

def get_hovered_item; end

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

Get an item by index.

Parameters:

• n (Integer)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 126

def get_item(n) end

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

Get the client object associated with a gallery item.

Parameters:

• item (Integer)

Returns:

• (Object)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 173

def get_item_client_object(item) end

#get_item_label(item) ⇒ String Also known as: item_label

Return the label of a gallery item.

Parameters:

• item (Integer)

Returns:

• (String)

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

def get_item_label(item) end

#get_key_tip ⇒ String Also known as: key_tip

Returns the KeyTip of this gallery, or an empty string.

Returns:

• (String)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 258

def get_key_tip; end

#get_selection ⇒ Integer Also known as: selection

Get the currently selected item, or nil if there is none.

The selected item is set by #set_selection, or by the user clicking on an item.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 188

def get_selection; end

#get_up_button_state ⇒ Wx::RibbonGalleryButtonState Also known as: up_button_state

Get the state of the scroll up button.

Returns:

• (Wx::RibbonGalleryButtonState)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 207

def get_up_button_state; end

#is_empty ⇒ Boolean Also known as: empty?

Query if the gallery has no items in it.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 115

def is_empty; end

#is_hovered ⇒ Boolean Also known as: hovered?

Query is the mouse is currently hovered over the gallery.

true if the cursor is within the bounds of the gallery (not just hovering over an item), false otherwise.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 224

def is_hovered; end

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

Iterate gallery items if block given else return enumerator.

Yield Parameters:

• index (Integer) —

  Gallery item index

Returns:

• (Object, Enumerator) —

  result from last block execution or an enumerator

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

def items; end

#scroll_lines(lines) ⇒ Boolean

Scroll the gallery contents by some amount.

true if the gallery scrolled at least one pixel in the given direction, false if it did not scroll.

Parameters:

• lines (Integer) —

  Positive values scroll toward the end of the gallery, while negative values scroll toward the start.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 232

def scroll_lines(lines) end

#scroll_pixels(pixels) ⇒ Boolean

Scroll the gallery contents by some fine-grained amount.

true if the gallery scrolled at least one pixel in the given direction, false if it did not scroll.

Parameters:

• pixels (Integer) —

  Positive values scroll toward the end of the gallery, while negative values scroll toward the start.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 239

def scroll_pixels(pixels) end

#set_item_client_object(item, data) ⇒ void

This method returns an undefined value.

Set the client object associated with a gallery item.

Parameters:

• item (Integer)
• data (Object)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 168

def set_item_client_object(item, data) end

#set_item_label(item, label) ⇒ void

This method returns an undefined value.

Set the label of a gallery item.

See #append for the description of the label.

Parameters:

• item (Integer)
• label (String)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 156

def set_item_label(item, label) end

#set_key_tip(keytip) ⇒ void Also known as: key_tip=

This method returns an undefined value.

Assigns the KeyTip used to reach this gallery.

The gallery is one KeyTip target as a whole, its items don't get their own. Activating it gives the gallery focus, so that the arrow keys and Enter can then be used to pick an item. Pass an empty string to remove it. The KeyTip is stored upper-cased.

Parameters:

• keytip (String)

See Also:

• Wx::RBN::RibbonBar#show_key_tips

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 253

def set_key_tip(keytip) end

#set_selection(item) ⇒ void Also known as: selection=

This method returns an undefined value.

Set the selection to the given item, or removes the selection if item == nil.

Note that this not cause any events to be emitted.

Parameters:

• item (Integer)

# File 'lib/wx/doc/gen/rbn/ribbon_gallery.rb', line 181

def set_selection(item) end