wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -10,6 +10,7 @@ module Wx
   PU_CONTAINS_CONTROLS = 1
   
   # A special kind of top level window used for popup menus, combobox popups and such.
+  # 
   # ### Styles
   # 
   # This class supports the following styles:
@@ -40,6 +41,7 @@ module Wx
     def create(parent, flags=Wx::Border::BORDER_NONE) end
     
     # Move the popup window to the right position, i.e. such that it is entirely visible.
+    # 
     # The popup is positioned at ptOrigin + size if it opens below and to the right (default), at ptOrigin - sizePopup if it opens above and to the left etc.
     # @param ptOrigin [Array(Integer, Integer), Wx::Point]  Must be given in screen coordinates!
     # @param sizePopup [Array(Integer, Integer), Wx::Size]  The size of the popup window
@@ -49,6 +51,7 @@ module Wx
   end # PopupWindow
   
   # A {Wx::PopupWindow} which disappears automatically when the user clicks mouse outside it or if it loses focus in any other way.
+  # 
   # This window can be useful for implementing custom combobox-like controls for example.
   # 
   # Category:  Managed Windows
@@ -68,6 +71,7 @@ module Wx
     def initialize(*args) end
     
     # Popup the window (this will show it too).
+    # 
     # If focus is non-NULL, it will be kept focused while this window is shown if supported by the current platform, otherwise the popup itself will receive focus. In any case, the popup will disappear automatically if it loses focus because of a user action.
     # @see Wx::PopupTransientWindow#dismiss 
     # @param focus [Wx::Window] 
@@ -79,6 +83,7 @@ module Wx
     def dismiss; end
     
     # Called when a mouse is pressed while the popup is shown.
+    # 
     # Return true from here to prevent its normal processing by the popup (which consists in dismissing it if the mouse is clicked outside it).
     # @param event [Wx::MouseEvent] 
     # @return [Boolean]

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

@@ -33,6 +33,7 @@ module Wx
   # If supported by the platform this class will provide the platform's native progress dialog, else it will simply be the {Wx::GenericProgressDialog}.
   # 
   # 
+  # 
   # @wxrb_require USE_PROGRESSDLG
   class ProgressDialog < Dialog
   
@@ -64,6 +65,7 @@ module Wx
     def resume; end
     
     # Changes the maximum value of the progress meter given in the constructor.
+    # 
     # This function can only be called (with a positive value) if the value passed in the constructor was positive.
     # @param maximum [Integer] 
     # @return [void]
@@ -71,12 +73,14 @@ module Wx
     alias_method :range=, :set_range
     
     # Returns true if the "Cancel" button was pressed.
+    # 
     # Normally a Cancel button press is indicated by {Wx::ProgressDialog#update} returning false but sometimes it may be more convenient to check if the dialog was cancelled from elsewhere in the code and this function allows doing it.
     # It always returns false if the Cancel button is not shown at all.
     # @return [Boolean]
     def was_cancelled; end
     
     # Returns true if the "Skip" button was pressed.
+    # 
     # This is similar to {Wx::ProgressDialog#was_cancelled} but returns true if the "Skip" button was pressed, not the "Cancel" one.
     # @return [Boolean]
     def was_skipped; end

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

@@ -48,6 +48,7 @@ module Wx
   end # PropertySheetDialogFlags
   
   # This class represents a property sheet dialog: a tabbed dialog for showing settings.
+  # 
   # It is optimized to show flat tabs on PocketPC devices, and can be customized to use different controllers instead of the default notebook style.
   # To use this class, call {Wx::PropertySheetDialog#create} from your own Create function. Then call {Wx::PropertySheetDialog#create_buttons}, and create pages, adding them to the book control. Finally call {Wx::PropertySheetDialog#layout_dialog}.
   # For example:
@@ -83,6 +84,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   Call Create if using this form of constructor.
     #   @return [Wx::PropertySheetDialog]
     # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=Wx::DIALOG_NAME_STR)
@@ -114,6 +116,7 @@ module Wx
     def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=Wx::DIALOG_NAME_STR) end
     
     # Call this to create the buttons for the dialog.
+    # 
     # This calls {Wx::Dialog#create_button_sizer}, and the flags are the same.
     # 
     # <div class="wxrb-note">
@@ -139,15 +142,16 @@ module Wx
     # @param sizer [Wx::Sizer] 
     # @return [void]
     def set_inner_sizer(sizer) end
-    alias_method :inner_sizer=, :set_inner_sizer
     
     # Returns the sheet style.
+    # 
     # See {Wx::PropertySheetDialog#set_sheet_style} for allowed values.
     # @return [Integer]
     def get_sheet_style; end
     alias_method :sheet_style, :get_sheet_style
     
     # Call this to lay out the dialog.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>On PocketPC, this does nothing, since the dialog will be shown full-screen, and the layout will be done when the dialog receives a size event. 
