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

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

@@ -19,13 +19,18 @@ module Wx::HTML
   PAGE_ALL = 2
   
   # This class provides very simple interface to printing architecture.
+  # 
   # It allows you to print HTML documents using only a few commands.
-  # Do not create this class on the stack only. You should create an instance on app startup and use this instance for all printing operations. The reason is that this class stores various settings in it.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Do not create this class on the stack only. You should create an instance on app startup and use this instance for all printing operations. The reason is that this class stores various settings in it.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::HTML}, Printing Framework
   # 
+  # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_HTML
   class HtmlEasyPrinting < Object
   
     # Controls when the print dialog should be shown.
@@ -34,6 +39,7 @@ module Wx::HTML
     # @see Wx::HTML::HtmlEasyPrinting#set_prompt_mode
     # 
     # 
+    # @wxrb_require USE_PRINTING_ARCHITECTURE,USE_HTML
     class PromptMode < Wx::Enum
     
       # Do not show the print dialog.
@@ -62,6 +68,7 @@ module Wx::HTML
     alias_method :name, :get_name
     
     # Returns a pointer to {Wx::PRT::PageSetupDialogData} instance used by this class.
+    # 
     # You can set its parameters (via SetXXXX methods).
     # @return [Wx::PRT::PageSetupDialogData]
     def get_page_setup_data; end
@@ -73,6 +80,7 @@ module Wx::HTML
     alias_method :parent_window, :get_parent_window
     
     # Returns pointer to {Wx::PRT::PrintData} instance used by this class.
+    # 
     # You can set its parameters (via SetXXXX methods).
     # @return [Wx::PRT::PrintData]
     def get_print_data; end
@@ -83,12 +91,14 @@ module Wx::HTML
     def page_setup; end
     
     # Preview HTML file.
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmlfile [String] 
     # @return [Boolean]
     def preview_file(htmlfile) end
     
     # Preview HTML text (not file!).
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmltext [String]  HTML text.
     # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
@@ -96,12 +106,14 @@ module Wx::HTML
     def preview_text(htmltext, basepath=('')) end
     
     # Print HTML file.
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmlfile [String] 
     # @return [Boolean]
     def print_file(htmlfile) end
     
     # Print HTML text (not file!).
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmltext [String]  HTML text.
     # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
@@ -109,6 +121,7 @@ module Wx::HTML
     def print_text(htmltext, basepath=('')) end
     
     # Sets fonts.
+    # 
     # See Wx::HtmlDCRenderer::SetFonts for detailed description.
     # @param normal_face [String] 
     # @param fixed_face [String] 
@@ -123,6 +136,7 @@ module Wx::HTML
     alias_method :name=, :set_name
     
     # Sets default font sizes and/or default font size.
+    # 
     # See Wx::HtmlDCRenderer::SetStandardFonts for detailed description.
     # @see Wx::HTML::HtmlEasyPrinting#set_fonts 
     # @param size [Integer] 
@@ -133,6 +147,7 @@ module Wx::HTML
     alias_method :standard_fonts=, :set_standard_fonts
     
     # Set page footer.
+    # 
     # The following macros can be used inside it: @DATE@ is replaced by the current date in default format @PAGENUM@ is replaced by page number @PAGESCNT@ is replaced by total number of pages @TIME@ is replaced by the current time in default format @TITLE@ is replaced with the title of the document
     # @param footer [String]  HTML text to be used as footer.
     # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
@@ -141,6 +156,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
@@ -161,9 +177,10 @@ module Wx::HTML
     alias_method :parent_window=, :set_parent_window
     
     # Enable or disable showing the dialog before printing.
+    # 
     # The prompt mode determines the value of the prompt parameter passed to {Wx::PRT::Printer#print} when it is called by this class.
     # Default prompt mode value is Prompt_Always.
-    # @param promptMode [Wx::wxHtmlEasyPrinting::PromptMode] 
+    # @param promptMode [Wx::HtmlEasyPrinting::PromptMode] 
     # @return [void]
     def set_prompt_mode(promptMode) end
     alias_method :prompt_mode=, :set_prompt_mode

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

@@ -67,6 +67,7 @@ module Wx::HTML
   # 
   # 
   # 
