Class: Wx::Frame

Inherits:
TopLevelWindow show all
Defined in:
lib/wx/doc/gen/frame.rb

Overview

A frame is a window whose size and position can (usually) be changed by the user.

It usually has thick borders and a title bar, and can optionally contain a menu bar, toolbar and status bar. A frame can contain any window that is not a frame or dialog. A frame that has a status bar and toolbar, created via the #create_status_bar and #create_tool_bar functions, manages these windows and adjusts the value returned by Window#get_client_size to reflect the remaining size available to application windows. If a frame is to be used as an input form, the controls should not be created as its children. Instead, a Panel should be created as the sole child of the frame, serving as the parent of the actual controls (the frame will size the panel so it always fills its client area). Doing this will ensure that tabbing between the controls works and the frame background has the expected colour. Moreover, as a frame is by default resizable, it could be better to use ScrolledWindow instead of Panel, to make sure the controls are easily accessible regardless of the frame size. However, please consider whether it would not be better to use Dialog instead of Frame, where using a panel like this is not needed and Dialog also offers other benefits such as creating specialized sizers (e.g., for buttons, with their platform-correct order).

Remark:

An application should normally define a CloseEvent handler for the frame to respond to system close events, for example so that related data and subwindows can be cleaned up.

Default event processing

Frame processes the following events:

  • EVT_SIZE: if the frame has exactly one child window, not counting the status and toolbar, this child is resized to take the entire frame client area. If two or more windows are present, they should be laid out explicitly either by manually handling EVT_SIZE or using sizers;

  • EVT_MENU_HIGHLIGHT: the default implementation displays the help string associated with the selected item in the first pane of the status bar, if there is one.

Styles

This class supports the following styles:

  • DEFAULT_FRAME_STYLE: Defined as MINIMIZE_BOX | MAXIMIZE_BOX | RESIZE_BORDER | SYSTEM_MENU | CAPTION | CLOSE_BOX | CLIP_CHILDREN.

  • ICONIZE: Display the frame iconized (minimized). Windows only.

  • CAPTION: Puts a caption on the frame. Notice that this flag is required by MINIMIZE_BOX, MAXIMIZE_BOX and CLOSE_BOX on most systems as the corresponding buttons cannot be shown if the window has no title bar at all. I.e. if CAPTION is not specified those styles would be simply ignored.

  • MINIMIZE: Identical to ICONIZE. Windows only.

  • MINIMIZE_BOX: Displays a minimize box on the frame.

  • MAXIMIZE: Displays the frame maximized. Windows and GTK+ only.

  • MAXIMIZE_BOX: Displays a maximize box on the frame. Notice that under WXGTK RESIZE_BORDER must be used as well or this style is ignored.

  • CLOSE_BOX: Displays a close box on the frame.

  • STAY_ON_TOP: Stay on top of all other windows, see also FRAME_FLOAT_ON_PARENT.

  • SYSTEM_MENU: Displays a system menu containing the list of various windows commands in the window title bar. Unlike MINIMIZE_BOX, MAXIMIZE_BOX and CLOSE_BOX styles this style can be used without CAPTION, at least under Windows, and makes the system menu available without showing it on screen in this case. However it is recommended to only use it together with CAPTION for consistent behaviour under all platforms.

  • RESIZE_BORDER: Displays a resizable border around the window.

  • FRAME_TOOL_WINDOW: Causes a frame with a small title bar to be created; the frame does not appear in the taskbar under Windows or GTK+.

  • FRAME_NO_TASKBAR: Creates an otherwise normal frame but it does not appear in the taskbar under Windows or GTK+ (note that it will minimize to the desktop window under Windows which may seem strange to the users and thus it might be better to use this style only without MINIMIZE_BOX style). In WXGTK, the flag is respected only if the window manager supports _NET_WM_STATE_SKIP_TASKBAR hint.

  • FRAME_FLOAT_ON_PARENT: The frame will always be on top of its parent (unlike STAY_ON_TOP). A frame created with this style must have a non-NULL parent.

  • FRAME_SHAPED: Windows with this style are allowed to have their shape changed with the NonOwnedWindow#set_shape method.

