wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This class encapsulates functions dealing with verifying the connection status of the workstation (connected to the Internet via a direct connection, connected through a modem or not connected at all) and to establish this connection if possible/required (i.e.
+  # 
   # in the case of the modem).
   # The program may also wish to be notified about the change in the connection status (for example, to perform some action when the user connects to the network the next time or, on the contrary, to stop receiving data from the net when the user hangs up the modem). For this, you need to use one of the event macros described below.
   # This class is different from other wxWidgets classes in that there is at most one instance of this class in the program accessed via {Wx::DialUpManager.create} and you can't create the objects of this class directly.
@@ -30,6 +31,7 @@ module Wx
   class DialUpManager < ::Object
   
     # Cancel dialing the number initiated with {Wx::DialUpManager#dial} with async parameter equal to true.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>This won't result in a DISCONNECTED event being sent.
@@ -40,6 +42,7 @@ module Wx
     def cancel_dialing; end
     
     # Dial the given ISP, use username and password to authenticate.
+    # 
     # The parameters are only used under Windows currently, for Unix you should use {Wx::DialUpManager#set_connect_command} to customize this functions behaviour.
     # If no nameOfISP is given, the function will select the default one (proposing the user to choose among all connections defined on this machine) and if no username and/or password are given, the function will try to do without them, but will ask the user if really needed.
     # If async parameter is false, the function waits until the end of dialing and returns true upon successful completion.
@@ -56,6 +59,7 @@ module Wx
     def disable_auto_check_online_status; end
     
     # Enable automatic checks for the connection status and sending of <code>wxEVT_DIALUP_CONNECTED/wxEVT_DIALUP_DISCONNECTED</code> events.
+    # 
     # The interval parameter is only for Unix where we do the check manually and specifies how often should we repeat the check (each minute by default). Under Windows, the notification about the change of connection status is sent by the system and so we don't do any polling and this parameter is ignored.
     # false if couldn't set up automatic check for online status.
     # @param nSeconds [Integer] 
@@ -63,6 +67,7 @@ module Wx
     def enable_auto_check_online_status(nSeconds=60) end
     
     # This function is only implemented under Windows.
+    # 
     # Fills the array with the names of all possible values for the first parameter to {Wx::DialUpManager#dial} on this machine and returns their number (may be 0).
     # @return [Array<String>]
     def get_isp_names; end
@@ -73,6 +78,7 @@ module Wx
     def hang_up; end
     
     # Returns true if the computer has a permanent network connection (i.e.
+    # 
     # \ is on a LAN) and so there is no need to use {Wx::DialUpManager#dial} function to go online.
     # 
     # <div class="wxrb-note">
@@ -86,12 +92,14 @@ module Wx
     
     # Returns true if (async) dialing is in progress.
     # 
+    # 
     # @see Wx::DialUpManager#dial 
     # @return [Boolean]
     def is_dialing; end
     alias_method :dialing?, :is_dialing
     
     # Returns true if the dialup manager was initialized correctly.
+    # 
     # If this function returns false, no other functions will work either, so it is a good idea to call this function and check its result before calling any other {Wx::DialUpManager} methods.
     # @return [Boolean]
     def is_ok; end
@@ -103,6 +111,7 @@ module Wx
     alias_method :online?, :is_online
     
     # This method is for Unix only.
+    # 
     # Sets the commands to start up the network and to hang up again.
     # @param commandDial [String] 
     # @param commandHangup [String] 
@@ -111,6 +120,7 @@ module Wx
     alias_method :connect_command=, :set_connect_command
     
     # Sometimes the built-in logic for determining the online status may fail, so, in general, the user should be allowed to override it.
+    # 
     # This function allows forcefully setting the online status - whatever our internal algorithm may think about it.
     # @see Wx::DialUpManager#is_online 
     # @param isOnline [Boolean] 
@@ -119,6 +129,7 @@ module Wx
     alias_method :online_status=, :set_online_status
     
     # This method is for Unix only.
+    # 
     # Under Unix, the value of well-known host is used to check whether we're connected to the internet. It is unused under Windows, but this function is always safe to call. The default value is <code>"www.yahoo.com:80"</code>.
     # @param hostname [String] 
     # @param portno [Integer] 
@@ -127,6 +138,7 @@ module Wx
     alias_method :well_known_host=, :set_well_known_host
     
     # This function should create and return the object of the platform-specific class derived from {Wx::DialUpManager}.
+    # 
     # You should delete the pointer when you are done with it.
     # @return [Wx::DialUpManager]
     def self.create; end

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

@@ -45,6 +45,7 @@ module Wx
   end # DialogLayoutAdaptationMode
   
   # A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen.
+  # 
   # It can contain controls and other windows and is often used to allow the user to make some choice or to answer a question.
   # Dialogs can be made scrollable, automatically, for computers with low resolution screens: please see Automatic Scrolled Dialogs for further details.
   # Dialogs usually contain either a single button allowing to close the dialog or two buttons, one accepting the changes and the other one discarding them (such button, if present, is automatically activated if the user presses the "Esc" key). By default, buttons with the standard {Wx::StandardID::ID_OK} and {Wx::StandardID::ID_CANCEL} identifiers behave as expected. Starting with wxWidgets 2.7 it is also possible to use a button with a different identifier instead, see {Wx::Dialog#set_affirmative_id} and {Wx::Dialog#set_escape_id}.
@@ -135,6 +136,7 @@ module Wx
     # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_DIALOG_STYLE, name=Wx::DIALOG_NAME_STR)
     #   Constructor.
     #   
+    #   
     #   @see Wx::Dialog#create 
     #   @param parent [Wx::Window]  Can be NULL, a frame or another dialog box.
     #   @param id [Integer]  An identifier for the dialog. A value of -1 is taken to mean a default.
@@ -148,6 +150,7 @@ module Wx
     
     # Adds an identifier to be regarded as a main button for the non-scrolling area of a dialog.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @param id [Integer] 
     # @return [void]
@@ -155,6 +158,7 @@ module Wx
     
     # Returns true if this dialog can and should perform layout adaptation using {Wx::Dialog#do_layout_adaptation}, usually if the dialog is too large to fit on the display.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Boolean]
     def can_do_layout_adaptation; end
@@ -167,6 +171,7 @@ module Wx
     
     # Used for two-step dialog box construction.
     # 
+    # 
     # @see Wx::Dialog#initialize 
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -179,6 +184,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
     
     # Creates a sizer with standard buttons.
+    # 
     # flags is a bit list of the following flags: {Wx::OK}, {Wx::CANCEL}, {Wx::YES}, {Wx::NO}, {Wx::APPLY}, {Wx::CLOSE}, {Wx::HELP}, {Wx::NO_DEFAULT}.
     # The sizer lays out the buttons in a manner appropriate to the platform.
     # This function uses {Wx::Dialog#create_std_dialog_button_sizer} internally for most platforms but doesn't create the sizer at all for the platforms with hardware buttons (such as smartphones) for which it sets up the hardware buttons appropriately and returns NULL, so don't forget to test that the return value is valid before using it.
@@ -187,6 +193,7 @@ module Wx
     def create_button_sizer(flags) end
     
     # Creates a sizer with standard buttons using {Wx::Dialog#create_button_sizer} separated from the rest of the dialog contents by a horizontal {Wx::StaticLine}.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Just like {Wx::Dialog#create_button_sizer}, this function may return NULL if no buttons were created.
@@ -199,6 +206,7 @@ module Wx
     def create_separated_button_sizer(flags) end
     
     # Returns the sizer containing the given one with a separating {Wx::StaticLine} if necessarily.
+    # 
     # This function is useful for creating the sizer containing footer-like contents in dialog boxes. It will add a separating static line only if it conforms to the current platform convention (currently it is not added under Mac where the use of static lines for grouping is discouraged and is added elsewhere).
     # 
     # The sizer wrapping the input one or possibly the input sizer itself if no wrapping is necessary.
@@ -207,6 +215,7 @@ module Wx
     def create_separated_sizer(sizer) end
     
     # Creates a {Wx::StdDialogButtonSizer} with standard buttons.
+    # 
     # flags is a bit list of the following flags: {Wx::OK}, {Wx::CANCEL}, {Wx::YES}, {Wx::NO}, {Wx::APPLY}, {Wx::CLOSE}, {Wx::HELP}, {Wx::NO_DEFAULT}.
     # The sizer lays out the buttons in a manner appropriate to the platform.
     # @param flags [Integer] 
@@ -214,6 +223,7 @@ module Wx
     def create_std_dialog_button_sizer(flags) end
     
     # Splits text up at newlines and places the lines into {Wx::StaticText} objects with the specified maximum width in a vertical {Wx::BoxSizer}.
+    # 
     # If widthMax has its default value of -1, only explicit new line characters in message are taken into account. Otherwise, lines are broken either after a new line or wrapped, at word boundary, if their width would become bigger than the specified maximal width.
     # @see wxStaticText::Wrap(int width) 
     # @param message [String]  The text to be displayed.
@@ -223,12 +233,14 @@ module Wx
     
     # Performs layout adaptation, usually if the dialog is too large to fit on the display.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Boolean]
     def do_layout_adaptation; end
     
     # Ends a modal dialog, passing a value to be returned from the {Wx::Dialog#show_modal} invocation.
     # 
+    # 
     # @see Wx::Dialog#show_modal
     # @see  Wx::Dialog#get_return_code
     # @see  Wx::Dialog#set_return_code 
@@ -238,6 +250,7 @@ module Wx
     
     # Gets the identifier of the button which works like standard OK button in this dialog.
     # 
+    # 
     # @see Wx::Dialog#set_affirmative_id 
     # @return [Integer]
     def get_affirmative_id; end
@@ -245,6 +258,7 @@ module Wx
     
     # Gets the identifier of the button to map presses of ESC button to.
     # 
+    # 
     # @see Wx::Dialog#set_escape_id 
     # @return [Integer]
     def get_escape_id; end
@@ -252,12 +266,14 @@ module Wx
     
     # Returns true if the dialog has been adapted, usually by making it scrollable to work with a small display.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Boolean]
     def get_layout_adaptation_done; end
     alias_method :layout_adaptation_done, :get_layout_adaptation_done
     
     # Gets a value representing the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.
+    # 
     # Zero switches off adaptation, and 3 allows search for standard buttons anywhere in the dialog.
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Integer]
@@ -266,6 +282,7 @@ module Wx
     
     # Gets the adaptation mode, overriding the global adaptation flag.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Wx::DialogLayoutAdaptationMode]
     def get_layout_adaptation_mode; end
