Class: Wx::MenuBar

Inherits:

Window

• Object
• Object
• EvtHandler
• Window
• Wx::MenuBar

Defined in:

lib/wx/doc/gen/menu_bar.rb

Overview

A menu bar is a series of menus accessible from the top of a frame.

Remark:

To respond to a menu selection, provide a handler for EVT_MENU, in the frame that contains the menu bar.

If you have a toolbar which uses the same identifiers as your EVT_MENU entries, events from the toolbar will also be processed by your EVT_MENU event handlers. Tip: under Windows, if you discover that menu shortcuts (for example, Alt-F to show the file menu) are not working, check any EVT_CHAR events you are handling in child windows. If you are not calling event.Skip() for events that you don’t process in these event handlers, menu shortcuts may cease to work.

Category: Menus

See Also:

• Menu
• and Event Handling

Requires:

• USE_MENUBAR

Class Method Summary

• .mac_get_common_menu_bar ⇒ Wx::MenuBar

  Enables you to get the global menubar on Mac, that is, the menubar displayed when the app is running without any frames open.

• .mac_set_common_menu_bar(menubar) ⇒ void

  Enables you to set the global menubar on Mac, that is, the menubar displayed when the app is running without any frames open.

Instance Method Summary

• #append(menu, title) ⇒ Boolean

  Adds the item to the end of the menu bar.

• #attach(frame) ⇒ void
• #check(id, check) ⇒ void

  Checks or unchecks a menu item.

• #detach ⇒ void
• #enable(id, enable) ⇒ void

  Enables or disables (greys out) a menu item.

• #enable_top(pos, enable) ⇒ void

  Enables or disables a whole menu.

• #find_item(id) ⇒ Array(Wx::MenuItem,Wx::Menu)

  Finds the menu item object associated with the given menu item identifier.

• #find_menu(title) ⇒ Integer

  Returns the index of the menu with the given title or NOT_FOUND if no such menu exists in this menubar.

• #find_menu_item(menuString, itemString) ⇒ Integer

  Finds the menu item id for a menu name/menu item string pair.

• #get_frame ⇒ Wx::Frame (also: #frame)
• #get_help_string(id) ⇒ String (also: #help_string)

  Gets the help string associated with the menu item identifier.

• #get_label(id) ⇒ String (also: #label)

  Gets the label associated with a menu item.

• #get_menu(menuIndex) ⇒ Wx::Menu (also: #menu)

  Returns the menu at menuIndex (zero-based).

• #get_menu_count ⇒ Integer (also: #menu_count)

  Returns the number of menus in this menubar.

• #get_menu_label(pos) ⇒ String (also: #menu_label)

  Returns the label of a top-level menu.

• #get_menu_label_text(pos) ⇒ String (also: #menu_label_text)

  Returns the label of a top-level menu.

• #initialize(style = 0) ⇒ Wx::MenuBar constructor

  Construct an empty menu bar.

• #insert(pos, menu, title) ⇒ Boolean

  Inserts the menu at the given position into the menu bar.

• #is_attached ⇒ Boolean (also: #attached?)
• #is_checked(id) ⇒ Boolean (also: #checked?)

  Determines whether an item is checked.

• #is_enabled(id) ⇒ Boolean (also: #enabled?)

  Determines whether an item is enabled.

• #is_enabled_top(pos) ⇒ Boolean (also: #enabled_top?)

  Returns true if the menu with the given index is enabled.

• #osx_get_apple_menu ⇒ Wx::Menu

  Returns the Apple menu.

• #remove(pos) ⇒ Wx::Menu

  Removes the menu from the menu bar and returns the menu object - the caller is responsible for deleting it.

• #replace(pos, menu, title) ⇒ Wx::Menu

  Replaces the menu at the given position with another one.

• #set_help_string(id, helpString) ⇒ void

  Sets the help string associated with a menu item.

• #set_label(id, label) ⇒ void

  Sets the label of a menu item.

• #set_menu_label(pos, label) ⇒ void

  Sets the label of a top-level menu.

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, #create, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_update_window_ui, #drag_accept_files, #each_child, #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_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_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_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(style = 0) ⇒ Wx::MenuBar

Construct an empty menu bar.

Parameters:

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

  If Wx::MB_DOCKABLE the menu bar can be detached (WXGTK only).

# File 'lib/wx/doc/gen/menu_bar.rb', line 31

def initialize(style=0) end

Class Method Details

.mac_get_common_menu_bar ⇒ Wx::MenuBar

Enables you to get the global menubar on Mac, that is, the menubar displayed when the app is running without any frames open.

The global menubar.

Remark:

Only exists on Mac, other platforms do not have this method.

Availability: only available for the WXOSX/Cocoa port.

Returns:

• (Wx::MenuBar)

Requires:

• WXOSX

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

def self.mac_get_common_menu_bar; end

.mac_set_common_menu_bar(menubar) ⇒ void

This method returns an undefined value.