@@ -158,6 +162,7 @@ module Wx
     def layout_dialog(centreFlags=Wx::Orientation::BOTH) end
     
     # Sets the book control used for the dialog.
+    # 
     # You will normally not need to use this.
     # @param bookCtrl [Wx::BookCtrlBase] 
     # @return [void]
@@ -165,6 +170,7 @@ module Wx
     alias_method :book_ctrl=, :set_book_ctrl
     
     # You can customize the look and feel of the dialog by setting the sheet style.
+    # 
     # It is a bit list of the {Wx::PropertySheetDialogFlags} values.
     # @param style [Integer] 
     # @return [void]

data/lib/wx/doc/gen/prt/page_setup_dialog.rb

@@ -7,6 +7,7 @@
 module Wx::PRT
 
   # This class represents the page setup common dialog.
+  # 
   # The page setup dialog contains controls for paper size (letter, A4, A5 etc.), orientation (landscape or portrait), and, only under Windows currently, controls for setting left, top, right and bottom margin sizes in millimetres.
   # The exact appearance of this dialog varies among the platforms as a native dialog is used when available (currently the case for all major platforms).
   # When the dialog has been closed, you need to query the {Wx::PRT::PageSetupDialogData} object associated with the dialog.
@@ -22,6 +23,7 @@ module Wx::PRT
   class PageSetupDialog < Object
   
     # Constructor.
+    # 
     # Pass a parent window, and optionally a pointer to a block of page setup data, which will be copied to the print dialog's internal data.
     # @param parent [Wx::Window] 
     # @param data [Wx::PRT::PageSetupDialogData] 

data/lib/wx/doc/gen/prt/post_script_dc.rb

@@ -7,6 +7,7 @@
 module Wx::PRT
 
   # This defines the wxWidgets Encapsulated PostScript device context, which can write PostScript files on any platform.
+  # 
   # See {Wx::DC} for descriptions of the member functions.
   # 
   # ## Starting a document

data/lib/wx/doc/gen/prt/preview_frame.rb

@@ -7,6 +7,7 @@
 module Wx::PRT
 
   # This class provides the default method of managing the print preview interface.
+  # 
   # Member functions may be overridden to replace functionality, or the class may be used without derivation.
   # 
   # Category:  Printing Framework
@@ -19,6 +20,7 @@ module Wx::PRT
   class PreviewFrame < Frame
   
     # Constructor.
+    # 
     # Pass a print preview object plus other normal frame arguments. The print preview object will be destroyed by the frame when it closes.
     # Note that size typically should not be specified explicitly to let the frame use its default size, adapted to its contents.
     # @param preview [Wx::PrintPreview] 