@@ -273,17 +290,19 @@ module Wx
     
     # Returns an array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Array<Integer>]
     def get_main_button_ids; end
     alias_method :main_button_ids, :get_main_button_ids
     
     # Gets the return code for this window.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>A return code is normally associated with a modal dialog, where {Wx::Dialog#show_modal} returns a code to the application.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::Dialog#set_return_code
     # @see  Wx::Dialog#show_modal
     # @see  Wx::Dialog#end_modal 
@@ -292,30 +311,33 @@ module Wx
     alias_method :return_code, :get_return_code
     
     # Iconizes or restores the dialog.
+    # 
     # Windows only.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Note that in Windows, iconization has no effect since dialog boxes cannot be iconized. However, applications may need to explicitly restore dialog boxes under Motif which have user-iconizable frames, and under Windows calling Iconize(false) will bring the window to the front, as does Show(true). 
     # </p>
-    # </div>>
+    # </div>
     # @param iconize [Boolean]  If true, iconizes the dialog box; if false, shows and restores it.
     # @return [void]
     def iconize(iconize=true) end
     
     # Returns true if the dialog box is iconized.
+    # 
     # Windows only.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Always returns false under Windows since dialogs cannot be iconized. 
     # </p>
-    # </div>>
+    # </div>
     # @return [Boolean]
     def is_iconized; end
     alias_method :iconized?, :is_iconized
     
     # Returns true if id is in the array of identifiers to be regarded as the main buttons for the non-scrolling area of a dialog.
