wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

data/lib/wx/doc/gen/html/html_list_box.rb

@@ -13,8 +13,9 @@ module Wx::HTML
   HLB_MULTIPLE = 64
   
   # {Wx::HTML::HtmlListBox} is an implementation of {Wx::VListBox} which shows HTML content in the listbox rows.
+  # 
   # This is still an abstract base class and you will need to derive your own class from it (see htlbox sample for the example), but you will only need to override a single {Wx::HTML::HtmlListBox#on_get_item} function.
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
   # Event handler methods for events emitted by this class:
@@ -25,12 +26,11 @@ module Wx::HTML
   # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Controls}
   # @see Wx::HTML::SimpleHtmlListBox 
   # 
   # 
+  # @wxrb_require USE_HTML
   class HtmlListBox < VListBox
   
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HTML_LIST_BOX_NAME_STR)
@@ -48,6 +48,7 @@ module Wx::HTML
     def initialize(*args) end
     
     # Creates the control and optionally sets the initial number of items in it (it may also be set or changed later with {Wx::VListBox#set_item_count}).
+    # 
     # There are no special styles defined for {Wx::HTML::HtmlListBox}, in particular the {Wx::ListBox} styles (with the exception of {Wx::LB_MULTIPLE}) cannot be used here.
     # Returns true on success or false if the control couldn't be created
     # @param parent [Wx::Window] 
@@ -63,6 +64,7 @@ module Wx::HTML
     protected
     
     # Called when the user clicks on hypertext link.
+    # 
     # Does nothing by default. Overloading this method is deprecated; intercept the event instead.
     # @see Wx::HTML::HtmlLinkInfo. 
     # @param n [Integer]  Index of the item containing the link.
@@ -71,6 +73,7 @@ module Wx::HTML
     def on_link_clicked(n, link) end
     
     # This virtual function may be overridden to change the appearance of the background of the selected cells in the same way as {Wx::HTML::HtmlListBox#get_selected_text_colour}.
+    # 
     # It should be rarely, if ever, used because {Wx::VListBox#set_selection_background} allows changing the selection background for all cells at once and doing anything more fancy is probably going to look strangely.
     # @see Wx::HTML::HtmlListBox#get_selected_text_colour 
     # @param colBg [Wx::Colour,String,Symbol] 
@@ -79,6 +82,7 @@ module Wx::HTML
     alias_method :selected_text_bg_colour, :get_selected_text_bg_colour
     
     # This virtual function may be overridden to customize the appearance of the selected cells.
+    # 
     # It is used to determine how the colour colFg is going to look inside selection. By default all original colours are completely ignored and the standard, system-dependent, selection colour is used but the program may wish to override this to achieve some custom appearance.
     # @see Wx::HTML::HtmlListBox#get_selected_text_bg_colour
     # @see  Wx::VListBox#set_selection_background
@@ -94,6 +98,7 @@ module Wx::HTML
     def on_get_item_markup(n) end
     
     # This method must be implemented in the derived class and should return the body (i.e. without html nor body tags) of the HTML fragment for the given item.
+    # 
     # Note that this function should always return a text fragment for the n item which renders with the same height both when it is selected and when it's not: i.e. if you call, inside your {Wx::HTML::HtmlListBox#on_get_item} implementation, <code>IsSelected(n)</code> to make the items appear differently when they are selected, then you should make sure that the returned HTML fragment will render with the same height or else you'll see some artifacts when the user selects an item.
     # @param n [Integer] 
     # @return [String]
@@ -102,12 +107,13 @@ module Wx::HTML
   end # HtmlListBox
   
   # {Wx::HTML::SimpleHtmlListBox} is an implementation of {Wx::HTML::HtmlListBox} which shows HTML content in the listbox rows.