Enables you to set the global menubar on Mac, that is, the menubar displayed when the app is running without any frames open.

Remark:

Only exists on Mac, other platforms do not have this method.

Availability: only available for the WXOSX/Cocoa port.

Parameters:

• menubar (Wx::MenuBar) —

  The menubar to set.

Requires:

• WXOSX

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

def self.mac_set_common_menu_bar(menubar) end

Instance Method Details

#append(menu, title) ⇒ Boolean

Adds the item to the end of the menu bar.

true on success, false if an error occurred.

Parameters:

• menu (Wx::Menu) —

  The menu to add. Do not deallocate this menu after calling #append.

• title (String) —

  The title of the menu, must be non-empty.

Returns:

• (Boolean)

See Also:

• #insert

# File 'lib/wx/doc/gen/menu_bar.rb', line 40

def append(menu, title) end

#attach(frame) ⇒ void

This method returns an undefined value.

Parameters:

• frame (Wx::Frame)

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

def attach(frame) end

#check(id, check) ⇒ void

This method returns an undefined value.

Checks or unchecks a menu item.

Remark:

Only use this when the menu bar has been associated with a frame; otherwise, use the Wx::Menu equivalent call.

Parameters:

• id (Integer) —

  The menu item identifier.

• check (Boolean) —

  If true, checks the menu item, otherwise the item is unchecked.

# File 'lib/wx/doc/gen/menu_bar.rb', line 52

def check(id, check) end

#detach ⇒ void

This method returns an undefined value.

# File 'lib/wx/doc/gen/menu_bar.rb', line 284

def detach; end

#enable(id, enable) ⇒ void

This method returns an undefined value.

Enables or disables (greys out) a menu item.

Remark:

Only use this when the menu bar has been associated with a frame; otherwise, use the Wx::Menu equivalent call.

Parameters:

• id (Integer) —

  The menu item identifier.

• enable (Boolean) —

  true to enable the item, false to disable it.

# File 'lib/wx/doc/gen/menu_bar.rb', line 64

def enable(id, enable) end

#enable_top(pos, enable) ⇒ void

This method returns an undefined value.

Enables or disables a whole menu.

Remark:

Only use this when the menu bar has been associated with a frame.

Parameters:

• pos (Integer) —

  The position of the menu, starting from zero.

• enable (Boolean) —

  true to enable the menu, false to disable it.

# File 'lib/wx/doc/gen/menu_bar.rb', line 82

def enable_top(pos, enable) end

#find_item(id) ⇒ Array(Wx::MenuItem,Wx::Menu)

Finds the menu item object associated with the given menu item identifier.

The found menu item object, or NULL if one was not found.

Parameters:

• id (Integer) —

  Menu item identifier.

Returns:

• (Array(Wx::MenuItem,Wx::Menu))

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

def find_item(id) end

#find_menu(title) ⇒ Integer

Returns the index of the menu with the given title or NOT_FOUND if no such menu exists in this menubar.

The title parameter may specify either the menu title (with accelerator characters, i.e. "&File") or just the menu label ("File") indifferently.

Parameters:

• title (String)

Returns:

• (Integer)

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

def find_menu(title) end

#find_menu_item(menuString, itemString) ⇒ Integer

Finds the menu item id for a menu name/menu item string pair.

The menu item identifier, or NOT_FOUND if none was found.

Remark:

Any special menu codes are stripped out of source and target strings before matching.

Parameters:

• menuString (String) —

  Menu title to find.

• itemString (String) —

  Item to find.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/menu_bar.rb', line 110

def find_menu_item(menuString, itemString) end

#get_frame ⇒ Wx::Frame Also known as: frame

Returns:

• (Wx::Frame)

# File 'lib/wx/doc/gen/menu_bar.rb', line 272

def get_frame; end

#get_help_string(id) ⇒ String Also known as: help_string

Gets the help string associated with the menu item identifier.

The help string, or the empty string if there was no help string or the menu item was not found.

Parameters:

• id (Integer) —

  The menu item identifier.

Returns:

• (String)

See Also:

• #set_help_string

# File 'lib/wx/doc/gen/menu_bar.rb', line 118

def get_help_string(id) end

#get_label(id) ⇒ String Also known as: label

Gets the label associated with a menu item.

The menu item label, or the empty string if the item was not found.

Remark:

Use only after the menubar has been associated with a frame.

Parameters:

• id (Integer) —

  The menu item identifier.

Returns:

• (String)

# File 'lib/wx/doc/gen/menu_bar.rb', line 132

def get_label(id) end

#get_menu(menuIndex) ⇒ Wx::Menu Also known as: menu

Returns the menu at menuIndex (zero-based).

Parameters:

• menuIndex (Integer)

Returns:

• (Wx::Menu)

# File 'lib/wx/doc/gen/menu_bar.rb', line 138

def get_menu(menuIndex) end

#get_menu_count ⇒ Integer Also known as: menu_count

Returns the number of menus in this menubar.

Returns:

• (Integer)

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