+    # 
     # Availability:  only available for the WXMSW port.
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @param id [Integer] 
@@ -330,6 +352,7 @@ module Wx
     alias_method :modal?, :is_modal
     
     # Sets the identifier to be used as OK button.
+    # 
     # When the button with this identifier is pressed, the dialog calls {Wx::Window#validate} and {Wx::Window#transfer_data_from_window} and, if they both return true, closes the dialog with the affirmative id return code.
     # Also, when the user presses a hardware OK button on the devices having one or the special OK button in the PocketPC title bar, an event with this id is generated.
     # By default, the affirmative id is {Wx::StandardID::ID_OK}.
@@ -341,6 +364,7 @@ module Wx
     alias_method :affirmative_id=, :set_affirmative_id
     
     # Sets the identifier of the button which should work like the standard "Cancel" button in this dialog.
+    # 
     # When the button with this id is clicked, the dialog is closed. Also, when the user presses ESC key in the dialog or closes the dialog using the close button in the title bar, this is mapped to the click of the button with the specified id.
     # By default, the escape id is the special value {Wx::StandardID::ID_ANY} meaning that {Wx::StandardID::ID_CANCEL} button is used if it's present in the dialog and otherwise the button with {Wx::Dialog#get_affirmative_id} is used. Another special value for id is {Wx::StandardID::ID_NONE} meaning that ESC presses should be ignored. If any other value is given, it is interpreted as the id of the button to map the escape key to.
     # 