+  # 
   # Unlike {Wx::HTML::HtmlListBox}, this is not an abstract class and thus it has the advantage that you can use it without deriving your own class from it. However, it also has the disadvantage that this is not a virtual control and thus it's not well-suited for those cases where you need to show a huge number of items: every time you add/insert a string, it will be stored internally and thus will take memory.
   # The interface exposed by {Wx::HTML::SimpleHtmlListBox} fully implements the {Wx::ControlWithItems} interface, thus you should refer to {Wx::ControlWithItems}'s documentation for the API reference for adding/removing/retrieving items in the listbox. Also note that the {Wx::VListBox#set_item_count} function is protected in {Wx::HTML::SimpleHtmlListBox}'s context so that you cannot call it directly, {Wx::HTML::SimpleHtmlListBox} will do it for you.
   # Note: in case you need to append a lot of items to the control at once, make sure to use the Append(const wxArrayString&) function.
   # Thus the only difference between a {Wx::ListBox} and a {Wx::HTML::SimpleHtmlListBox} is that the latter stores strings which can contain HTML fragments (see the list of tags supported by wxHTML).
   # Note that the HTML strings you fetch to {Wx::HTML::SimpleHtmlListBox} should not contain the <code><html></code> or <code><body></code> tags.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -116,7 +122,7 @@ module Wx::HTML
   # - {Wx::HTML::HLB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. 
   # 
   # A {Wx::HTML::SimpleHtmlListBox} emits the same events used by {Wx::ListBox} and by {Wx::HTML::HtmlListBox}.
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # Event handler methods for events emitted by this class:
   # 
@@ -130,17 +136,17 @@ module Wx::HTML
   # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. See {Wx::HTML::HtmlLinkEvent} 
   # 
-  # === 
-  # 
   # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
   #   </td></tr></table></div>
   # @see Wx::HTML::SimpleHtmlListBox#create 
   # 
   # 
+  # @wxrb_require USE_HTML
   class SimpleHtmlListBox < HtmlListBox
   
     # @overload create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
     #   Creates the HTML listbox for two-step construction.
+    #   
     #   See {Wx::HTML::SimpleHtmlListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -153,6 +159,7 @@ module Wx::HTML
     #   @return [Boolean]
     # @overload create(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SIMPLE_HTML_LIST_BOX_NAME_STR)
     #   Creates the HTML listbox for two-step construction.
+    #   
     #   See {Wx::HTML::SimpleHtmlListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -183,52 +190,61 @@ module Wx::HTML
     
     # @overload append(item)
     #   Appends item into the control.
+    #   
     #   The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
     #   @param item [String]  String to add.
     #   @return [Integer]
     # @overload append(item, clientData)
     #   Appends item into the control.
+    #   
     #   The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
     #   @param item [String]  String to add.
     #   @param clientData [Object]  Pointer to client data to associate with the new item.
     #   @return [Integer]
     # @overload append(items)
     #   Appends several items at once into the control.
+    #   
     #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
     #   @param items [Array<String>]  Array of strings to insert.
     #   @return [Integer]
     # @overload append(items, clientData)
     #   Appends several items at once into the control.
+    #   
     #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
     #   @param items [Array<String>]  Array of strings to insert.
-    #   @param clientData [Array]  Array of client data pointers of the same size as items to associate with the new items.
+    #   @param clientData [Wx::ClientData]  Array of client data pointers of the same size as items to associate with the new items.
     #   @return [Integer]
     def append(*args) end
     
     # Returns a pointer to the client data associated with the given item (if any).
-    # It is an error to call this function for a control which doesn't have untyped client data at all although it is OK to call it even if the given item doesn't have any client data associated with it (but other items do).
+    # 
+    # It is an error to call this function for a control which doesn't have typed client data at all although it is OK to call it even if the given item doesn't have any client data associated with it (but other items do).
+    # Notice that the returned pointer is still owned by the control and will be deleted by it, use {Wx::HTML::SimpleHtmlListBox#detach_client_object} if you want to remove the pointer from the control.
     # 
     # A pointer to the client data, or NULL if not present.
     # @param n [Integer]  The zero-based position of the item.
     # @return [Object]