+  # @wxrb_require USE_HELP,USE_HTML
   class HelpSearchMode < Wx::Enum
   
     # Search the index only.
@@ -80,11 +81,11 @@ module Wx::HTML
   end # HelpSearchMode
   
   # This help controller provides an easy way of displaying HTML help in your application (see HTML Sample, test example).
+  # 
   # The help system is based on <b>books</b> (see {Wx::HTML::HtmlHelpController#add_book}). A book is a logical section of documentation (for example "User's Guide" or "Programmer's Guide" or "C++ Reference" or "wxWidgets Reference"). The help controller can handle as many books as you want.
   # Although this class has an API compatible with other wxWidgets help controllers as documented by {Wx::HelpController}, it is recommended that you use the enhanced capabilities of {Wx::HTML::HtmlHelpController}'s API.
   # {Wx::HTML} uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its native format. The file format is described in Help Files Format. The directory helpfiles in the HTML Sample contains sample project files.
   # Note that the Microsoft's HTML Help Workshop (http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc) also runs on other platforms using WINE (http://www.winehq.org/) and it can be used to create the .hpp, .hhk and .hhc files through a friendly GUI. The commercial tool HelpBlocks (http://www.helpblocks.com) can also create these files.
-  # === 
   # 
   # Category:  {Wx::HELP}, {Wx::HTML}
   # @see wxBestHelpController
@@ -94,6 +95,7 @@ module Wx::HTML
   # @see  Wx::HtmlModalHelp 
   # 
   # 
+  # @wxrb_require USE_HELP,USE_HTML
   class HtmlHelpController < Object
   
     # @overload initialize(style=Wx::HF_DEFAULT_STYLE, parentWindow=nil)
@@ -127,6 +129,7 @@ module Wx::HTML
     
     # @overload add_book(bookFile, showWaitMsg=false)
     #   Adds a book (i.e.
+    #   
     #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
     #   This must be called at least once before displaying any help. bookFile or bookUrl may be either <code>".hhp"</code> file or a ZIP archive that contains an arbitrary number of <code>".hhp"</code> files in its top-level directory. This ZIP archive must have <code>".zip"</code> or <code>".htb"</code> extension (the latter stands for "HTML book"). In other words, 
     #   ```ruby
@@ -138,6 +141,7 @@ module Wx::HTML
     #   @return [Boolean]
     # @overload add_book(bookUrl, showWaitMsg=false)
     #   Adds a book (i.e.
+    #   
     #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
     #   See the other overload for additional info.
     #   @param bookUrl [String]  Help book URL (note that syntax of filename and URL is different on most platforms).
@@ -147,6 +151,7 @@ module Wx::HTML
     
     # @overload display(x)
     #   Displays page x.
+    #   
     #   This is THE important function - it is used to display the help in application. You can specify the page in many ways:
     #   
     #   - as direct filename of HTML document
@@ -179,8 +184,14 @@ module Wx::HTML
     def display_index; end
     
     # Displays the help window, focuses search panel and starts searching.
+    # 
     # Returns true if the keyword was found. Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
-    # {Wx::HTML::HtmlHelpController#keyword_search} searches only pages listed in <code>".hhc"</code> file(s). You should list all pages in the contents file.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>{Wx::HTML::HtmlHelpController#keyword_search} searches only pages listed in <code>".hhc"</code> file(s). You should list all pages in the contents file. 
+    # </p>
+    # </div>
     # @param keyword [String] 
     # @param mode [Wx::HelpSearchMode] 
     # @return [Boolean]
@@ -194,6 +205,7 @@ module Wx::HTML
     
     # Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.
     # 
+    # 
     # @see Wx::App#set_exit_on_frame_delete
     # @param enable [Boolean]  If true, the application will not quit unless the help frame is closed. Default is false, i.e. the application does exit if only the help window remains opened.
     # @return [void]
@@ -201,6 +213,7 @@ module Wx::HTML
     alias_method :should_prevent_app_exit=, :set_should_prevent_app_exit
     
     # Sets the path for storing temporary files - cached binary versions of index and contents files.
+    # 
     # These binary forms are much faster to read. Default value is empty string (empty string means that no cached data are stored). Note that these files are not deleted when program exits.
     # Once created these cached files will be used in all subsequent executions of your application. If cached files become older than corresponding <code>".hhp"</code> file (e.g. if you regenerate documentation) it will be refreshed.
     # @param path [String] 