@@ -356,6 +380,7 @@ module Wx
     
     # Sets the icon for this dialog.
     # 
+    # 
     # @see Wx::Icon 
     # @param icon [Wx::Icon]  The icon to associate with this dialog.
     # @return [void]
@@ -364,6 +389,7 @@ module Wx
     
     # Sets the icons for this dialog.
     # 
+    # 
     # @see Wx::IconBundle 
     # @param icons [Wx::IconBundle]  The icons to associate with this dialog.
     # @return [void]
@@ -372,6 +398,7 @@ module Wx
     
     # Marks the dialog as having been adapted, usually by making it scrollable to work with a small display.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @param done [Boolean] 
     # @return [void]
@@ -379,6 +406,7 @@ module Wx
     alias_method :layout_adaptation_done=, :set_layout_adaptation_done
     
     # Sets the aggressiveness of search for buttons and sizers to be in the non-scrolling part of a layout-adapted dialog.
+    # 
     # Zero switches off adaptation, and 3 allows search for standard buttons anywhere in the dialog.
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @param level [Integer] 
@@ -388,6 +416,7 @@ module Wx
     
     # Sets the adaptation mode, overriding the global adaptation flag.
     # 
+    # 
     # @see Wx::DialogLayoutAdaptationMode
     # @see  Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @param mode [Wx::DialogLayoutAdaptationMode] 
@@ -396,6 +425,7 @@ module Wx
     alias_method :layout_adaptation_mode=, :set_layout_adaptation_mode
     
     # Sets the return code for this window.
+    # 
     # A return code is normally associated with a modal dialog, where {Wx::Dialog#show_modal} returns a code to the application. The function {Wx::Dialog#end_modal} calls {Wx::Dialog#set_return_code}.
     # @see Wx::Dialog#get_return_code
     # @see  Wx::Dialog#show_modal
@@ -406,12 +436,14 @@ module Wx
     alias_method :return_code=, :set_return_code
     
     # Hides or shows the dialog.
+    # 
     # The preferred way of dismissing a modal dialog is to use {Wx::Dialog#end_modal}.
     # @param show [Boolean]  If true, the dialog box is shown and brought to the front, otherwise the box is hidden. If false and the dialog is modal, control is returned to the calling program.
     # @return [Boolean]
     def show(show=true) end
     
     # Shows an application-modal dialog.
+    # 
     # Program flow does not return until the dialog has been dismissed with {Wx::Dialog#end_modal}.
     # Notice that it is possible to call {Wx::Dialog#show_modal} for a dialog which had been previously shown with {Wx::Dialog#show}, this allows making an existing modeless dialog modal. However {Wx::Dialog#show_modal} can't be called twice without intervening {Wx::Dialog#end_modal} calls.
     # Note that this function creates a temporary event loop which takes precedence over the application's main event loop (see {Wx::EventLoopBase}) and which is destroyed when the dialog is dismissed. This also results in a call to {Wx::App#process_pending_events}.
@@ -425,6 +457,7 @@ module Wx
     def show_modal; end
     
     # Shows a dialog modal to the parent top level window only.
+    # 
     # Unlike {Wx::Dialog#show_modal}, dialogs shown with this function only prevent the user from interacting with their parent frame only but not with the rest of the application. They also don't block the program execution but instead return immediately, as {Wx::Dialog#show}, and generate a {Wx::EVT_WINDOW_MODAL_DIALOG_CLOSED} event ({Wx::WindowModalDialogEvent}) later when the dialog is closed.
     # Currently this function is only fully implemented in WXOSX ports, under the other platforms it behaves like {Wx::Dialog#show_modal} (but also sends the above mentioned event).
     # @see Wx::WindowModalDialogEvent
@@ -434,6 +467,7 @@ module Wx
     
     # A static function enabling or disabling layout adaptation for all dialogs.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @param enable [Boolean] 
     # @return [void]