The default frame style is for normal, resizable frames. To create a frame which cannot be resized by user, you may use the following combination of styles:

Wx::DEFAULT_FRAME_STYLE & ~(Wx::RESIZE_BORDER | Wx::MAXIMIZE_BOX)

See also the Window Styles.

Extra Styles

This class supports the following extra styles:

  • FRAME_EX_CONTEXTHELP: Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a EVT_HELP event if the user clicked on an application window. Note that this is an extended style and must be set by calling SetExtraStyle before Create is called (two-step construction). You cannot use this style together with MAXIMIZE_BOX or MINIMIZE_BOX, so you should use DEFAULT_FRAME_STYLE ~ (MINIMIZE_BOX | MAXIMIZE_BOX) for the frames having this style (the dialogs don't have a minimize or a maximize box by default)

  • FRAME_EX_METAL: On macOS, frames with this style will be shown with a metallic look. This is an extra style.

Events emitted by this class

Event handler methods for events emitted by this class:

Category: Managed Windows

See Also:

Instance Method Summary collapse

Methods inherited from TopLevelWindow

#can_set_transparent, #center_on_screen, #centre_on_screen, #create_persistent_object, #enable_close_button, #enable_full_screen_view, #enable_maximize_button, #enable_minimize_button, #get_content_protection, #get_default_item, get_default_size, #get_icon, #get_icons, #get_title, #get_tmp_default_item, #iconize, #is_active, #is_always_maximized, #is_full_screen, #is_iconized, #is_maximized, #layout, #maximize, #msw_get_system_menu, #osx_is_modified, #osx_set_modified, #request_user_attention, #restore, #set_content_protection, #set_default_item, #set_icon, #set_icons, #set_max_size, #set_min_size, #set_represented_filename, #set_size_hints, #set_title, #set_tmp_default_item, #set_transparent, #should_prevent_app_exit, #show_full_screen, #show_without_activating

Methods inherited from NonOwnedWindow

#set_shape

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

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_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

#is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::Frame #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Wx::Frame

Returns a new instance of Frame.

Overloads:

  • #initialize ⇒ Wx::Frame

    Default constructor.

  • #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Wx::Frame

    Constructor, creating the window.

    Remark:

    For Motif, MWM (the Motif Window Manager) should be running for any window styles to work (otherwise all styles take effect).

    Parameters:

    • parent (Wx::Window) —

      The window parent. This may be, and often is, NULL. If it is non-NULL, the frame will be minimized when its parent is minimized and restored when it is restored (although it will still be possible to minimize and restore just this frame itself).

    • id (Integer) —

      The window identifier. It may take a value of -1 to indicate a default value.

    • title (String) —

      The caption to be displayed on the frame’s title bar.

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

      The window position. The value DEFAULT_POSITION indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.

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

      The window size. The value DEFAULT_SIZE indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.

    • style (Integer) (defaults to: Wx::DEFAULT_FRAME_STYLE) —

      The window style. See Wx::Frame class description.

    • name (String) (defaults to: Wx::FRAME_NAME_STR) —

      The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.

    See Also:



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

def initialize(*args) end

Instance Method Details

#centre(direction = Wx::Orientation::BOTH) ⇒ void

This method returns an undefined value.

Centres the frame on the display.

Parameters:



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

def centre(direction=Wx::Orientation::BOTH) end

#create(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Boolean

Used in two-step frame construction.

See frame for further details.

Parameters:

  • parent (Wx::Window)
  • id (Integer)
  • title (String)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: Wx::DEFAULT_FRAME_STYLE)
  • name (String) (defaults to: Wx::FRAME_NAME_STR)

Returns:

  • (Boolean) 


151
 
# File 'lib/wx/doc/gen/frame.rb', line 151

def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end

#create_status_bar(number = 1, style = Wx::STB_DEFAULT_STYLE, id = 0, name = Wx::STATUS_BAR_NAME_STR) ⇒ Wx::StatusBar

Creates a status bar at the bottom of the frame.

A pointer to the status bar if it was created successfully, NULL otherwise.

Remark:

The width of the status bar is the whole width of the frame (adjusted automatically when resizing), and the height and text size are chosen by the host windowing system.