@@ -32,12 +34,14 @@ module Wx::PRT
     def initialize(preview, parent, title=("PRINT PREVIEW"), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end
     
     # Initializes the frame elements and prepares for showing it.
+    # 
     # Calling this method is equivalent to calling {Wx::PRT::PreviewFrame#initialize_with_modality} with {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_AppModal} argument, please see its documentation for more details.
     # Please notice that this function is virtual mostly for backwards compatibility only, there is no real need to override it as it's never called by wxWidgets itself.
     # @return [void]
     def init; end
     
     # Initializes the frame elements and prepares for showing it with the given modality kind.
+    # 
     # This method creates the frame elements by calling {Wx::PRT::PreviewFrame#create_canvas} and {Wx::PRT::PreviewFrame#create_control_bar} methods (which may be overridden to customize them) and prepares to show the frame according to the value of kind parameter:
     # 
     # - If it is {Wx::PRT::PreviewFrameModalityKind::PreviewFrame_AppModal}, all the other application windows will be disabled when this frame is shown. This is the same behaviour as that of simple {Wx::PRT::PreviewFrame#initialize}.

data/lib/wx/doc/gen/prt/print_abort_dialog.rb

@@ -105,6 +105,7 @@ module Wx::PRT
   # The dialog created by default by the print framework that enables aborting the printing process.
   # 
   # 
+  # 
   # @wxrb_require USE_PRINTING_ARCHITECTURE
   class PrintAbortDialog < Dialog
   

data/lib/wx/doc/gen/prt/print_data.rb

@@ -78,6 +78,7 @@ module Wx::PRT
   end # PrintBin
   
   # This class holds a variety of information related to printers and printer device contexts.
+  # 
   # This class is used to create a {Wx::PRT::PrinterDC} and a {Wx::PRT::PostScriptDC}. It is also used as a data member of {Wx::PRT::PrintDialogData} and {Wx::PRT::PageSetupDialogData}, as part of the mechanism for transferring data between the print dialogs and the application.
   # 
   # Category:  Printing Framework, Data Structures
@@ -106,6 +107,7 @@ module Wx::PRT
     def initialize(*args) end
     
     # Returns the current bin (papersource).
+    # 
     # By default, the system is left to select the bin ({Wx::PRT::PrintBin::PRINTBIN_DEFAULT} is returned).
     # See {Wx::PRT::PrintData#set_bin} for the full list of bin values.
     # @return [Wx::PrintBin]
@@ -123,6 +125,7 @@ module Wx::PRT
     alias_method :colour, :get_colour
     
     # Returns the duplex mode.
+    # 
     # One of {Wx::DuplexMode::DUPLEX_SIMPLEX}, {Wx::DuplexMode::DUPLEX_HORIZONTAL}, {Wx::DuplexMode::DUPLEX_VERTICAL}.
     # @return [Wx::DuplexMode]
     def get_duplex; end
@@ -134,6 +137,7 @@ module Wx::PRT
     alias_method :no_copies, :get_no_copies
     
     # Gets the orientation.
+    # 
     # This can be {Wx::PrintOrientation::LANDSCAPE} or {Wx::PrintOrientation::PORTRAIT}.
     # @return [Wx::PrintOrientation]
     def get_orientation; end
@@ -141,18 +145,21 @@ module Wx::PRT
     
     # Returns the paper size id.
     # 
+    # 
     # @see Wx::PRT::PrintData#set_paper_id 
     # @return [Wx::PaperSize]
     def get_paper_id; end
     alias_method :paper_id, :get_paper_id
     
     # Returns the printer name.
+    # 
     # If the printer name is the empty string, it indicates that the default printer should be used.
     # @return [Wx::String]
     def get_printer_name; end
     alias_method :printer_name, :get_printer_name
     
     # Returns the current print quality.
+    # 
     # This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:
     # 
     # - {Wx::PRINT_QUALITY_HIGH}
@@ -166,6 +173,7 @@ module Wx::PRT
     alias_method :quality, :get_quality
     
     # Returns true if the print data is valid for using in print dialogs.
+    # 
     # This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.
     # @return [Boolean]
     def is_ok; end
@@ -190,6 +198,7 @@ module Wx::PRT
     alias_method :colour=, :set_colour
     
     # Returns the duplex mode.
+    # 
     # One of {Wx::DuplexMode::DUPLEX_SIMPLEX}, {Wx::DuplexMode::DUPLEX_HORIZONTAL}, {Wx::DuplexMode::DUPLEX_VERTICAL}.
     # @param mode [Wx::DuplexMode] 
     # @return [void]
@@ -203,6 +212,7 @@ module Wx::PRT
     alias_method :no_copies=, :set_no_copies
     
     # Sets the orientation.
+    # 
     # This can be {Wx::PrintOrientation::LANDSCAPE} or {Wx::PrintOrientation::PORTRAIT}.
     # @param orientation [Wx::PrintOrientation] 
     # @return [void]
@@ -210,6 +220,7 @@ module Wx::PRT
     alias_method :orientation=, :set_orientation
     
     # Sets the paper id.
+    # 
     # This indicates the type of paper to be used. For a mapping between paper id, paper size and string name, see {Wx::PrintPaperDatabase} in <code>"paper.h"</code> (not yet documented).
     # @see Wx::PRT::PrintData#set_paper_size 
     # @param paperId [Wx::PaperSize] 
@@ -218,6 +229,7 @@ module Wx::PRT
     alias_method :paper_id=, :set_paper_id
     
     # Sets custom paper size.
+    # 
     # This method can be used to set up custom paper size. When using a standard size, prefer to use {Wx::PRT::PrintData#set_paper_id} instead.
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]
@@ -225,6 +237,7 @@ module Wx::PRT
     alias_method :paper_size=, :set_paper_size
     
     # Sets the printer name.
+    # 
     # This can be the empty string to indicate that the default printer should be used.
     # @param printerName [String] 
     # @return [void]
@@ -232,6 +245,7 @@ module Wx::PRT
     alias_method :printer_name=, :set_printer_name
     
     # Sets the desired print quality.
+    # 
     # This can be a positive integer, denoting the number of dots per inch, or one of the following identifiers:
     # 
     # - {Wx::PRINT_QUALITY_HIGH}
@@ -266,6 +280,7 @@ module Wx::PRT
   end # PrintData
   
   # This class holds information related to the visual characteristics of {Wx::PRT::PrintDialog}.
+  # 
   # It contains a {Wx::PRT::PrintData} object with underlying printing settings.
   # 
   # Category:  Printing Framework, Common Dialogs, Data Structures
@@ -363,6 +378,7 @@ module Wx::PRT
     alias_method :to_page, :get_to_page
     
     # Returns true if the print data is valid for using in print dialogs.
+    # 
     # This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.
     # @return [Boolean]
     def is_ok; end