@@ -441,17 +475,20 @@ module Wx
     
     # A static function getting the current layout adapter object.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Wx::DialogLayoutAdapter]
     def self.get_layout_adapter; end
     
     # A static function returning true if layout adaptation is enabled for all dialogs.
     # 
+    # 
     # @see Automatic Scrolled Dialogs (for more on layout adaptation) 
     # @return [Boolean]
     def self.is_layout_adaptation_enabled; end
     
     # A static function for setting the current layout adapter object, returning the old adapter.
+    # 
     # If you call this, you should delete the old adapter object.
     # @see Wx::DialogLayoutAdapter
     # @see  Automatic Scrolled Dialogs 
@@ -462,6 +499,7 @@ module Wx
   end # Dialog
   
   # This abstract class is the base for classes that help wxWidgets perform run-time layout adaptation of dialogs.
+  # 
   # Principally, this is to cater for small displays by making part of the dialog scroll, but the application developer may find other uses for layout adaption.
   # By default, there is one instance of {Wx::StandardDialogLayoutAdapter} which can perform adaptation for most custom dialogs and dialogs with book controls such as {Wx::PropertySheetDialog}.
   # 
@@ -482,6 +520,7 @@ module Wx
     alias_method :can_do_layout_adaptation?, :can_do_layout_adaptation
     
     # Override this to perform layout adaptation, such as making parts of the dialog scroll and resizing the dialog to fit the display.
+    # 
     # Normally this function will be called just before the dialog is shown.
     # @param dialog [Wx::Dialog] 
     # @return [Boolean]

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

@@ -37,6 +37,7 @@ module Wx
   DIR_DIALOG_NAME_STR = "wxDirCtrl"
   
   # Pops up a directory selector dialog.
+  # 
   # The arguments have the same meaning as those of {Wx::DirDialog#initialize}. The message is displayed at the top, and the default_path, if specified, is set as the initial selection.
   # The application must check for an empty return value (if the user pressed Cancel). For example:
   # 
@@ -55,6 +56,7 @@ module Wx
   def self.dir_selector(message=Wx::DIR_SELECTOR_PROMPT_STR, default_path=(''), style=0, pos=Wx::DEFAULT_POSITION, parent=nil) end
   
   # This class represents the directory chooser dialog.
+  # 
   # ### Styles
   # 
   # This class supports the following styles:
@@ -80,7 +82,7 @@ module Wx
   # <b>Remark:</b>
   # <p>MacOS 10.11+ does not display a title bar on the dialog. Use {Wx::DirDialog#set_message} to change the string displayed to the user at the top of the dialog after creation. The {Wx::DirDialog#set_title} method is provided for compatibility with pre-10.11 MacOS versions that do still support displaying the title bar.
   # </p>
-  # </div>>
+  # </div>
   # 
   # Category:  Common Dialogs
   # @see wxDirDialog Overview
@@ -91,6 +93,7 @@ module Wx
   class DirDialog < Dialog
   
     # Constructor.
+    # 
     # Use {Wx::DirDialog#show_modal} to show the dialog.
     # @param parent [Wx::Window]  Parent window.
     # @param message [String]  Message to show on the dialog.
@@ -108,6 +111,7 @@ module Wx
     alias_method :message, :get_message
     
     # Returns the default or user-selected path.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>This function can't be used with dialogs which have the {Wx::DD_MULTIPLE} style, use {Wx::DirDialog#get_paths} instead. 
@@ -118,6 +122,7 @@ module Wx
     alias_method :path, :get_path
     
     # Fills the array paths with the full paths of the chosen directories.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>This function should only be used with the dialogs which have {Wx::DD_MULTIPLE} style, use {Wx::DirDialog#get_path} for the others.

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

@@ -45,6 +45,7 @@ module Wx
   # 
   # 
   # 
+  # 
   # @wxrb_require USE_DIRDLG|USE_FILEDLG
   class DirFilterListCtrl < Choice
   

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This control allows the user to select a directory.
+  # 
   # The generic implementation is a button which brings up a {Wx::DirDialog} when clicked. Native implementation may differ but this is usually a (small) widget which give access to the dir-chooser dialog. It is only available if {Wx::Setup::USE_DIRPICKERCTRL} is set to 1 (the default).
   # ### Styles
   # 
@@ -57,6 +58,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the widgets with the given parameters.
+    # 
     # true if the control was successfully created or false if creation failed.
     # @param parent [Wx::Window]  Parent window, must not be non-NULL.
     # @param id [Integer]  The identifier for the control.
