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

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

@@ -0,0 +1,135 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Provides support for automatically saving and restoring object properties to persistent storage.
+  # 
+  # This class is the central element of wxWidgets persistence framework, see Persistent Objects Overview for its overview.
+  # This is a singleton class and its unique instance can be retrieved using {Wx::PersistenceManager.get} method.
+  # 
+  # @wxrb_require USE_CONFIG
+  class PersistenceManager < ::Object
+  
+    # @overload register_and_restore(obj)
+    #   Combines both {Wx::PersistenceManager#register} and {Wx::PersistenceManager#restore} calls.
+    #   @param obj [Object] 
+    #   @return [Boolean]
+    # @overload register_and_restore(obj, po)
+    #   Combines both {Wx::PersistenceManager#register} and {Wx::PersistenceManager#restore} calls.
+    #   @param obj [Object] 
+    #   @param po [Wx::PersistentObject] 
+    #   @return [Boolean]
+    def register_and_restore(*args) end
+    
+    # Set the global persistence manager to use.
+    # 
+    # Call this method to specify a non-default persistence manager to use. It should usually be called very early (e.g. in {Wx::App}-derived class constructor or in the beginning of overridden {Wx::App#on_init}) to affect creation of all persistent controls and the object passed to it must have a lifetime long enough to be still alive when the persistent controls are destroyed and need it to save their state so typically this would be a global or a {Wx::App} member.
+    # @param manager [Wx::PersistenceManager] 
+    # @return [void]
+    def self.set(manager) end
+    
+    # Returns the unique persistence manager object.
+    # 
+    # If {Wx::PersistenceManager.set} hadn't been called before, a default persistence manager implementation is returned.
+    # @return [Wx::PersistenceManager]
+    def self.get; end
+    
+    # Globally disable saving the persistence object properties.
+    # 
+    # By default, saving properties in {Wx::PersistenceManager#save} is enabled but the program may wish to disable if, for example, it detects that it is running on a system which shouldn't be modified in any way and so configuration file (or Windows registry) shouldn't be written to.
+    # @see Wx::PersistenceManager#disable_restoring 
+    # @return [void]
+    def disable_saving; end
+    
+    # Globally disable restoring the persistence object properties.
+    # 
+    # By default, restoring properties in {Wx::PersistenceManager#restore} is enabled but this function allows disabling it. This is mostly useful for testing.
+    # @see Wx::PersistenceManager#disable_saving 
+    # @return [void]
+    def disable_restoring; end
+    
+    # @overload register(obj)
+    #   Register an object with the manager automatically creating a persistence adapter for it.
+    #   
+    #   This is equivalent to calling Register(void *, wxPersistentObject *) with {create_persistent_object(obj)} as the second argument.
+    #   @param obj [Object]  The object to register. {create_persistent_object} overload must be defined for the objects of this class.
+    #   @return [Wx::PersistentObject]
+    # @overload register(obj, po)
+    #   Register an object with the manager.
+    #   
+    #   Note that registering the object doesn't do anything except allowing to call {Wx::PersistenceManager#restore} for it later. If you want to register the object and restore its properties, use {Wx::PersistenceManager#register_and_restore}.
+    #   The manager takes ownership of po and will delete it when it is unregistered.
+    #   @param obj [Object]  The object to register.
+    #   @param po [Wx::PersistentObject]  The {Wx::PersistentObject} to use for saving and restoring this object properties.
+    #   @return [Wx::PersistentObject]
+    def register(*args) end
+    
+    # Check if the object is registered and return the associated {Wx::PersistentObject} if it is or NULL otherwise.
+    # @param obj [Object] 
+    # @return [Wx::PersistentObject]
+    def find(obj) end
+    
+    # Unregister the object and delete the associated {Wx::PersistentObject}.
+    # 
+    # For the persistent windows this is done automatically (via {Wx::PersistenceManager#save_and_unregister}) when the window is destroyed so you only need to call this function explicitly if you are using custom persistent objects or if you want to prevent the object properties from being saved.
+    # @param obj [Object]  An object previously registered with {Wx::PersistenceManager#register}.
+    # @return [void]
+    def unregister(obj) end
+    
+    # Save the object properties to persistent storage.
+    # 
+    # This method does nothing if {Wx::PersistenceManager#disable_saving} had been called.
+    # @see Wx::PersistenceManager#save_and_unregister 
+    # @param obj [Object]  An object previously registered with {Wx::PersistenceManager#register}.
+    # @return [void]
+    def save(obj) end
+    
+    # Restore the object properties previously saved by {Wx::PersistenceManager#save}.
+    # 
+    # This method does nothing if {Wx::PersistenceManager#disable_restoring} had been called.
+    # 
+    # true if the object properties were restored or false if nothing was found to restore or the saved settings were invalid.
+    # @see Wx::PersistenceManager#register_and_restore 
+    # @param obj [Object]  An object previously registered with {Wx::PersistenceManager#register}.
+    # @return [Boolean]
+    def restore(obj) end
+    
+    # Combines both {Wx::PersistenceManager#save} and {Wx::PersistenceManager#unregister} calls.
+    # @param obj [Object] 
+    # @return [void]
+    def save_and_unregister(obj) end
+    
+    
+    protected
+    
+    # Protected default constructor.
+    # 
+    # This constructor is only provided for the derived classes, to use an object of this class static {Wx::PersistenceManager.get} method should be called.
+    # @return [Wx::PersistenceManager]
+    def initialize; end
+    
+    # Return the config object to use.
+    # 
+    # By default the global {Wx::Config}, returned by {Wx::ConfigBase#get}, is used but a derived class could override this function to return a different one if necessary.
+    # @return [Wx::ConfigBase]
+    def get_config; end
+    alias_method :config, :get_config
+    
+    # Return the path to use for saving the setting with the given name for the specified object.
+    # 
+    # Notice that the name argument is the name of the setting, not the name of the object itself which can be retrieved with its GetName() method.
+    # This method can be overridden by a derived class to change where in {Wx::Config} the different options are stored. By default, all settings of the persistent controls are stored under "Persistent_Options" group and grouped by control type (e.g. "Window" for top level windows or "Splitter") and name, so that the position of a splitter called "sep" could be stored under "Persistent_Options/Splitter/sep/Position" key.
+    # @param who [Wx::PersistentObject] 
+    # @param name [String] 
+    # @return [String]
+    def get_key(who, name) end
+    alias_method :key, :get_key
+    
+  end # PersistenceManager
+  
+
+end

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

