Class: Wx::HTML::HtmlWindow

Inherits:

ScrolledWindow

• Object
• Object
• EvtHandler
• Window
• Panel
• ScrolledWindow
• Wx::HTML::HtmlWindow

Defined in:

lib/wx/doc/gen/html/html_window.rb

Overview

HtmlWindow is probably the only class you will directly use unless you want to do something special (like adding new tag handlers or MIME filters).

The purpose of this class is to display rich content pages (either local file or downloaded via HTTP protocol) in a window based on a subset of the HTML standard. The width of the window is constant, given in the constructor and virtual height is changed dynamically depending on page size. Once the window is created you can set its content by calling #set_page with raw HTML, #load_page with a FileSystem location or #load_file with a filename.

Note:

If you want complete HTML/CSS support as well as a Javascript engine, consider using WebView instead.

HtmlWindow uses the Image class for displaying images, so you need to initialize the handlers for any image formats you use before loading a page. See InitAllImageHandlers and Image.add_handler.

Styles

This class supports the following styles:

• HW_SCROLLBAR_NEVER: Never display scrollbars, not even when the page is larger than the window.

• HW_SCROLLBAR_AUTO: Display scrollbars only if page's size exceeds window's size.

• HW_NO_SELECTION: Don't allow the user to select text.

Events emitted by this class

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

• EvtHandler#evt_html_cell_clicked(id, meth = nil, &block): A HtmlCell was clicked.

• EvtHandler#evt_html_cell_hover(id, meth = nil, &block): The mouse passed over a HtmlCell.

• EvtHandler#evt_html_link_clicked(id, meth = nil, &block): A HtmlCell which contains a hyperlink was clicked.

Category: Wx::HTML

See Also:

• HtmlLinkEvent
• HtmlCellEvent

Requires:

• USE_HTML

Class Method Summary

• .add_filter(filter) ⇒ void

  Adds an input filter to the static list of available filters.

• .get_default_html_cursor(type) ⇒ Wx::Cursor

  Retrieves the default cursor for a given HTMLCursor type.

• .set_default_html_cursor(type, cursor) ⇒ void

  Sets the default cursor for a given HTMLCursor type.

Instance Method Summary

• #append_to_page(source) ⇒ Boolean

  Appends HTML fragment to currently displayed text and refreshes the window.

• #get_internal_representation ⇒ Wx::HTML::HtmlContainerCell (also: #internal_representation)

  Returns pointer to the top-level container.

• #get_opened_anchor ⇒ String (also: #opened_anchor)

  Returns anchor within currently opened page (see #get_opened_page).

• #get_opened_page ⇒ String (also: #opened_page)

  Returns full location of the opened page.

• #get_opened_page_title ⇒ String (also: #opened_page_title)

  Returns title of the opened page or EmptyString if the current page does not contain <TITLE> tag.

• #get_related_frame ⇒ Wx::Frame (also: #related_frame)

  Returns the related frame.

• #history_back ⇒ Boolean

  Moves back to the previous page.

• #history_can_back ⇒ Boolean

  Returns true if it is possible to go back in the history i.e.

• #history_can_forward ⇒ Boolean

  Returns true if it is possible to go forward in the history i.e.

• #history_clear ⇒ void

  Clears history.

• #history_forward ⇒ Boolean

  Moves to next page in history.

• #initialize(*args) ⇒ HtmlWindow constructor

  A new instance of HtmlWindow.

• #load_file(filename) ⇒ Boolean

  Loads an HTML page from a file and displays it.

• #load_page(location) ⇒ Boolean

  Unlike #set_page this function first loads the HTML page from location and then displays it.

• #on_opening_url(type, url) ⇒ Wx::HtmlOpeningStatus

  Called when an URL is being opened (either when the user clicks on a link or an image is loaded).

• #on_set_title(title) ⇒ void

  Called on parsing <TITLE> tag.

• #read_customization(cfg, path = ('')) ⇒ void

  This reads custom settings from Config.

• #select_all ⇒ void

  Selects all text in the window.

• #select_line(pos) ⇒ void

  Selects the line of text that pos points at.

• #select_word(pos) ⇒ void

  Selects the word at position pos.

• #selection_to_text ⇒ String

  Returns the current selection as plain text.

• #set_borders(b) ⇒ void (also: #borders=)

  This function sets the space between border of window and HTML contents.

• #set_fonts(normal_face, fixed_face, sizes = nil) ⇒ void

  This function sets font sizes and faces.

• #set_page(source) ⇒ Boolean (also: #page=)

  Sets the source of a page and displays it, for example:.

• #set_related_frame(frame, format) ⇒ void

  Sets the frame in which page title will be displayed.

• #set_related_status_bar(*args) ⇒ Object (also: #related_status_bar=)
• #set_standard_fonts(size = -1,, normal_face = (''), fixed_face = ('')) ⇒ void (also: #standard_fonts=)

  Sets default font sizes and/or default font size.

• #to_text ⇒ String

  Returns content of currently displayed page as plain text.

• #write_customization(cfg, path = ('')) ⇒ void

  Saves custom settings into Config.

Methods inherited from ScrolledWindow

#adjust_scrollbars, #calc_scrolled_position, #calc_unscrolled_position, #create, #disable_keyboard_scrolling, #do_prepare_dc, #enable_scrolling, #get_scale_x, #get_scale_y, #get_scroll_lines, #get_scroll_page_size, #get_scroll_pixels_per_unit, #get_target_rect, #get_target_window, #get_view_start, #get_virtual_size, #is_auto_scrolling, #is_retained, #prepare_dc, #scroll, #set_scale, #set_scroll_page_size, #set_scroll_rate, #set_scrollbars, #set_target_rect, #set_target_window, #show_scrollbars, #stop_auto_scrolling

Methods inherited from Panel

#accepts_focus, #create, #init_dialog, #layout, #on_sys_colour_changed, #set_focus, #set_focus_ignoring_children

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, #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_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::HTML::HtmlWindow #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::HTML::HW_DEFAULT_STYLE, name = ("HTML_WINDOW")) ⇒ Wx::HTML::HtmlWindow

Returns a new instance of HtmlWindow.

Overloads:

• #initialize ⇒ Wx::HTML::HtmlWindow

  Default ctor.
• #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::HTML::HW_DEFAULT_STYLE, name = ("HTML_WINDOW")) ⇒ Wx::HTML::HtmlWindow

  Constructor.

  The parameters are the same as Wx::Scrolled#initialize constructor.

  Parameters:

  • parent (Wx::Window)
  • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: Wx::HTML::HW_DEFAULT_STYLE)
  • name (String) (defaults to: ("HTML_WINDOW"))