-    def get_client_data(n) end
-    alias_method :client_data, :get_client_data
+    def get_client_object(n) end
+    alias_method :client_object, :get_client_object
     
-    # Associates the given untyped client data pointer with the given item.
-    # Note that it is an error to call this function if any typed client data pointers had been associated with the control items before.
+    # Associates the given typed client data pointer with the given item: the data object will be deleted when the item is deleted (either explicitly by using {Wx::HTML::SimpleHtmlListBox#delete} or implicitly when the control itself is destroyed).
+    # 
+    # Note that it is an error to call this function if any untyped client data pointers had been associated with the control items before.
     # @param n [Integer]  The zero-based item index.
     # @param data [Object]  The client data to associate with the item.
     # @return [void]
-    def set_client_data(n, data) end
+    def set_client_object(n, data) end
     
     # @overload insert(item, pos)
     #   Inserts item into the control.
+    #   
     #   The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
     #   @param item [String]  String to add.
     #   @param pos [Integer]  Position to insert item before, zero based.
     #   @return [Integer]
     # @overload insert(item, pos, clientData)
     #   Inserts item into the control.
+    #   
     #   The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
     #   @param item [String]  String to add.
     #   @param pos [Integer]  Position to insert item before, zero based.
@@ -236,6 +252,7 @@ module Wx::HTML
     #   @return [Integer]
     # @overload insert(items, pos)
     #   Inserts several items at once into the control.
+    #   
     #   Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
     #   
     #   The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
@@ -244,29 +261,33 @@ module Wx::HTML
     #   @return [Integer]
     # @overload insert(items, pos, clientData)
     #   Inserts several items at once into the control.
+    #   
     #   Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
     #   
     #   The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
     #   @param items [Array<String>]  Array of strings to insert.
     #   @param pos [Integer]  Position to insert the items before, zero based.
-    #   @param clientData [Array]  Array of client data pointers of the same size as items to associate with the new items.
+    #   @param clientData [Wx::ClientData]  Array of client data pointers of the same size as items to associate with the new items.
     #   @return [Integer]
     def insert(*args) end
     
     # @overload set(items)
     #   Replaces the current control contents with the given items.
+    #   
     #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
     #   @param items [Array<String>]  Array of strings to insert.
     #   @return [void]
     # @overload set(items, clientData)
     #   Replaces the current control contents with the given items.
+    #   
     #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
     #   @param items [Array<String>]  Array of strings to insert.
-    #   @param clientData [Array]  Array of client data pointers of the same size as items to associate with the new items.
+    #   @param clientData [Wx::ClientData]  Array of client data pointers of the same size as items to associate with the new items.
     #   @return [void]
     def set(*args) end
     
     # Deletes an item from the control.
+    # 
     # The client data associated with the item will be also deleted if it is owned by the control. Note that it is an error (signalled by an assert failure in debug builds) to remove an item with the index negative or greater or equal than the number of items in the control.
     # If there is a currently selected item below the item being deleted, i.e. if {Wx::HTML::SimpleHtmlListBox#get_selection} returns a valid index greater than or equal to n, the selection is invalidated when this function is called. However if the selected item appears before the item being deleted, the selection is preserved unchanged.
     # @see Wx::HTML::SimpleHtmlListBox#clear 
@@ -274,11 +295,28 @@ module Wx::HTML
     # @return [void]
     def delete(n) end
     
+    # Returns the client object associated with the given item and transfers its ownership to the caller.
+    # 
+    # This method, unlike {Wx::HTML::SimpleHtmlListBox#get_client_object}, expects the caller to delete the returned pointer. It also replaces the internally stored pointer with NULL, i.e. completely detaches the client object pointer from the control.
+    # It's an error to call this method unless {Wx::HTML::SimpleHtmlListBox#has_client_object_data} returns true.
+    # 
+    # The associated client object pointer to be deleted by caller or NULL.
+    # @param n [Integer]  The zero-based item index.
+    # @return [Object]
+    def detach_client_object(n) end
+    
     # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
     # @return [Boolean]
     def has_client_data; end
     alias_method :has_client_data?, :has_client_data
     