@@ -0,0 +1,52 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Base class for persistent object adapters.
+  # 
+  # See Persistent Objects Overview for an overview of persistent objects within wxWidgets.
+  # wxWidgets persistence framework is non-intrusive, i.e. can work with the classes which have no relationship to nor knowledge of it. To allow this, an intermediate persistence adapter is used: this is just a simple object which provides the methods used by {Wx::PersistenceManager} to save and restore the object properties and implements them using the concrete class methods.
+  # You may derive your own classes from {Wx::PersistentObject} to implement persistence support for your common classes, see Defining Custom Persistent Windows.
+  # @see wxPersistentWindow<> 
+  # 
+  # 
+  # @wxrb_require USE_CONFIG
+  class PersistentObject < ::Object
+  
+    # Save the object properties.
+    # 
+    # The implementation of this method should use {Wx::PersistentObject#save_value}.
+    # @return [void]
+    def save; end
+    
+    # Restore the object properties.
+    # 
+    # The implementation of this method should use {Wx::PersistentObject#restore_value}.
+    # @return [Boolean]
+    def restore; end
+    
+    # Returns the string uniquely identifying the objects supported by this adapter.
+    # 
+    # This method is called from {Wx::PersistentObject#save_value} and {Wx::PersistentObject#restore_value} and normally returns some short (but not too cryptic) strings, e.g. <code>"Checkbox"</code>.
+    # @return [String]
+    def get_kind; end
+    alias_method :kind, :get_kind
+    
+    # Returns the string uniquely identifying the object we're associated with among all the other objects of the same type.
+    # 
+    # This method is used together with {Wx::PersistentObject#get_kind} to construct the unique full name of the object in e.g. a configuration file.
+    # @return [String]
+    def get_name; end
+    alias_method :name, :get_name
+    
+    
+    protected
+    
+  end # PersistentObject
+  
+
+end

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