@@ -71,6 +73,7 @@ module Wx
     def create(parent, id, path=(''), message=Wx::DIR_SELECTOR_PROMPT_STR, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DIRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::DIR_PICKER_CTRL_NAME_STR) end
     
     # Returns the absolute path of the currently selected directory as a {Wx::FileName} object.
+    # 
     # This function is equivalent to {Wx::DirPickerCtrl#get_path}.
     # @return [String]
     def get_dir_name; end
@@ -88,6 +91,7 @@ module Wx
     alias_method :dir_name=, :set_dir_name
     
     # Set the directory to show when starting to browse for directories.
+    # 
     # This function is mostly useful for the directory picker controls which have no selection initially to configure the directory that should be shown if the user starts browsing for directories as otherwise the initially selected directory is used, which is usually the desired behaviour and so the directory specified by this function is ignored in this case.
     # @param dir [String] 
     # @return [void]
@@ -95,6 +99,7 @@ module Wx
     alias_method :initial_directory=, :set_initial_directory
     
     # Sets the absolute path of the currently selected directory.
+    # 
     # If the control uses {Wx::DIRP_DIR_MUST_EXIST} and does not use {Wx::DIRP_USE_TEXTCTRL} style, the dirname must be a name of an existing directory and will be simply ignored by the native WXGTK implementation if this is not the case.
     # @param dirname [String] 
     # @return [void]

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

@@ -52,12 +52,14 @@ module Wx
   end # DragResult
   
   # Returns true if res indicates that something was done during a DnD operation, i.e.
+  # 
   # is neither error nor none nor cancel.
   # @param res [Wx::DragResult] 
   # @return [Boolean]
   def self.is_drag_result_ok(res) end
   
   # This class represents a source for a drag and drop operation.
+  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  wxDataObject Overview
@@ -71,6 +73,7 @@ module Wx
   
     # @overload initialize(win=nil, iconCopy=Wx::NULL_CURSOR, iconMove=Wx::NULL_CURSOR, iconNone=Wx::NULL_CURSOR)
     #   This constructor requires that you must call {Wx::DropSource#set_data} later.
+    #   
     #   Note that the type of iconCopy and subsequent parameters differs between different ports: these are cursors under Windows and OS X but icons for GTK. You should use the macro {drop_icon} in portable programs instead of directly using either of these types.
     #   Availability:  only available for the WXMSW, WXOSX/Cocoa ports.
     #   @param win [Wx::Window]  The window which initiates the drag and drop operation.
@@ -81,6 +84,7 @@ module Wx
     #   @wxrb_require WXMSW|WXOSX
     # @overload initialize(data, win=nil, iconCopy=Wx::NULL_CURSOR, iconMove=Wx::NULL_CURSOR, iconNone=Wx::NULL_CURSOR)
     #   The constructor taking a {Wx::DataObject}.
+    #   
     #   Note that the type of iconCopy and subsequent parameters differs between different ports: these are cursors under Windows and OS X but icons for GTK. You should use the macro {drop_icon} in portable programs instead of directly using either of these types.
     #   Availability:  only available for the WXMSW, WXOSX/Cocoa ports.
     #   @param data [Wx::DataObject]  The data associated with the drop source.
@@ -93,6 +97,7 @@ module Wx
     def initialize(*args) end
     
     # Starts the drag-and-drop operation which will terminate when the user releases the mouse.
+    # 
     # Call this in response to a mouse button press, for example.
     # 
     # The operation requested by the user, may be {Wx::DragResult::DragCopy}, {Wx::DragResult::DragMove}, {Wx::DragResult::DragLink}, {Wx::DragResult::DragCancel} or {Wx::DragResult::DragNone} if an error occurred.
@@ -106,6 +111,7 @@ module Wx
     alias_method :data_object, :get_data_object
     
     # You may give some custom UI feedback during the drag and drop operation by overriding this function.
+    # 
     # It is called on each mouse move, so your implementation must not be too slow.
     # 
     # false if you want default feedback, or true if you implement your own feedback. The return value is ignored under GTK.
@@ -114,6 +120,7 @@ module Wx
     def give_feedback(effect) end
     
     # Set the icon to use for a certain drag result.
+    # 
     # Availability:  only available for the WXMSW, WXOSX/Cocoa ports.
     # @param res [Wx::DragResult]  The drag result to set the icon for.
     # @param cursor [Wx::Cursor]  The icon to show when this drag result occurs.