+    # Returns true, if object data is associated with the items of the control.
+    # 
+    # Object data pointers have the type <code>wxClientData*</code> instead of <code>void*</code> and, importantly, are owned by the control, i.e. will be deleted by it, unlike their untyped counterparts.
+    # @return [Boolean]
+    def has_client_object_data; end
+    alias_method :has_client_object_data?, :has_client_object_data
+    
   end # SimpleHtmlListBox
   
 

data/lib/wx/doc/gen/html/html_printout.rb

@@ -7,10 +7,10 @@
 module Wx::HTML
 
   # This class serves as printout class for HTML documents.
-  # === 
   # 
   # Category:  {Wx::HTML}, Printing Framework
   # 
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_HTML
   class HtmlPrintout < Printout
   
     # Constructor.
@@ -19,6 +19,7 @@ module Wx::HTML
     def initialize(title=("Wx::PRT::Printout")) end
     
     # This function sets font sizes and faces.
+    # 
     # See {Wx::HTML::HtmlWindow#set_fonts} for detailed description.
     # @param normal_face [String] 
     # @param fixed_face [String] 
@@ -27,6 +28,7 @@ module Wx::HTML
     def set_fonts(normal_face, fixed_face, sizes=nil) end
     
     # Set page footer.
+    # 
     # The following macros can be used inside it:
     # 
     # - @DATE@ is replaced by the current date in default format
@@ -41,6 +43,7 @@ module Wx::HTML
     alias_method :footer=, :set_footer
     
     # Set page header.
+    # 
     # The following macros can be used inside it:
     # 
     # - @DATE@ is replaced by the current date in default format
@@ -55,6 +58,7 @@ module Wx::HTML
     alias_method :header=, :set_header
     
     # Prepare the class for printing this HTML <b>file</b>.
+    # 
     # The file may be located on any virtual file system or it may be normal file.
     # @param htmlfile [String] 
     # @return [void]
@@ -71,6 +75,7 @@ module Wx::HTML
     
     # @overload set_margins(top=25.2, bottom=25.2, left=25.2, right=25.2, spaces=5)
     #   Sets margins in millimeters.
+    #   
     #   Defaults to 1 inch for margins and 0.5cm for space between text and header and/or footer.
     #   @param top [Float] 
     #   @param bottom [Float] 
@@ -86,6 +91,7 @@ module Wx::HTML
     alias_method :margins=, :set_margins
     
     # Adds a filter to the static list of filters for {Wx::HTML::HtmlPrintout}.
+    # 
     # See {Wx::HTML::HtmlFilter} for further information.
     # @param filter [Wx::HTML::HtmlFilter] 
     # @return [void]

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

@@ -10,6 +10,7 @@ module Wx::HTML
   # 
   # 
   # 
+  # @wxrb_require USE_HTML
   class HtmlURLType < Wx::Enum
   
     # 
@@ -42,6 +43,7 @@ module Wx::HTML
   # 
   # 
   # 
+  # @wxrb_require USE_HTML
   class HtmlOpeningStatus < Wx::Enum
   
     # Open the requested URL.
@@ -71,11 +73,17 @@ module Wx::HTML
   EVT_HTML_LINK_CLICKED = 10350
   
   # {Wx::HTML::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 {Wx::HTML::HtmlWindow#set_page} with raw HTML, {Wx::HTML::HtmlWindow#load_page} with a {Wx::FileSystem} location or {Wx::HTML::HtmlWindow#load_file} with a filename.
-  # If you want complete HTML/CSS support as well as a Javascript engine, consider using {Wx::WebView} instead.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>If you want complete HTML/CSS support as well as a Javascript engine, consider using {Wx::WebView} instead.
+  # </p>
+  # </div>
   # 
   # {Wx::HTML::HtmlWindow} uses the {Wx::Image} class for displaying images, so you need to initialize the handlers for any image formats you use before loading a page. See {Wx::InitAllImageHandlers} and {Wx::Image.add_handler}.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -85,7 +93,7 @@ module Wx::HTML
   # 
   # - {Wx::HTML::HW_NO_SELECTION}: Don't allow the user to select text. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
   # Event handler methods for events emitted by this class:
@@ -96,13 +104,12 @@ module Wx::HTML
   # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): A {Wx::HTML::HtmlCell} which contains a hyperlink was clicked. 
   # 
-  # === 
-  # 
   # Category:  {Wx::HTML}
   # @see Wx::HTML::HtmlLinkEvent
   # @see  Wx::HTML::HtmlCellEvent 
   # 
   # 
+  # @wxrb_require USE_HTML
   class HtmlWindow < ScrolledWindow
   
     # @overload initialize()
@@ -110,6 +117,7 @@ module Wx::HTML
     #   @return [Wx::HTML::HtmlWindow]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HTML::HW_DEFAULT_STYLE, name=("HTML_WINDOW"))
     #   Constructor.
+    #   
     #   The parameters are the same as Wx::Scrolled#initialize constructor.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -121,6 +129,7 @@ module Wx::HTML
     def initialize(*args) end
     
     # Appends HTML fragment to currently displayed text and refreshes the window.
+    # 
     # false if an error occurred, true otherwise.
     # @param source [String]  HTML code fragment
     # @return [Boolean]
@@ -128,6 +137,7 @@ module Wx::HTML
     
     # Returns pointer to the top-level container.
     # 
+    # 
     # @see Cells and Containers
     # @see  Printing Framework Overview 
     # @return [Wx::HTML::HtmlContainerCell]
@@ -135,12 +145,14 @@ module Wx::HTML
     alias_method :internal_representation, :get_internal_representation
     
     # Returns anchor within currently opened page (see {Wx::HTML::HtmlWindow#get_opened_page}).
+    # 
     # If no page is opened or if the displayed page wasn't produced by call to {Wx::HTML::HtmlWindow#load_page}, empty string is returned.
     # @return [String]
     def get_opened_anchor; end
     alias_method :opened_anchor, :get_opened_anchor
     
     # Returns full location of the opened page.
+    # 
     # If no page is opened or if the displayed page wasn't produced by call to {Wx::HTML::HtmlWindow#load_page}, empty string is returned.
     # @return [String]
     def get_opened_page; end
@@ -157,16 +169,19 @@ module Wx::HTML
     alias_method :related_frame, :get_related_frame
     
     # Moves back to the previous page.
+    # 
     # Only pages displayed using {Wx::HTML::HtmlWindow#load_page} are stored in history list.
     # @return [Boolean]
     def history_back; end
     
     # Returns true if it is possible to go back in the history i.e.
+    # 
     # {Wx::HTML::HtmlWindow#history_back} won't fail.
     # @return [Boolean]
     def history_can_back; end
     
     # Returns true if it is possible to go forward in the history i.e.
+    # 
     # {Wx::HTML::HtmlWindow#history_forward} won't fail.
     # @return [Boolean]
     def history_can_forward; end
@@ -176,11 +191,13 @@ module Wx::HTML
     def history_clear; end
     
     # Moves to next page in history.
+    # 
     # Only pages displayed using {Wx::HTML::HtmlWindow#load_page} are stored in history list.
     # @return [Boolean]
     def history_forward; end
     
     # Loads an HTML page from a file and displays it.
+    # 
     # false if an error occurred, true otherwise
     # @see Wx::HTML::HtmlWindow#load_page 
     # @param filename [String] 
@@ -188,6 +205,7 @@ module Wx::HTML
     def load_file(filename) end
     
     # Unlike {Wx::HTML::HtmlWindow#set_page} this function first loads the HTML page from location and then displays it.
+    # 
     # false if an error occurred, true otherwise
     # @see Wx::HTML::HtmlWindow#load_file 
     # @param location [String]  The address of the document. See the wxFileSystem Overview for details on the address format and {Wx::FileSystem} for a description of how the file is opened.