@@ -209,6 +222,7 @@ module Wx::HTML
     alias_method :temp_dir=, :set_temp_dir
     
     # Sets format of title of the frame.
+    # 
     # Must contain exactly one "%s" (for title of displayed HTML page).
     # @param format [String] 
     # @return [void]
@@ -216,6 +230,7 @@ module Wx::HTML
     alias_method :title_format=, :set_title_format
     
     # Associates the config object with the controller.
+    # 
     # If there is associated config object, {Wx::HTML::HtmlHelpController} automatically reads and writes settings (including {Wx::HTML::HtmlWindow}'s settings) when needed. The only thing you must do is create {Wx::Config} object and call {Wx::HTML::HtmlHelpController#use_config}.
     # If you do not use {Wx::HTML::HtmlHelpController#use_config}, {Wx::HTML::HtmlHelpController} will use the default {Wx::Config} object if available (for details see {Wx::ConfigBase::Get} and {Wx::ConfigBase::Set}).
     # @param config [Wx::ConfigBase] 
@@ -235,6 +250,7 @@ module Wx::HTML
     alias_method :help_window, :get_help_window
     
     # Set the help window to be managed by this controller.
+    # 
     # This makes it possible to have a help window that might not be in a {Wx::HtmlHelpFrame} or dialog but is embedded in some other window in the application. Be sure to use the {Wx::HTML::HF_EMBEDDED} style in this case.
     # @param helpWindow [Wx::HTML::HtmlHelpWindow] 
     # @return [void]
@@ -242,12 +258,14 @@ module Wx::HTML
     alias_method :help_window=, :set_help_window
     
     # Displays the section as a popup window using a context id.
+    # 
     # Returns false if unsuccessful or not implemented.
     # @param contextId [Integer] 
     # @return [Boolean]
     def display_context_popup(contextId) end
     
     # Displays the text in a popup window, if possible.
+    # 
     # Returns false if unsuccessful or not implemented.
     # @param text [String] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
@@ -255,12 +273,14 @@ module Wx::HTML
     def display_text_popup(text, pos) end
     
     # Returns the window to be used as the parent for the help window.
+    # 
     # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
     # @return [Wx::Window]
     def get_parent_window; end
     alias_method :parent_window, :get_parent_window
     
     # Initializes the help instance with a help filename.
+    # 
     # Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.
     # You may omit the file extension and a suitable one will be chosen. For {Wx::HTML::HtmlHelpController}, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.
     # @param file [String] 
@@ -268,11 +288,13 @@ module Wx::HTML
     def init(file) end
     
     # Overridable member called when this application's viewer is quit by the user.
+    # 
     # This does not work for all help controllers.
     # @return [void]
     def on_quit; end
     
     # Set the parameters of the frame window.
+    # 
     # For {Wx::HTML::HtmlHelpController}, titleFormat specifies the title string format (with s being replaced by the actual page title) and size and position specify the geometry of the frame.
     # For all other help controllers this function has no effect.
     # Finally, newFrameEachTime is always ignored currently.
@@ -284,6 +306,7 @@ module Wx::HTML
     def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
     
     # Sets the window to be used as the parent for the help window.
+    # 
     # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
     # @param parentWindow [Wx::Window] 
     # @return [void]
@@ -291,6 +314,7 @@ module Wx::HTML
     alias_method :parent_window=, :set_parent_window
     
     # Sets detailed viewer information.
+    # 
     # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
     # 
     # ```ruby

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

@@ -7,11 +7,12 @@
 module Wx::HTML
 
   # This class is used by {Wx::HTML::HtmlHelpController} and {Wx::HtmlHelpFrame} to access HTML help items.
+  # 
   # It is internal class and should not be used directly - except for the case you're writing your own HTML help controller.
-  # === 
   # 
   # Category:  {Wx::HELP}, {Wx::HTML}
   # 
+  # @wxrb_require USE_HELP,USE_HTML
   class HtmlHelpData < Object
   
     # Constructor.
@@ -19,6 +20,7 @@ module Wx::HTML
     def initialize; end
     
     # Adds new book.