@@ -0,0 +1,116 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Base class for persistent windows.
+  # 
+  # Compared to {Wx::PersistentObject} this class does three things:
+  # 
+  # - Most importantly, {Wx::PersistentWindow} catches {Wx::WindowDestroyEvent} generated when the window is destroyed and saves its properties automatically when it happens.
+  # - It implements {Wx::PersistentWindow#get_name} using {Wx::Window#get_name} so that the derived classes don't need to do it.
+  # - It adds a convenient {Wx::PersistentWindow#get} accessor returning the window object of the correct type.
+  # 
+  # @wxrb_require USE_CONFIG
+  class PersistentWindowBase < PersistentObject
+  
+    # Constructor for a persistent window object.
+    # 
+    # The constructor uses {Wx::EvtHandler#bind} to catch {Wx::WindowDestroyEvent} generated when the window is destroyed and call {Wx::PersistenceManager#save_and_unregister} when this happens. This ensures that the window properties are saved and that this object itself is deleted when the window is.
+    # @param win [Wx::Window] 
+    # @return [Wx::PersistentWindowBase]
+    def initialize(win) end
+    
+    # @return [Wx::Window]
+    def get; end
+    
+    # Implements the base class pure virtual method using {Wx::Window#get_name}.
+    # 
+    # Notice that window names are usually not unique while this function must return a unique (at least among the objects of this type) string. Because of this you need to specify a non-default window name in its constructor when creating it or explicitly call {Wx::Window#set_name} before saving or restoring persistent properties.
+    # @return [String]
+    def get_name; end
+    alias_method :name, :get_name
+    
+    
+    protected
+    
+  end # PersistentWindowBase
+  
+  # Persistence adapter for {Wx::TopLevelWindow}.
+  # 
+  # This adapter saves and restores the geometry (i.e. position and size) and the state (iconized, maximized or normal) of top level windows. It can be used with both {Wx::Frame} and {Wx::Dialog}.
+  # Note that it does not save nor restore the window visibility.
+  # 
+  # @wxrb_require USE_CONFIG
+  class PersistentTLW < PersistentWindow
+  
+    # Constructor.
+    # @param book [Wx::TopLevelWindow]  The associated window.
+    # @return [Wx::PersistentTLW]
+    def initialize(book) end
+    
+    # Save the current window geometry.
+    # @return [void]
+    def save; end
+    
+    # Restore the window geometry.
+    # @return [Boolean]
+    def restore; end
+    
+  end # PersistentTLW
+  
+  # Persistence adapter for {Wx::BookCtrlBase}.
+  # 
+  # This adapter handles the selected page of {Wx::BookCtrlBase}, i.e. it saves its value when the associated book control is destroyed and restores it when it is recreated.
+  # @see Wx::PersistentTreeBookCtrl 
+  # 
+  # 
+  # @wxrb_require USE_CONFIG
+  class PersistentBookCtrl < PersistentWindow
+  
+    # Constructor.
+    # @param book [Wx::BookCtrlBase]  The associated book control.
+    # @return [Wx::PersistentBookCtrl]
+    def initialize(book) end
+    
+    # Save the currently selected page index.
+    # @return [void]
+    def save; end
+    
+    # Restore the selected page index.
+    # 
+    # The book control must be initialized before calling this function, i.e. all of its pages should be already added to it  otherwise restoring the selection has no effect.
+    # @return [Boolean]
+    def restore; end
+    
+  end # PersistentBookCtrl
+  
+  # Persistence adapter for {Wx::Treebook}.
+  # 
+  # This adapter saves and restores the expanded branches of the {Wx::TreeCtrl} used by {Wx::Treebook}, in addition to saving and restoring the selection as implemented by the base {Wx::PersistentBookCtrl} class.
+  # 
+  # @wxrb_require USE_CONFIG
+  class PersistentTreeBookCtrl < PersistentBookCtrl
+  
+    # Constructor.
+    # @param book [Wx::Treebook]  The associated tree book control.
+    # @return [Wx::PersistentTreeBookCtrl]
+    def initialize(book) end
+    
+    # Save the currently opened branches.
+    # @return [void]
+    def save; end
+    
+    # Restore the opened branches.
+    # 
+    # The book control must be initialized before calling this function, i.e. all of its pages should be already added to it.
+    # @return [Boolean]
+    def restore; end
+    
+  end # PersistentTreeBookCtrl
+  
+
+end