@@ -195,6 +213,7 @@ module Wx::HTML
     def load_page(location) end
     
     # 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 {Wx::HTML::HtmlWindow#on_opening_url} returns {Wx::HTML::HtmlOpeningStatus::HTML_OPEN}. This method is called by Wx::HtmlParser::OpenURL.
     # You can override {Wx::HTML::HtmlWindow#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}.
     # 
@@ -218,6 +237,7 @@ module Wx::HTML
     def on_set_title(title) end
     
     # This reads custom settings from {Wx::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 {Wx::HTML::HtmlWindow#set_fonts}, {Wx::HTML::HtmlWindow#set_borders}.
     # @param cfg [Wx::ConfigBase]  {Wx::Config} from which you want to read the configuration.
     # @param path [String]  Optional path in config tree. If not given current path is used.
@@ -226,12 +246,14 @@ module Wx::HTML
     
     # Selects all text in the window.
     # 
+    # 
     # @see Wx::HTML::HtmlWindow#select_line
     # @see  Wx::HTML::HtmlWindow#select_word 
     # @return [void]
     def select_all; end
     
     # 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.
     # @see Wx::HTML::HtmlWindow#select_all
     # @see  Wx::HTML::HtmlWindow#select_word 
@@ -240,6 +262,7 @@ module Wx::HTML
     def select_line(pos) end
     
     # 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.
     # @see Wx::HTML::HtmlWindow#select_all
     # @see  Wx::HTML::HtmlWindow#select_line 
@@ -248,11 +271,13 @@ module Wx::HTML
     def select_word(pos) end
     
     # Returns the current selection as plain text.
+    # 
     # Returns an empty string if no text is currently selected.
     # @return [String]
     def selection_to_text; end
     
     # This function sets the space between border of window and HTML contents.
+    # 
     # See image:
     # @param b [Integer]  indentation from borders in pixels
     # @return [void]
@@ -260,6 +285,7 @@ module Wx::HTML
     alias_method :borders=, :set_borders
     
     # This function sets font sizes and faces.
+    # 
     # See Wx::HtmlDCRenderer::SetFonts for detailed description.
     # @see SetSize() 
     # @param normal_face [String] 
@@ -269,6 +295,7 @@ module Wx::HTML
     def set_fonts(normal_face, fixed_face, sizes=nil) end
     
     # Sets default font sizes and/or default font size.
+    # 
     # See Wx::HtmlDCRenderer::SetStandardFonts for detailed description.
     # @see Wx::HTML::HtmlWindow#set_fonts 
     # @param size [Integer] 
@@ -279,6 +306,7 @@ module Wx::HTML
     alias_method :standard_fonts=, :set_standard_fonts
     
     # Sets the source of a page and displays it, for example:
+    # 
     # ```ruby
     #   htmlwin.set_page('<html><body>Hello, world!</body></html>')
     # ```
@@ -292,6 +320,7 @@ module Wx::HTML
     alias_method :page=, :set_page
     
     # 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.
     # @param frame [Wx::Frame] 
     # @param format [String] 
@@ -300,11 +329,13 @@ module Wx::HTML
     
     # @overload set_related_status_bar(index)
     #   <b>After</b> calling {Wx::HTML::HtmlWindow#set_related_frame}, this sets statusbar slot where messages will be displayed.
+    #   
     #   (Default is -1 = no messages.)
     #   @param index [Integer]  Statusbar slot number (0..n)
     #   @return [void]
     # @overload set_related_status_bar(statusbar, index=0)
     #   <b>Sets</b> the associated statusbar where messages will be displayed.
+    #   
     #   Call this instead of {Wx::HTML::HtmlWindow#set_related_frame} if you want statusbar updates only, no changing of the frame title.
     #   @param statusbar [Wx::StatusBar]  Statusbar pointer
     #   @param index [Integer]  Statusbar slot number (0..n)