def get_menu_count; end

#get_menu_label(pos) ⇒ String Also known as: menu_label

Returns the label of a top-level menu.

Note that the returned string includes the accelerator characters that have been specified in the menu title string during its construction.

The menu label, or the empty string if the menu was not found.

Remark:

Use only after the menubar has been associated with a frame.

Parameters:

• pos (Integer) —

  Position of the menu on the menu bar, starting from zero.

Returns:

• (String)

See Also:

• #get_menu_label_text
• #set_menu_label

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

def get_menu_label(pos) end

#get_menu_label_text(pos) ⇒ String Also known as: menu_label_text

Returns the label of a top-level menu.

Note that the returned string does not include any accelerator characters that may have been specified in the menu title string during its construction.

The menu label, or the empty string if the menu was not found.

Remark:

Use only after the menubar has been associated with a frame.

Parameters:

• pos (Integer) —

  Position of the menu on the menu bar, starting from zero.

Returns:

• (String)

See Also:

• #get_menu_label
• #set_menu_label

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

def get_menu_label_text(pos) end

#insert(pos, menu, title) ⇒ Boolean

Inserts the menu at the given position into the menu bar.

Inserting menu at position 0 will insert it in the very beginning of it, inserting at position #get_menu_count is the same as calling #append.

true on success, false if an error occurred.

Parameters:

• pos (Integer) —

  The position of the new menu in the menu bar

• menu (Wx::Menu) —

  The menu to add. Wx::MenuBar owns the menu and will free it.

• title (String) —

  The title of the menu.

Returns:

• (Boolean)

See Also:

• #append

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

def insert(pos, menu, title) end

#is_attached ⇒ Boolean Also known as: attached?

Returns:

• (Boolean)

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

def is_attached; end

#is_checked(id) ⇒ Boolean Also known as: checked?

Determines whether an item is checked.

true if the item was found and is checked, false otherwise.

Parameters:

• id (Integer) —

  The menu item identifier.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/menu_bar.rb', line 199

def is_checked(id) end

#is_enabled(id) ⇒ Boolean Also known as: enabled?

Determines whether an item is enabled.

true if the item was found and is enabled, false otherwise.

Parameters:

• id (Integer) —

  The menu item identifier.

Returns:

• (Boolean)

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

def is_enabled(id) end

#is_enabled_top(pos) ⇒ Boolean Also known as: enabled_top?

Returns true if the menu with the given index is enabled.

Parameters:

• pos (Integer) —

  The menu position (0-based)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/menu_bar.rb', line 69

def is_enabled_top(pos) end

#osx_get_apple_menu ⇒ Wx::Menu

Returns the Apple menu.

This is the leftmost menu with application’s name as its title. You shouldn’t remove any items from it, but it is safe to insert extra menu items or submenus into it. Availability: only available for the WXOSX/Cocoa port.

Returns:

• (Wx::Menu)

Requires:

• WXOSX

# File 'lib/wx/doc/gen/menu_bar.rb', line 269

def osx_get_apple_menu; end

#remove(pos) ⇒ Wx::Menu

Removes the menu from the menu bar and returns the menu object - the caller is responsible for deleting it.

This function may be used together with #insert to change the menubar dynamically.

Parameters:

• pos (Integer)

Returns:

• (Wx::Menu)

See Also:

• #replace

# File 'lib/wx/doc/gen/menu_bar.rb', line 216

def remove(pos) end

#replace(pos, menu, title) ⇒ Wx::Menu

Replaces the menu at the given position with another one.

The menu which was previously at position pos. The caller is responsible for deleting it.

Parameters:

• pos (Integer) —

  The position of the new menu in the menu bar

• menu (Wx::Menu) —

  The menu to add.

• title (String) —

  The title of the menu.

Returns:

• (Wx::Menu)

See Also:

• #insert
• #remove

# File 'lib/wx/doc/gen/menu_bar.rb', line 227

def replace(pos, menu, title) end

#set_help_string(id, helpString) ⇒ void

This method returns an undefined value.

Sets the help string associated with a menu item.

Parameters:

• id (Integer) —

  Menu item identifier.

• helpString (String) —

  Help string to associate with the menu item.

See Also:

• #get_help_string

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

def set_help_string(id, helpString) end

#set_label(id, label) ⇒ void

This method returns an undefined value.

Sets the label of a menu item.

Remark:

Use only after the menubar has been associated with a frame.

Parameters:

• id (Integer) —

  Menu item identifier.

• label (String) —

  Menu item label.

See Also:

• #get_label

# File 'lib/wx/doc/gen/menu_bar.rb', line 249

def set_label(id, label) end

#set_menu_label(pos, label) ⇒ void

This method returns an undefined value.

Sets the label of a top-level menu.

Remark:

Use only after the menubar has been associated with a frame.

Parameters:

• pos (Integer) —

  The position of a menu on the menu bar, starting from zero.

• label (String) —

  The menu label.

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

def set_menu_label(pos, label) end