Class: Wx::Wizard

Inherits:
Dialog show all
Defined in:
lib/wx/doc/gen/wizard.rb

Overview

Wizard is the central class for implementing ‘wizard-like’ dialogs.

These dialogs are mostly familiar to Windows users and are nothing other than a sequence of ‘pages’, each displayed inside a dialog which has the buttons to navigate to the next (and previous) pages. The wizards are typically used to decompose a complex dialog into several simple steps and are mainly useful to the novice users, hence it is important to keep them as simple as possible. To show a wizard dialog, you must first create an instance of the Wizard class using either the non-default constructor or a default one followed by call to the #create function. Then you should add all pages you want the wizard to show and call #run_wizard. Finally, don’t forget to call "wizard->Destroy()", otherwise your application will hang on exit due to an undestroyed window. You can supply a bitmap to display on the left of the wizard, either for all pages or for individual pages. If you need to have the bitmap resize to the height of the wizard, call #set_bitmap_placement and if necessary, #set_bitmap_background_colour and #set_minimum_bitmap_width. To make wizard pages scroll when the display is too small to fit the whole dialog, you can switch layout adaptation on globally with Dialog.enable_layout_adaptation or per dialog with Dialog#set_layout_adaptation_mode. For more about layout adaptation, see Automatic Scrolled Dialogs.

Events emitted by this class

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

Extended styles

Use the Wx::Window#set_extra_style function to set the following style. You will need to use two-step construction (use the default constructor, call Wx::Window#set_extra_style, then call Create).

Extra Styles

This class supports the following extra styles:

See also Dialog for other extended styles.

Category: Common Dialogs

See Also:

Requires:

  • USE_WIZARDDLG

Instance Method Summary collapse

Methods inherited from Dialog

#add_main_button_id, #can_do_layout_adaptation, #centre, #create_button_sizer, #create_separated_button_sizer, #create_separated_sizer, #create_std_dialog_button_sizer, #create_text_sizer, #do_layout_adaptation, enable_layout_adaptation, #end_modal, #get_affirmative_id, #get_escape_id, #get_layout_adaptation_done, #get_layout_adaptation_level, #get_layout_adaptation_mode, get_layout_adapter, #get_main_button_ids, #get_return_code, #iconize, #is_iconized, is_layout_adaptation_enabled, #is_main_button_id, #is_modal, #set_affirmative_id, #set_escape_id, #set_icon, #set_icons, #set_layout_adaptation_done, #set_layout_adaptation_level, #set_layout_adaptation_mode, set_layout_adapter, #set_return_code, #show, #show_modal, #show_window_modal

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

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_capture_changed, #evt_mouse_capture_lost, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_command, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::Wizard #initialize(parent, id = Wx::StandardID::ID_ANY, title = (''), bitmap = (Wx::BitmapBundle.new()), pos = Wx::DEFAULT_POSITION, style = Wx::DEFAULT_DIALOG_STYLE) ⇒ Wx::Wizard

Returns a new instance of Wizard.

Overloads:

  • #initialize ⇒ Wx::Wizard

    Default constructor.

    Use this if you wish to derive from Wx::Wizard and then call #create, for example if you wish to set an extra style with Wx::Window#set_extra_style between the two calls.

  • #initialize(parent, id = Wx::StandardID::ID_ANY, title = (''), bitmap = (Wx::BitmapBundle.new()), pos = Wx::DEFAULT_POSITION, style = Wx::DEFAULT_DIALOG_STYLE) ⇒ Wx::Wizard

    Constructor which really creates the wizard if you use this constructor, you shouldn’t call #create.

    Notice that unlike almost all other wxWidgets classes, there is no size parameter in the Wx::Wizard constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the #get_page_area_sizer function.

    Parameters:

    • parent (Wx::Window) —

      The parent window, may be NULL.

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

      The id of the dialog, will usually be just StandardID::ID_ANY.

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

      The title of the dialog.

    • bitmap (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new())) —

      The default bitmap used in the left side of the wizard. See also get_bitmap.

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

      The position of the dialog, it will be centered on the screen by default.

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

      Window style is passed to Dialog.