@@ -317,6 +348,7 @@ module Wx::HTML
     def to_text; end
     
     # Saves custom settings into {Wx::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 {Wx::HTML::HtmlWindow#set_fonts}, {Wx::HTML::HtmlWindow#set_borders}.
     # @param cfg [Wx::ConfigBase]  {Wx::Config} to which you want to save the configuration.
@@ -325,6 +357,7 @@ module Wx::HTML
     def write_customization(cfg, path=('')) end
     
     # Adds an input filter to the static list of available filters.
+    # 
     # These filters are present by default:
     # 
     # ```
@@ -344,6 +377,7 @@ module Wx::HTML
     def self.get_default_html_cursor(type) end
     
     # 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.
     # @param type [Integer]  HTMLCursor type to retrieve.
     # @param cursor [Wx::Cursor]  The default cursor for the specified cursor type.
@@ -353,13 +387,14 @@ module Wx::HTML
   end # HtmlWindow
   
   # This class is the parent class of input filters for {Wx::HTML::HtmlWindow}.
+  # 
   # It allows you to read and display files of different file formats.
-  # === 
   # 
   # Category:  {Wx::HTML}
   # @see Input Filters 
   # 
   # 
+  # @wxrb_require USE_HTML
   class HtmlFilter < Object
   
     # Constructor.
@@ -367,6 +402,7 @@ module Wx::HTML
     def initialize; end
     
     # Returns true if this filter is capable of reading file file.
+    # 
     # Example: 
     # ```ruby
     #   class MyFilter < Wx::HTML::HtmlFilter
@@ -385,6 +421,7 @@ module Wx::HTML
     alias_method :can_read?, :can_read
     
     # Reads the file and returns string with HTML document.
+    # 
     # Example: 
     # ```ruby
     #   class MyFilter < Wx::HTML::HtmlFilter

data/lib/wx/doc/gen/hyperlink_ctrl.rb

@@ -26,10 +26,11 @@ module Wx
   EVT_HYPERLINK = 10023
   
   # This class shows a static text element which links to an URL.
+  # 
   # Appearance and behaviour is completely customizable.
   # In fact, when the user clicks on the hyperlink, a {Wx::HyperlinkEvent} is sent but if that event is not handled (or it's skipped; see {Wx::Event#skip}), then a call to {launch_default_browser} is done with the hyperlink's URL.
   # Note that standard {Wx::Window} functions like {Wx::Window#set_background_colour}, {Wx::Window#set_font}, {Wx::Window#set_cursor}, {Wx::Window#set_label} can be used to customize appearance of the hyperlink.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -43,30 +44,31 @@ module Wx
   # 
   # - {Wx::HL_DEFAULT_STYLE}: The default style for {Wx::HyperlinkCtrl}: {Wx::Border::BORDER_NONE}|{Wx::HL_CONTEXTMENU}|{Wx::HL_ALIGN_CENTRE}. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): The hyperlink was (left) clicked. If this event is not handled in user's code (or it's skipped; see {Wx::Event#skip}), then a call to {Wx::LaunchDefaultBrowser} is done with the hyperlink's URL. 
   # 
-  # Currently this class is implemented using native support in wxGTK and wxMSW and a generic version is used by the other ports.
-  # === 
+  # Currently this class is implemented using native support in WXGTK and WXMSW and a generic version is used by the other ports.
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::URL
   # @see  Wx::HyperlinkEvent 
   # 
   # 
+  # @wxrb_require USE_HYPERLINKCTRL
   class HyperlinkCtrl < Control
   
     # @overload initialize()
     #   @return [Wx::HyperlinkCtrl]
     # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HYPERLINK_CTRL_NAME_STR)
     #   Constructor.
+    #   
     #   See {Wx::HyperlinkCtrl#create} for more info.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -138,7 +140,6 @@ module Wx
     # @param visited [Boolean] 
     # @return [void]
     def set_visited(visited=true) end
-    alias_method :visited=, :set_visited
     
     # Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
     # @param colour [Wx::Colour,String,Symbol]