+    # 
     # book_url is URL (not filename!) of HTML help project (hhp) or ZIP file that contains arbitrary number of .hhp projects (this zip file can have either .zip or .htb extension, htb stands for "html book").
     # Returns success.
     # @param book_url [String] 
@@ -51,6 +53,7 @@ module Wx::HTML
     alias_method :index_array, :get_index_array
     
     # Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
+    # 
     # (This is turned off by default and you can enable this feature by setting non-empty temp dir.)
     # @param path [String] 
     # @return [void]
@@ -63,7 +66,9 @@ module Wx::HTML
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_HELP,USE_HTML
   class HtmlBookRecord < ::Object
   
     # @param bookfile [String] 
@@ -128,7 +133,9 @@ module Wx::HTML
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_HELP,USE_HTML
   class HtmlHelpDataItem < ::Object
   
     # @return [Wx::HTML::HtmlHelpDataItem]

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

@@ -107,6 +107,7 @@ module Wx::HTML
   ID_HTML_COUNTINFO = 6033
   
   # This class is used by {Wx::HTML::HtmlHelpController} to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.
+  # 
   # For example: 
   # ```ruby
   #   # @embeddedHelpWindow is a wxHtmlHelpWindow
@@ -123,10 +124,10 @@ module Wx::HTML
   # ```
   # 
   # You should pass the style {Wx::HTML::HF_EMBEDDED} to the style parameter of {Wx::HTML::HtmlHelpController} to allow the embedded window to be destroyed independently of the help controller.
-  # === 
   # 
   # Category:  {Wx::HELP}, {Wx::HTML}
   # 
+  # @wxrb_require USE_HELP,USE_HTML
   class HtmlHelpWindow < Window
   
     # @overload initialize(data=nil)
@@ -134,6 +135,7 @@ module Wx::HTML
     #   @return [Wx::HTML::HtmlHelpWindow]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::TAB_TRAVERSAL|Wx::Border::BORDER_NONE), helpStyle=Wx::HF_DEFAULT_STYLE, data=nil)
     #   Constructor.
+    #   
     #   For the values of helpStyle, please see the documentation for {Wx::HTML::HtmlHelpController}.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -146,6 +148,7 @@ module Wx::HTML
     def initialize(*args) end
     
     # Creates the help window.
+    # 
     # See the constructor for a description of the parameters.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -158,6 +161,7 @@ module Wx::HTML
     
     # @overload display(x)
     #   Displays page x.
+    #   
     #   If not found it will give the user the choice of searching books. Looking for the page runs in these steps:
     #   
     #   - try to locate file named x (if x is for example "doc/howto.htm")
@@ -187,6 +191,7 @@ module Wx::HTML
     alias_method :data, :get_data
     
     # Search for given keyword.
+    # 
     # Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
     # @param keyword [String] 
     # @param mode [Wx::HelpSearchMode] 
@@ -195,6 +200,7 @@ module Wx::HTML
     
     # Reads the user's settings for this window.
     # 
+    # 
     # @see Wx::HTML::HtmlHelpController#read_customization 
     # @param cfg [Wx::ConfigBase] 
     # @param path [String] 
@@ -203,6 +209,7 @@ module Wx::HTML
     
     # Saves the user's settings for this window.
     # 
+    # 
     # @see Wx::HTML::HtmlHelpController#write_customization 
     # @param cfg [Wx::ConfigBase] 
     # @param path [String] 
@@ -210,6 +217,7 @@ module Wx::HTML
     def write_customization(cfg, path=('')) end
     
     # Refresh all panels.
+    # 
     # This is necessary if a new book was added.
     # @return [void]
     def refresh_lists; end

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

@@ -7,17 +7,17 @@
 module Wx::HTML
 
   # This event class is used for the events generated by {Wx::HTML::HtmlWindow}.
-  # === Events using this class
+  # 
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlLinkEvent} events.
   # Event handler methods:
   # 
   # - {Wx::EvtHandler#evt_html_link_clicked}(id, meth = nil, &block): User clicked on a hyperlink. 
   # 
-  # === 
-  # 
   # Category:  {Wx::HTML}, {Wx::Events}
   # 
+  # @wxrb_require USE_HTML
   class HtmlLinkEvent < CommandEvent
   
     # The constructor is not normally used by the user code.