@@ -411,6 +427,7 @@ module Wx::PRT
     alias_method :print_to_file=, :set_print_to_file
     
     # Selects the "Selection" radio button.
+    # 
     # The effect of printing the selection depends on how the application implements this command, if at all.
     # @param flag [Boolean] 
     # @return [void]
@@ -426,6 +443,7 @@ module Wx::PRT
   end # PrintDialogData
   
   # This class holds a variety of information related to {Wx::PRT::PageSetupDialog}.
+  # 
   # It contains a {Wx::PRT::PrintData} member which is used to hold basic printer configuration data (as opposed to the user-interface configuration settings stored by {Wx::PRT::PageSetupDialogData}).
   # 
   # Category:  Printing Framework, Data Structures
@@ -517,12 +535,14 @@ module Wx::PRT
     alias_method :margin_top_left, :get_margin_top_left
     
     # Returns the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+    # 
     # Units are in millimetres.
     # @return [Wx::Point]
     def get_min_margin_bottom_right; end
     alias_method :min_margin_bottom_right, :get_min_margin_bottom_right
     
     # Returns the left (x) and top (y) minimum margins the user can enter (Windows only).
+    # 
     # Units are in millimetres.
     # @return [Wx::Point]
     def get_min_margin_top_left; end
@@ -530,6 +550,7 @@ module Wx::PRT
     
     # Returns the paper id (stored in the internal {Wx::PRT::PrintData} object).
     # 
+    # 
     # @see Wx::PRT::PrintData#set_paper_id 
     # @return [Wx::PaperSize]
     def get_paper_id; end
@@ -545,6 +566,7 @@ module Wx::PRT
     alias_method :print_data, :get_print_data
     
     # Returns true if the print data associated with the dialog data is valid.
+    # 
     # This can return false on Windows if the current printer is not set, for example. On all other platforms, it returns true.
     # @return [Boolean]
     def is_ok; end
@@ -557,6 +579,7 @@ module Wx::PRT
     alias_method :default_info=, :set_default_info
     
     # Pass true if the page setup dialog will take its minimum margin values from the currently selected printer properties (Windows only).
+    # 
     # Units are in millimetres.
     # @param flag [Boolean] 
     # @return [void]
@@ -576,6 +599,7 @@ module Wx::PRT
     alias_method :margin_top_left=, :set_margin_top_left
     
     # Sets the right (x) and bottom (y) minimum margins the user can enter (Windows only).
+    # 
     # Units are in millimetres.
     # @param pt [Array(Integer, Integer), Wx::Point] 
     # @return [void]
@@ -583,6 +607,7 @@ module Wx::PRT
     alias_method :min_margin_bottom_right=, :set_min_margin_bottom_right
     
     # Sets the left (x) and top (y) minimum margins the user can enter (Windows only).
+    # 
     # Units are in millimetres.
     # @param pt [Array(Integer, Integer), Wx::Point] 
     # @return [void]
@@ -590,6 +615,7 @@ module Wx::PRT
     alias_method :min_margin_top_left=, :set_min_margin_top_left
     
     # Sets the paper size id.
+    # 
     # Calling this function overrides the explicit paper dimensions passed in {Wx::PRT::PageSetupDialogData#set_paper_size}.
     # @see Wx::PRT::PrintData#set_paper_id 
     # @param id [Wx::PaperSize] 
@@ -598,6 +624,7 @@ module Wx::PRT
     alias_method :paper_id=, :set_paper_id
     
     # Sets the paper size in millimetres.
+    # 
     # If a corresponding paper id is found, it will be set in the internal {Wx::PRT::PrintData} object, otherwise the paper size overrides the paper id.
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]

data/lib/wx/doc/gen/prt/print_dialog.rb

@@ -7,6 +7,7 @@
 module Wx::PRT
 
   # This class represents the print and print setup common dialogs.
+  # 
   # You may obtain a {Wx::PRT::PrinterDC} device context from a successfully dismissed print dialog.
   # 
   # Category:  Printing Framework
@@ -19,6 +20,7 @@ module Wx::PRT
   
     # @overload initialize(parent, data=nil)
     #   Constructor.
+    #   
     #   Pass a parent window, and optionally a pointer to a block of print data, which will be copied to the print dialog's print data.
     #   @see Wx::PRT::PrintDialogData 
     #   @param parent [Wx::Window] 
@@ -31,12 +33,14 @@ module Wx::PRT
     def initialize(*args) end
     
     # Returns the device context created by the print dialog, if any.
+    # 
     # When this function has been called, the ownership of the device context is transferred to the application, so it must then be deleted explicitly.
     # @return [Wx::DC]
     def get_print_dc; end
     alias_method :print_dc, :get_print_dc
     
     # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.
+    # 
     # After this function is called, a device context may be retrievable using {Wx::PRT::PrintDialog#get_print_dc}.
     # @return [Integer]
     def show_modal; end