72
 
# File 'lib/wx/doc/gen/wizard.rb', line 72

def initialize(*args) end

Instance Method Details

#create(parent, id = Wx::StandardID::ID_ANY, title = (''), bitmap = (Wx::BitmapBundle.new()), pos = Wx::DEFAULT_POSITION, style = Wx::DEFAULT_DIALOG_STYLE) ⇒ Boolean

Creates the wizard dialog.

Must be called if the default constructor had been used to create the object. Notice that unlike almost all other wxWidgets classes, there is no size parameter in the Wx::Wizard constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the #get_page_area_sizer function.

Parameters:

  • parent (Wx::Window) —

    The parent window, may be NULL.

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

    The id of the dialog, will usually be just -1.

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

    The title of the dialog.

  • bitmap (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new())) —

    The default bitmap used in the left side of the wizard. See also get_bitmap.

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

    The position of the dialog, it will be centered on the screen by default.

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

    Window style is passed to Dialog.

Returns:

  • (Boolean) 


85
 
# File 'lib/wx/doc/gen/wizard.rb', line 85

def create(parent, id=Wx::StandardID::ID_ANY, title=(''), bitmap=(Wx::BitmapBundle.new()), pos=Wx::DEFAULT_POSITION, style=Wx::DEFAULT_DIALOG_STYLE) end

#fit_to_page(firstPage) ⇒ void

This method returns an undefined value.

This method is obsolete, use #get_page_area_sizer instead.

Sets the page size to be big enough for all the pages accessible via the given firstPage, i.e. this page, its next page and so on. This method may be called more than once and it will only change the page size if the size required by the new page is bigger than the previously set one. This is useful if the decision about which pages to show is taken during run-time, as in this case, the wizard won’t be able to get to all pages starting from a single one and you should call Fit separately for the others.

Parameters:



93
 
# File 'lib/wx/doc/gen/wizard.rb', line 93

def fit_to_page(firstPage) end

#get_bitmap_background_colour ⇒ Wx::Colour, ... Also known as: bitmap_background_colour

Returns the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.

See also #set_bitmap_placement.

Returns:



99
 
# File 'lib/wx/doc/gen/wizard.rb', line 99

def get_bitmap_background_colour; end

#get_bitmap_placement ⇒ Integer Also known as: bitmap_placement

Returns the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.

By default, placement is 0 (no expansion is done). See also #set_bitmap_placement for the possible values.

Returns:

  • (Integer) 


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

def get_bitmap_placement; end

#get_current_page ⇒ Wx::WizardPage Also known as: current_page

Get the current page while the wizard is running.

NULL is returned if #run_wizard is not being executed now.

Returns:



114
 
# File 'lib/wx/doc/gen/wizard.rb', line 114

def get_current_page; end

#get_minimum_bitmap_width ⇒ Integer Also known as: minimum_bitmap_width

Returns the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.

See also #set_bitmap_placement.

Returns:

  • (Integer) 


121
 
# File 'lib/wx/doc/gen/wizard.rb', line 121

def get_minimum_bitmap_width; end

#get_page_area_sizer ⇒ Wx::Sizer Also known as: page_area_sizer

Returns pointer to page area sizer.

The wizard is laid out using sizers and the page area sizer is the place-holder for the pages. All pages are resized before being shown to match the wizard page area. Page area sizer has a minimal size that is the maximum of several values. First, all pages (or other objects) added to the sizer. Second, all pages reachable by repeatedly applying Wx::WizardPage#get_next to any page inserted into the sizer. Third, the minimal size specified using #set_page_size and #fit_to_page. Fourth, the total wizard height may be increased to accommodate the bitmap height. Fifth and finally, wizards are never smaller than some built-in minimal size to avoid wizards that are too small. The caller can use Sizer#set_min_size to enlarge it beyond the minimal size. If RESIZE_BORDER was passed to constructor, user can resize wizard and consequently the page area (but not make it smaller than the minimal size). It is recommended to add the first page to the page area sizer. For simple wizards, this will enlarge the wizard to fit the biggest page. For non-linear wizards, the first page of every separate chain should be added. Caller-specified size can be accomplished using Sizer#set_min_size. Adding pages to the page area sizer affects the default border width around page area that can be altered with #set_border.