Parameters:

  • number (Integer) (defaults to: 1) —

    The number of fields to create. Specify a value greater than 1 to create a multi-field status bar.

  • style (Integer) (defaults to: Wx::STB_DEFAULT_STYLE) —

    The status bar style. See StatusBar for a list of valid styles.

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

    The status bar window identifier. If -1, an identifier will be chosen by wxWidgets.

  • name (String) (defaults to: Wx::STATUS_BAR_NAME_STR) —

    The status bar window name.

Returns:

See Also:



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

def create_status_bar(number=1, style=Wx::STB_DEFAULT_STYLE, id=0, name=Wx::STATUS_BAR_NAME_STR) end

#create_tool_bar(style = Wx::TB_DEFAULT_STYLE, id = Wx::StandardID::ID_ANY, name = Wx::TOOL_BAR_NAME_STR) ⇒ Wx::ToolBar

Creates a toolbar at the top or left of the frame.

A pointer to the toolbar if it was created successfully, NULL otherwise.

Remark:

By default, the toolbar is an instance of ToolBar. To use a different class, override on_create_tool_bar. When a toolbar has been created with this function, or made known to the frame with #set_tool_bar, the frame will manage the toolbar position and adjust the return value from Window#get_client_size to reflect the available space for application windows. Under Pocket PC, you should always use this function for creating the toolbar to be managed by the frame, so that wxWidgets can use a combined menubar and toolbar. Where you manage your own toolbars, create a ToolBar as usual.

Parameters:

  • style (Integer) (defaults to: Wx::TB_DEFAULT_STYLE) —

    The toolbar style. See ToolBar for a list of valid styles.

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

    The toolbar window identifier. If -1, an identifier will be chosen by wxWidgets.

  • name (String) (defaults to: Wx::TOOL_BAR_NAME_STR) —

    The toolbar window name.

Returns:

See Also:



189
 
# File 'lib/wx/doc/gen/frame.rb', line 189

def create_tool_bar(style=Wx::TB_DEFAULT_STYLE, id=Wx::StandardID::ID_ANY, name=Wx::TOOL_BAR_NAME_STR) end

#do_give_help(text, show) ⇒ void

This method returns an undefined value.

Method used to show help string of the selected menu toolbar item.

This method is called by the default EVT_MENU_HIGHLIGHT event handler and also by ToolBar to show the optional help string associated with the selected menu or toolbar item. It can be overridden if the default behaviour of showing this string in the frame status bar is not appropriate.

Parameters:

  • text (String) —

    The help string to show, may be empty. The default implementation simply shows this string in the frame status bar (after remembering its previous text to restore it later).

  • show (Boolean) —

    Whether the help should be shown or hidden. The default implementation restores the previously saved status bar text when it is false.

See Also:



198
 
# File 'lib/wx/doc/gen/frame.rb', line 198

def do_give_help(text, show) end

#get_client_area_origin ⇒ Wx::Point Also known as: client_area_origin

Returns the origin of the frame client area (in client coordinates).

It may be different from (0, 0) if the frame has a toolbar.

Returns:



204
 
# File 'lib/wx/doc/gen/frame.rb', line 204

def get_client_area_origin; end

#get_menu_bar ⇒ Wx::MenuBar Also known as: menu_bar

Returns a pointer to the menubar currently associated with the frame (if any).

Returns:

See Also:



214
 
# File 'lib/wx/doc/gen/frame.rb', line 214

def get_menu_bar; end

#get_status_bar ⇒ Wx::StatusBar Also known as: status_bar

Returns a pointer to the status bar currently associated with the frame (if any).

Returns:

See Also:



223
 
# File 'lib/wx/doc/gen/frame.rb', line 223

def get_status_bar; end

#get_status_bar_pane ⇒ Integer Also known as: status_bar_pane

Returns the status bar pane used to display menu and toolbar help.

Returns:

  • (Integer)

See Also:



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

def get_status_bar_pane; end

#get_tool_bar ⇒ Wx::ToolBar Also known as: tool_bar

Returns a pointer to the toolbar currently associated with the frame (if any).

Returns:

See Also:



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

def get_tool_bar; end

#msw_get_task_bar_button ⇒ Wx::TaskBarButton

MSW-specific function for accessing the taskbar button under Windows 7 or later.

Returns a TaskBarButton pointer representing the taskbar button of the window under Windows 7 or later. The returned TaskBarButton may be used, if non-NULL, to access the functionality including thumbnail representations, thumbnail toolbars, notification and status overlays, and progress indicators. The returned pointer must not be deleted, it is owned by the frame and will be only deleted when the frame itself is destroyed. This function is not available in the other ports by design, any occurrences of it in the portable code must be guarded by

if Wx::PLATFORM == 'WXMSW'
    #...
  end

preprocessor guards.

Returns:

Requires:

  • WXMSW
  • USE_TASKBARBUTTON 


330
 
# File 'lib/wx/doc/gen/frame.rb', line 330

def msw_get_task_bar_button; end

#pop_status_text(number = 0) ⇒ void

This method returns an undefined value.

Parameters:

  • number (Integer) (defaults to: 0) 


339
 
# File 'lib/wx/doc/gen/frame.rb', line 339

def pop_status_text(number=0) end

#process_command(id) ⇒ Boolean

Simulate a menu command.

Parameters:

  • id (Integer) —

    The identifier for a menu item.

Returns:

  • (Boolean) 


247
 
# File 'lib/wx/doc/gen/frame.rb', line 247

def process_command(id) end

#push_status_text(text, number = 0) ⇒ void

This method returns an undefined value.

Parameters:

  • text (String)
  • number (Integer) (defaults to: 0) 


335
 
# File 'lib/wx/doc/gen/frame.rb', line 335

def push_status_text(text, number=0) end

#set_menu_bar(menuBar) ⇒ void Also known as: menu_bar=

This method returns an undefined value.

Tells the frame to show the given menu bar.

Remark:

If the frame is destroyed, the menu bar and its menus will be destroyed also, so do not delete the menu bar explicitly (except by resetting the frame's menu bar to another frame or NULL). Under Windows, a size event is generated, so be sure to initialize data members properly before calling #set_menu_bar. Note that on some platforms, it is not possible to call this function twice for the same frame object.

Parameters:

  • menuBar (Wx::MenuBar) —

    The menu bar to associate with the frame.

See Also:



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

def set_menu_bar(menuBar) end

#set_status_bar(statusBar) ⇒ void Also known as: status_bar=

This method returns an undefined value.

Associates a status bar with the frame.

If statusBar is NULL, then the status bar, if present, is detached from the frame, but not deleted.

Parameters:

See Also:



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

def set_status_bar(statusBar) end

#set_status_bar_pane(n) ⇒ void Also known as: status_bar_pane=

This method returns an undefined value.

Set the status bar pane used to display menu and toolbar help.

Using -1 disables help display.

Parameters:

  • n (Integer) 


280
 
# File 'lib/wx/doc/gen/frame.rb', line 280

def set_status_bar_pane(n) end

#set_status_text(text, number = 0) ⇒ void Also known as: status_text=

This method returns an undefined value.

Sets the status bar text and updates the status bar display.

This is a simple wrapper for StatusBar#set_status_text which doesn’t do anything if the frame has no status bar, i.e. #get_status_bar returns NULL.

Remark:

Use an empty string to clear the status bar.

Parameters:

  • text (String) —

    The text for the status field.

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

    The status field (starting from zero).

See Also:



297
 
# File 'lib/wx/doc/gen/frame.rb', line 297

def set_status_text(text, number=0) end

#set_status_widths(widths_field) ⇒ void

This method returns an undefined value.

Sets the widths of the fields in the status bar.

Remark:

The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.

Parameters:

  • widths_field (Array<Integer>) —

    Must contain an array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1. You should delete this array after calling #set_status_widths.



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

def set_status_widths(widths_field) end

#set_tool_bar(toolBar) ⇒ void Also known as: tool_bar=

This method returns an undefined value.

Associates a toolbar with the frame.

Parameters:



314
 
# File 'lib/wx/doc/gen/frame.rb', line 314

def set_tool_bar(toolBar) end