# File 'lib/wx/doc/gen/html/html_window.rb', line 131

def initialize(*args) end

Class Method Details

.add_filter(filter) ⇒ void

This method returns an undefined value.

Adds an input filter to the static list of available filters.

These filters are present by default:

text/html
  text/plain
  image/*

The plain text filter will be used if no other filter matches.

Parameters:

• filter (Wx::HTML::HtmlFilter)

# File 'lib/wx/doc/gen/html/html_window.rb', line 374

def self.add_filter(filter) end

.get_default_html_cursor(type) ⇒ Wx::Cursor

Retrieves the default cursor for a given HTMLCursor type.

Parameters:

• type (Integer) —

  HTMLCursor type to retrieve.

Returns:

• (Wx::Cursor)

# File 'lib/wx/doc/gen/html/html_window.rb', line 379

def self.get_default_html_cursor(type) end

.set_default_html_cursor(type, cursor) ⇒ void

This method returns an undefined value.

Sets the default cursor for a given HTMLCursor type.

These cursors are used for all Wx::HTML::HtmlWindow objects by default, but can be overridden on a per-window basis.

Parameters:

• type (Integer) —

  HTMLCursor type to retrieve.

• cursor (Wx::Cursor) —

  The default cursor for the specified cursor type.

# File 'lib/wx/doc/gen/html/html_window.rb', line 387

def self.set_default_html_cursor(type, cursor) end

Instance Method Details

#append_to_page(source) ⇒ Boolean

Appends HTML fragment to currently displayed text and refreshes the window.

false if an error occurred, true otherwise.

Parameters:

• source (String) —

  HTML code fragment

Returns:

• (Boolean)

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

def append_to_page(source) end

#get_internal_representation ⇒ Wx::HTML::HtmlContainerCell Also known as: internal_representation

Returns pointer to the top-level container.

Returns:

• (Wx::HTML::HtmlContainerCell)

See Also:

• and Containers
• Framework Overview

# File 'lib/wx/doc/gen/html/html_window.rb', line 146

def get_internal_representation; end

#get_opened_anchor ⇒ String Also known as: opened_anchor

Returns anchor within currently opened page (see #get_opened_page).

If no page is opened or if the displayed page wasn’t produced by call to #load_page, empty string is returned.

Returns:

• (String)

# File 'lib/wx/doc/gen/html/html_window.rb', line 153

def get_opened_anchor; end

#get_opened_page ⇒ String Also known as: opened_page

Returns full location of the opened page.

If no page is opened or if the displayed page wasn’t produced by call to #load_page, empty string is returned.

Returns:

• (String)

# File 'lib/wx/doc/gen/html/html_window.rb', line 160

def get_opened_page; end

#get_opened_page_title ⇒ String Also known as: opened_page_title

Returns title of the opened page or EmptyString if the current page does not contain <TITLE> tag.

Returns:

• (String)

# File 'lib/wx/doc/gen/html/html_window.rb', line 165

def get_opened_page_title; end

#get_related_frame ⇒ Wx::Frame Also known as: related_frame

Returns the related frame.

Returns:

• (Wx::Frame)

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

def get_related_frame; end

#history_back ⇒ Boolean

Moves back to the previous page.

Only pages displayed using #load_page are stored in history list.

Returns:

• (Boolean)

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

def history_back; end

#history_can_back ⇒ Boolean

Returns true if it is possible to go back in the history i.e.

#history_back won’t fail.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/html/html_window.rb', line 183

def history_can_back; end

#history_can_forward ⇒ Boolean

Returns true if it is possible to go forward in the history i.e.

#history_forward won’t fail.

Returns:

• (Boolean)

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

def history_can_forward; end

#history_clear ⇒ void

This method returns an undefined value.

Clears history.

# File 'lib/wx/doc/gen/html/html_window.rb', line 193

def history_clear; end

#history_forward ⇒ Boolean

Moves to next page in history.

Only pages displayed using #load_page are stored in history list.

Returns:

• (Boolean)

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

def history_forward; end

#load_file(filename) ⇒ Boolean

Loads an HTML page from a file and displays it.

false if an error occurred, true otherwise

Parameters:

• filename (String)

Returns:

• (Boolean)

See Also:

• #load_page

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

def load_file(filename) end

#load_page(location) ⇒ Boolean

Unlike #set_page this function first loads the HTML page from location and then displays it.

false if an error occurred, true otherwise

Parameters:

• location (String) —

  The address of the document. See the wxFileSystem Overview for details on the address format and FileSystem for a description of how the file is opened.

Returns:

• (Boolean)

See Also:

• #load_file

# File 'lib/wx/doc/gen/html/html_window.rb', line 215

def load_page(location) end

#on_opening_url(type, url) ⇒ Wx::HtmlOpeningStatus

Called when an URL is being opened (either when the user clicks on a link or an image is loaded).

The URL will be opened only if #on_opening_url returns Wx::HTML::HtmlOpeningStatus::HTML_OPEN. This method is called by Wx::HtmlParser::OpenURL. You can override #on_opening_url to selectively block some URLs (e.g. for security reasons) or to redirect them elsewhere. Default behaviour is to always return Wx::HTML::HtmlOpeningStatus::HTML_OPEN.

The return value is:

• Wx::HTML::HtmlOpeningStatus::HTML_OPEN: Open the URL.

• Wx::HTML::HtmlOpeningStatus::HTML_BLOCK: Deny access to the URL, Wx::HtmlParser::OpenURL will return NULL.

• Wx::HTML::HtmlOpeningStatus::HTML_REDIRECT: Don’t open url, redirect to another URL. #on_opening_url must fill *redirect with the new URL. #on_opening_url will be called again on returned URL.

Parameters:

• type (Wx::HtmlURLType) —

  Indicates type of the resource. Is one of

  • Wx::HTML::HtmlURLType::HTML_URL_PAGE: Opening a HTML page.

  • Wx::HTML::HtmlURLType::HTML_URL_IMAGE: Opening an image.

  • Wx::HTML::HtmlURLType::HTML_URL_OTHER: Opening a resource that doesn’t fall into any other category.

• url (String) —

  URL being opened.

Returns:

• (Wx::HtmlOpeningStatus)

# File 'lib/wx/doc/gen/html/html_window.rb', line 234

def on_opening_url(type, url) end

#on_set_title(title) ⇒ void

This method returns an undefined value.

Called on parsing <TITLE> tag.

Parameters:

• title (String)

# File 'lib/wx/doc/gen/html/html_window.rb', line 239

def on_set_title(title) end

#read_customization(cfg, path = ('')) ⇒ void

This method returns an undefined value.

This reads custom settings from Config.

It uses the path ‘path’ if given, otherwise it saves info into currently selected path. The values are stored in sub-path Wx::HTML::HtmlWindow. Read values: all things set by #set_fonts, #set_borders.

Parameters:

• cfg (Wx::ConfigBase) —

  Config from which you want to read the configuration.

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

  Optional path in config tree. If not given current path is used.

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

def read_customization(cfg, path=('')) end

#select_all ⇒ void

This method returns an undefined value.

Selects all text in the window.

See Also:

• #select_line
• #select_word

# File 'lib/wx/doc/gen/html/html_window.rb', line 255

def select_all; end

#select_line(pos) ⇒ void

This method returns an undefined value.

Selects the line of text that pos points at.

Note that pos is relative to the top of displayed page, not to window’s origin, use Wx::Scrolled#calc_unscrolled_position to convert physical coordinate.

Parameters:

• pos (Array(Integer, Integer), Wx::Point)

See Also:

• #select_all
• #select_word

# File 'lib/wx/doc/gen/html/html_window.rb', line 264

def select_line(pos) end

#select_word(pos) ⇒ void

This method returns an undefined value.

Selects the word at position pos.

Note that pos is relative to the top of displayed page, not to window’s origin, use Wx::Scrolled#calc_unscrolled_position to convert physical coordinate.

Parameters:

• pos (Array(Integer, Integer), Wx::Point)

See Also:

• #select_all
• #select_line

# File 'lib/wx/doc/gen/html/html_window.rb', line 273

def select_word(pos) end

#selection_to_text ⇒ String

Returns the current selection as plain text.

Returns an empty string if no text is currently selected.

Returns:

• (String)

# File 'lib/wx/doc/gen/html/html_window.rb', line 279

def selection_to_text; end

#set_borders(b) ⇒ void Also known as: borders=

This method returns an undefined value.

This function sets the space between border of window and HTML contents.

See image:

Parameters:

• b (Integer) —

  indentation from borders in pixels

# File 'lib/wx/doc/gen/html/html_window.rb', line 286

def set_borders(b) end

#set_fonts(normal_face, fixed_face, sizes = nil) ⇒ void

This method returns an undefined value.

This function sets font sizes and faces.

See Wx::HtmlDCRenderer::SetFonts for detailed description.

Parameters:

• normal_face (String)
• fixed_face (String)
• sizes (Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil) (defaults to: nil)

See Also:

• SetSize()

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

def set_fonts(normal_face, fixed_face, sizes=nil) end

#set_page(source) ⇒ Boolean Also known as: page=

Sets the source of a page and displays it, for example:

htmlwin.set_page('<html><body>Hello, world!</body></html>')

If you want to load a document from some location use #load_page instead.

false if an error occurred, true otherwise.

Parameters:

• source (String) —

  The HTML to be displayed.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/html/html_window.rb', line 321

def set_page(source) end

#set_related_frame(frame, format) ⇒ void

This method returns an undefined value.

Sets the frame in which page title will be displayed.

format is the format of the frame title, e.g. “HtmlHelp : %s”. It must contain exactly one s. This s is substituted with HTML page title.

Parameters:

• frame (Wx::Frame)
• format (String)

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

def set_related_frame(frame, format) end

#set_related_status_bar(index) ⇒ void #set_related_status_bar(statusbar, index = 0) ⇒ void Also known as: related_status_bar=

Overloads:

• #set_related_status_bar(index) ⇒ void

  This method returns an undefined value.

  After calling #set_related_frame, this sets statusbar slot where messages will be displayed.

  (Default is -1 = no messages.)

  Parameters:

  • index (Integer) —

    Statusbar slot number (0..n)

• #set_related_status_bar(statusbar, index = 0) ⇒ void

  This method returns an undefined value.

  Sets the associated statusbar where messages will be displayed.

  Call this instead of #set_related_frame if you want statusbar updates only, no changing of the frame title.

  Parameters:

  • statusbar (Wx::StatusBar) —

    Statusbar pointer

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

    Statusbar slot number (0..n)

# File 'lib/wx/doc/gen/html/html_window.rb', line 345

def set_related_status_bar(*args) end

#set_standard_fonts(size = -1,, normal_face = (''), fixed_face = ('')) ⇒ void Also known as: standard_fonts=

This method returns an undefined value.

Sets default font sizes and/or default font size.

See Wx::HtmlDCRenderer::SetStandardFonts for detailed description.

Parameters:

• size (Integer) (defaults to: -1,)
• normal_face (String) (defaults to: (''))
• fixed_face (String) (defaults to: (''))

See Also:

• #set_fonts

# File 'lib/wx/doc/gen/html/html_window.rb', line 307

def set_standard_fonts(size=-1, normal_face=(''), fixed_face=('')) end

#to_text ⇒ String

Returns content of currently displayed page as plain text.

Returns:

• (String)

# File 'lib/wx/doc/gen/html/html_window.rb', line 350

def to_text; end

#write_customization(cfg, path = ('')) ⇒ void

This method returns an undefined value.

Saves custom settings into Config.

It uses the path ‘path’ if given, otherwise it saves info into currently selected path. Regardless of whether the path is given or not, the function creates sub-path Wx::HTML::HtmlWindow. Saved values: all things set by #set_fonts, #set_borders.

Parameters:

• cfg (Wx::ConfigBase) —

  Config to which you want to save the configuration.

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

  Optional path in config tree. If not given, the current path is used.

# File 'lib/wx/doc/gen/html/html_window.rb', line 359

def write_customization(cfg, path=('')) end