Returns:



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

def get_page_area_sizer; end

#get_page_size ⇒ Wx::Size Also known as: page_size

Returns the size available for the pages.

Returns:



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

def get_page_size; end

#has_next_page(page) ⇒ Boolean Also known as: has_next_page?

Return true if this page is not the last one in the wizard.

The base class version implements this by calling page->GetNext but this could be undesirable if, for example, the pages are created on demand only.

Parameters:

Returns:

  • (Boolean)

See Also:



147
 
# File 'lib/wx/doc/gen/wizard.rb', line 147

def has_next_page(page) end

#has_prev_page(page) ⇒ Boolean Also known as: has_prev_page?

Returns true if this page is not the first one in the wizard.

The base class version implements this by calling page->GetPrev but this could be undesirable if, for example, the pages are created on demand only.

Parameters:

Returns:

  • (Boolean)

See Also:



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

def has_prev_page(page) end

#run_wizard(firstPage) ⇒ Boolean

Executes the wizard starting from the given page, returning true if it was successfully finished or false if user cancelled it.

The firstPage cannot be NULL.

Parameters:

Returns:

  • (Boolean) 


164
 
# File 'lib/wx/doc/gen/wizard.rb', line 164

def run_wizard(firstPage) end

#set_bitmap(bitmap) ⇒ void Also known as: bitmap=

This method returns an undefined value.

Sets the bitmap used for the wizard.

Parameters:



169
 
# File 'lib/wx/doc/gen/wizard.rb', line 169

def set_bitmap(bitmap) end

#set_bitmap_background_colour(colour) ⇒ void Also known as: bitmap_background_colour=

This method returns an undefined value.

Sets the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.

See also #set_bitmap_placement.

Parameters:



177
 
# File 'lib/wx/doc/gen/wizard.rb', line 177

def set_bitmap_background_colour(colour) end

#set_bitmap_placement(placement) ⇒ void Also known as: bitmap_placement=

This method returns an undefined value.

Sets the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.

By default, placement is 0 (no expansion is done). placement is a bitlist with the following possible values:

See also #set_minimum_bitmap_width.

Parameters:

  • placement (Integer) 


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

def set_bitmap_placement(placement) end

#set_border(border) ⇒ void Also known as: border=

This method returns an undefined value.

Sets width of border around page area.

Default is zero. For backward compatibility, if there are no pages in #get_page_area_sizer, the default is 5 pixels. If there is a five point border around all controls in a page and the border around page area is left as zero, a five point white space along all dialog borders will be added to the control border in order to space page controls ten points from the dialog border and non-page controls.

Parameters:

  • border (Integer) 


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

def set_border(border) end

#set_minimum_bitmap_width(width) ⇒ void Also known as: minimum_bitmap_width=

This method returns an undefined value.

Sets the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.

If this is not set when using bitmap placement, the initial layout may be incorrect. See also #set_bitmap_placement.

Parameters:

  • width (Integer) 


213
 
# File 'lib/wx/doc/gen/wizard.rb', line 213

def set_minimum_bitmap_width(width) end

#set_page_size(sizePage) ⇒ void Also known as: page_size=

This method returns an undefined value.

Sets the minimal size to be made available for the wizard pages.

The wizard will take into account the size of the bitmap (if any) itself. Also, the wizard will never be smaller than the default size. The recommended way to use this function is to lay out all wizard pages using the sizers (even though the wizard is not resizable) and then use Sizer#calc_min in a loop to calculate the maximum of minimal sizes of the pages and pass it to #set_page_size.

Parameters:

  • sizePage (Array(Integer, Integer), Wx::Size) 


222
 
# File 'lib/wx/doc/gen/wizard.rb', line 222

def set_page_size(sizePage) end