data/lib/wx/doc/gen/pg/numeric_property_validator.rb

@@ -9,6 +9,7 @@ module Wx::PG
   # A more comprehensive numeric validator class.
   # 
   # 
+  # 
   # @wxrb_require USE_VALIDATORS,USE_PROPGRID
   class NumericPropertyValidator < TextValidator
   
@@ -33,7 +34,7 @@ module Wx::PG
       
     end # NumericType
     
-    # @param numericType [Wx::wxNumericPropertyValidator::NumericType] 
+    # @param numericType [Wx::NumericPropertyValidator::NumericType] 
     # @param base [Integer] 
     # @return [Wx::PG::NumericPropertyValidator]
     def initialize(numericType, base=10) end

data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb

@@ -51,6 +51,7 @@ module Wx::PG
   # 
   # 
   # 
+  # 
   # @wxrb_require USE_PROPGRID
   class PGArrayEditorDialog < Dialog
   
@@ -90,13 +91,14 @@ module Wx::PG
     alias_method :dialog_value, :get_dialog_value
     
     # Override to return {Wx::Validator} to be used with the {Wx::TextCtrl} in dialog.
+    # 
     # Note that the validator is used in the standard wx way, ie. it immediately prevents user from entering invalid input.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Dialog frees the validator. 
     # </p>
-    # </div>>
+    # </div>
     # @return [Wx::Validator]
     def get_text_ctrl_validator; end
     alias_method :text_ctrl_validator, :get_text_ctrl_validator
@@ -220,6 +222,7 @@ module Wx::PG
   # 
   # 
   # 
+  # 
   # @wxrb_require USE_PROPGRID
   class PGArrayStringEditorDialog < PGArrayEditorDialog
   

data/lib/wx/doc/gen/pg/pg_cell.rb

@@ -7,6 +7,7 @@
 module Wx::PG
 
   # Base class for {Wx::PG::PropertyGrid} cell information.
+  # 
   # Category:  {Wx::PG::PropertyGrid}
   # 
   # @wxrb_require USE_PROPGRID
@@ -59,11 +60,12 @@ module Wx::PG
     alias_method :fg_col=, :set_fg_col
     
     # Sets font of the cell.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Because {Wx::PG::PropertyGrid} does not support rows of different height, it makes little sense to change size of the font. Therefore it is recommended to use return value of {Wx::PG::PropertyGrid#get_font} or {Wx::PG::PropertyGrid#get_caption_font} as a basis for the font that, after modifications, is passed to this member function. 
     # </p>
-    # </div>>
+    # </div>
     # @param font [Wx::Font,Wx::FontInfo] 
     # @return [void]
     def set_font(font) end
@@ -87,6 +89,7 @@ module Wx::PG
     alias_method :fg_col, :get_fg_col
     
     # Returns font of the cell.
+    # 
     # If no specific font is set for this cell, then the font will be invalid.
     # @return [Wx::Font,Wx::FontInfo]
     def get_font; end
@@ -98,6 +101,7 @@ module Wx::PG
     
   end # PGCell
   
+  # 
   # 
   # Category:  {Wx::PG::PropertyGrid}
   # 
@@ -137,6 +141,7 @@ module Wx::PG
   # Data of a single {Wx::PG::PGChoices} choice.
   # 
   # 
+  # 
   # @wxrb_require USE_PROPGRID
   class PGChoiceEntry < PGCell