@@ -122,6 +129,7 @@ module Wx
     def set_cursor(res, cursor) end
     
     # Sets the data {Wx::DataObject} associated with the drop source.
+    # 
     # This will not delete any previously associated data.
     # @param data [Wx::DataObject] 
     # @return [void]
@@ -131,6 +139,7 @@ module Wx
   end # DropSource
   
   # This class represents a target for a drag and drop operation.
+  # 
   # A {Wx::DataObject} can be associated with it and by default, this object will be filled with the data from the drag source, if the data formats supported by the data object match the drag source data format.
   # There are various virtual handler functions defined in this class which may be overridden to give visual feedback or react in a more fine-tuned way, e.g. by not accepting data on the whole window area, but only a small portion of it. The normal sequence of calls is {Wx::DropTarget#on_enter}, {Wx::DropTarget#on_drag_over} possibly many times, {Wx::DropTarget#on_drop} and finally {Wx::DropTarget#on_data}.
   # 
@@ -148,18 +157,21 @@ module Wx
   class DropTarget < ::Object
   
     # Constructor.
+    # 
     # data is the data to be associated with the drop target.
     # @param data [Wx::DataObject] 
     # @return [Wx::DropTarget]
     def initialize(data=nil) end
     
     # This method may only be called from within {Wx::DropTarget#on_data}.
+    # 
     # By default, this method copies the data from the drop source to the {Wx::DataObject} associated with this drop target, calling its {Wx::DataObject#set_data} method.
     # @return [Boolean]
     def get_data; end
     alias_method :data, :get_data
     
     # Called after {Wx::DropTarget#on_drop} returns true.
+    # 
     # By default this will usually {Wx::DropTarget#get_data} and will return the suggested default value defResult.
     # @param x [Integer] 
     # @param y [Integer] 
@@ -168,6 +180,7 @@ module Wx
     def on_data(x, y, defResult) end
     
     # Called when the mouse is being dragged over the drop target.
+    # 
     # By default, this calls functions return the suggested return value defResult.
     # 
     # The desired operation or {Wx::DragResult::DragNone}. This is used for optical feedback from the side of the drop source, typically in form of changing the icon.
@@ -178,6 +191,7 @@ module Wx
     def on_drag_over(x, y, defResult) end
     
     # Called when the user drops a data object on the target.
+    # 
     # Return false to veto the operation.
     # 
     # true to accept the data, or false to veto the operation.
@@ -187,6 +201,7 @@ module Wx
     def on_drop(x, y) end
     
     # Called when the mouse enters the drop target.
+    # 
     # By default, this calls {Wx::DropTarget#on_drag_over}.
     # 
     # The desired operation or {Wx::DragResult::DragNone}. This is used for optical feedback from the side of the drop source, typically in form of changing the icon.
@@ -212,6 +227,7 @@ module Wx
     alias_method :data_object=, :set_data_object
     
     # Sets the default action for drag and drop.
+    # 
     # Use {Wx::DragResult::DragMove} or {Wx::DragResult::DragCopy} to set default action to move or copy and use {Wx::DragResult::DragNone} (default) to set default action specified by initialization of dragging (see {Wx::DropSource#do_drag_drop})
     # @param action [Wx::DragResult] 
     # @return [void]
@@ -226,6 +242,7 @@ module Wx
   end # DropTarget
   
   # This is a drop target which accepts files (dragged from File Manager or Explorer).
+  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Wx::DropSource
@@ -241,6 +258,7 @@ module Wx
     def initialize; end
     
     # Override this function to receive dropped files.
+    # 
     # Return true to accept the data, or false to veto the operation.
     # @param x [Integer]  The x coordinate of the mouse.
     # @param y [Integer]  The y coordinate of the mouse.
@@ -251,6 +269,7 @@ module Wx
   end # FileDropTarget
   
   # A predefined drop target for dealing with text data.
+  # 
   # Category:  Clipboard and Drag & Drop
   # @see Drag and Drop Overview
   # @see  Wx::DropSource
@@ -266,6 +285,7 @@ module Wx
     def initialize; end
     
     # Override this function to receive dropped text.
+    # 
     # Return true to accept the data, or false to veto the operation.
     # @param x [Integer]  The x coordinate of the mouse.
     # @param y [Integer]  The y coordinate of the mouse.