wxruby3 0.9.3-x64-mingw-ucrt → 0.9.5-x64-mingw-ucrt

data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb

@@ -18,8 +18,6 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_GRID
   class GridCellNumberRenderer < GridCellStringRenderer
   

data/lib/wx/doc/gen/grid/grid_cell_renderer.rb

@@ -20,8 +20,6 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellStringRenderer 
   # 
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_GRID
   class GridCellRenderer < ::Object
   

data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb

@@ -18,8 +18,6 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellNumberRenderer 
   # 
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_GRID
   class GridCellStringRenderer < GridCellRenderer
   

data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb

@@ -19,8 +19,6 @@ module Wx::GRID
   # @see  Wx::GRID::GridCellDateEditor 
   # 
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_GRID
   class GridCellTextEditor < GridCellEditor
   

data/lib/wx/doc/gen/grid/grid_ctrl.rb

@@ -273,18 +273,6 @@ module Wx::GRID
     # @wxrb_require USE_GRID
     class CellSpan < Wx::Enum
     
-      # This cell is inside a span covered by another cell.
-      # 
-      CellSpan_Inside = Wx::GRID::Grid::CellSpan.new(-1)
-      
-      # This is a normal, non-spanning cell.
-      # 
-      CellSpan_None = Wx::GRID::Grid::CellSpan.new(0)
-      
-      # This cell spans several physical {Wx::GRID::Grid} cells.
-      # 
-      CellSpan_Main = Wx::GRID::Grid::CellSpan.new(1)
-      
     end # CellSpan
     
     # Constants defining different support built-in TAB handling behaviours.

data/lib/wx/doc/gen/grid/grid_editor_created_event.rb

@@ -28,7 +28,7 @@ module Wx::GRID
     # @overload initialize(id, type, obj, row, col, ctrl)
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Wx::StaticLine::EventType] 
+    #   @param type [Wx::Notebook::EventType] 
     #   @param obj [Wx::Object] 
     #   @param row [Integer] 
     #   @param col [Integer] 

data/lib/wx/doc/gen/grid/grid_event.rb

@@ -59,7 +59,7 @@ module Wx::GRID
     # @overload initialize(id, type, obj, row=-1, col=-1, x=-1, y=-1, sel=true, kbd=(Wx::KeyboardState.new()))
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Wx::StaticLine::EventType] 
+    #   @param type [Wx::Notebook::EventType] 
     #   @param obj [Wx::Object] 
     #   @param row [Integer] 
     #   @param col [Integer] 

data/lib/wx/doc/gen/grid/grid_range_select_event.rb

@@ -35,7 +35,7 @@ module Wx::GRID
     # @overload initialize(id, type, obj, topLeft, bottomRight, sel=true, kbd=(Wx::KeyboardState.new()))
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Wx::StaticLine::EventType] 
+    #   @param type [Wx::Notebook::EventType] 
     #   @param obj [Wx::Object] 
     #   @param topLeft [Array(Integer, Integer)] 
     #   @param bottomRight [Array(Integer, Integer)] 

data/lib/wx/doc/gen/grid/grid_size_event.rb

@@ -36,7 +36,7 @@ module Wx::GRID
     # @overload initialize(id, type, obj, rowOrCol=-1, x=-1, y=-1, kbd=(Wx::KeyboardState.new()))
     #   Constructor for initializing all event attributes.
     #   @param id [Integer] 
-    #   @param type [Wx::StaticLine::EventType] 
+    #   @param type [Wx::Notebook::EventType] 
     #   @param obj [Wx::Object] 
     #   @param rowOrCol [Integer] 
     #   @param x [Integer] 

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

@@ -10,8 +10,6 @@ module Wx
   # 
   # Category:  Application and Process Management
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GUIEventLoop < ::Object
   
     # @return [Wx::GUIEventLoop]

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

@@ -62,7 +62,6 @@ module Wx
   # This control is implemented using the native header control under MSW systems and a generic implementation elsewhere.
   # 
   # ## Future Improvements
-  # 
   # Some features are supported by the native MSW control and so could be easily implemented in this version of {Wx::HeaderCtrl} but need to be implemented in the generic version as well to be really useful. Please let us know if you need or, better, plan to work on implementing, any of them:
   # 
   # - Displaying bitmaps instead of or together with the text
@@ -370,8 +369,6 @@ module Wx
   # 
   # Category:  {Wx::Controls}
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class HeaderColumn < ::Object
   
     # Get the text shown in the column header.
@@ -584,8 +581,6 @@ module Wx
   # 
   # Category:  {Wx::Controls}
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class SettableHeaderColumn < HeaderColumn
   
     # Set the text to display in the column header.
@@ -737,8 +732,6 @@ module Wx
   # 
   # Category:  {Wx::Controls}
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class HeaderColumnSimple < SettableHeaderColumn
   
     # @overload initialize(title, width=Wx::COL_WIDTH_DEFAULT, align=Wx::Alignment::ALIGN_NOT, flags=Wx::COL_DEFAULT_FLAGS)

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

@@ -83,7 +83,7 @@ module Wx
   class HeaderCtrlEvent < NotifyEvent
   
     # @overload initialize(commandType=Wx::EVT_NULL, winid=0)
-    #   @param commandType [Wx::StaticLine::EventType] 
+    #   @param commandType [Wx::Notebook::EventType] 
     #   @param winid [Integer] 
     #   @return [Wx::HeaderCtrlEvent]
     # @overload initialize(event)

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

@@ -23,7 +23,7 @@ module Wx::HTML
   class HtmlCellEvent < CommandEvent
   
     # The constructor is not normally used by the user code.
-    # @param commandType [Wx::StaticLine::EventType] 
+    # @param commandType [Wx::Notebook::EventType] 
     # @param id [Integer] 
     # @param cell [Wx::HTML::HtmlCell] 
     # @param point [Array(Integer, Integer), Wx::Point] 

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

@@ -253,13 +253,11 @@ module Wx
   # One colour value of the image may be used as a mask colour which will lead to the automatic creation of a {Wx::Mask} object associated to the bitmap object.
   # 
   # ## Alpha channel support
-  # 
   # Starting from wxWidgets 2.5.0 {Wx::Image} supports alpha channel data, that is in addition to a byte for the red, green and blue colour components for each pixel it also stores a byte representing the pixel opacity.
   # An alpha value of 0 corresponds to a transparent pixel (null opacity) while a value of 255 means that the pixel is 100% opaque. The constants {Wx::IMAGE_ALPHA_TRANSPARENT} and {Wx::IMAGE_ALPHA_OPAQUE} can be used to indicate those values in a more readable form.
   # While all images have RGB data, not all images have an alpha channel. Before using {Wx::Image#get_alpha} you should check if this image contains an alpha channel with {Wx::Image#has_alpha}. Currently the BMP, PNG, TGA, and TIFF format handlers have full alpha channel support for loading so if you want to use alpha you have to use one of these formats. If you initialize the image alpha channel yourself using {Wx::Image#set_alpha}, you should save it in either PNG, TGA, or TIFF format to avoid losing it as these are the only handlers that currently support saving with alpha.
   # 
   # ## Available image handlers
-  # 
   # The following image handlers are available. {Wx::BMPHandler} is always installed by default. In wxRuby all image handlers are loaded by default at startup by {init_all_image_handlers}.
   # 
   # - {Wx::BMPHandler}: For loading (including alpha support) and saving, always installed.

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

@@ -329,7 +329,6 @@ module Wx
   # </div>
   # 
   # ## Column Ordering
-  # 
   # By default, the columns of a list control appear on the screen in order of their indices, i.e. column 0 appears first, then column 1 next, and so on. However this can be changed by using the {Wx::ListCtrl#set_columns_order} function to arbitrarily reorder the columns visual order.
   # The user can also rearrange the columns interactively by dragging them. In this case, the index of the column is not the same as its order and the functions {Wx::ListCtrl#get_column_order} and {Wx::ListCtrl#get_column_index_from_order} should be used to translate between them.
   # 

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

@@ -65,7 +65,7 @@ module Wx
   class ListEvent < NotifyEvent
   
     # Constructor.
-    # @param commandType [Wx::StaticLine::EventType] 
+    # @param commandType [Wx::Notebook::EventType] 
     # @param id [Integer] 
     # @return [Wx::ListEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end

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

@@ -11,13 +11,11 @@ module Wx
   # {Wx::MediaCtrl} uses native backends to render media, for example on Windows there is a ActiveMovie/DirectShow backend, and on Macintosh there is a QuickTime backend.
   # 
   # ## Rendering media
-  # 
   # Depending upon the backend, {Wx::MediaCtrl} can render and display pretty much any kind of media that the native system can - such as an image, mpeg video, or mp3 (without license restrictions - since it relies on native system calls that may not technically have mp3 decoding available, for example, it falls outside the realm of licensing restrictions).
   # For general operation, all you need to do is call {Wx::MediaCtrl#load} to load the file you want to render, catch the EVT_MEDIA_LOADED event, and then call {Wx::MediaCtrl#play} to show the video/audio of the media in that event.
   # More complex operations are generally more heavily dependent on the capabilities of the backend. For example, QuickTime cannot set the playback rate of certain streaming media - while DirectShow is slightly more flexible in that regard.
   # 
   # ## Operation
-  # 
   # When {Wx::MediaCtrl} plays a file, it plays until the stop position is reached (currently the end of the file/stream). Right before it hits the end of the stream, it fires off a EVT_MEDIA_STOP event to its parent window, at which point the event handler can choose to veto the event, preventing the stream from actually stopping.
   # Example:
   # 
@@ -40,16 +38,13 @@ module Wx
   # Note that when changing the state of the media through {Wx::MediaCtrl#play} and other methods, the media may not actually be in the {Wx::MediaState::MEDIASTATE_PLAYING}, for example. If you are relying on the media being in certain state, catch the event relevant to the state. See {Wx::MediaEvent} for the kinds of events that you can catch.
   # 
   # ## Video size
-  # 
   # By default, {Wx::MediaCtrl} will scale the size of the video to the requested amount passed to either its constructor or {Wx::MediaCtrl#create}. After calling {Wx::MediaCtrl#load} or performing an equivalent operation, you can subsequently obtain the "real" size of the video (if there is any) by calling {Wx::MediaCtrl#get_best_size}. Note that the actual result on the display will be slightly different when {Wx::MediaCtrl#show_player_controls} is activated and the actual video size will be less than specified due to the extra controls provided by the native toolkit. In addition, the backend may modify {Wx::MediaCtrl#get_best_size} to include the size of the extra controls - so if you want the real size of the video just disable {Wx::MediaCtrl#show_player_controls}.
   # The idea with setting {Wx::MediaCtrl#get_best_size} to the size of the video is that {Wx::MediaCtrl#get_best_size} is a {Wx::Window}-derived function that is called when sizers on a window recalculate. What this means is that if you use sizers by default the video will show in its original size without any extra assistance needed from the user.
   # 
   # ## Player controls
-  # 
   # Normally, when you use {Wx::MediaCtrl} it is just a window for the video to play in. However, some toolkits have their own media player interface. For example, QuickTime generally has a bar below the video with a slider. A special feature available to {Wx::MediaCtrl}, you can use the toolkits interface instead of making your own by using the {Wx::MediaCtrl#show_player_controls} function. There are several options for the flags parameter, with the two general flags being {Wx::MediaCtrlPlayerControls::MEDIACTRLPLAYERCONTROLS_NONE} which turns off the native interface, and {Wx::MediaCtrlPlayerControls::MEDIACTRLPLAYERCONTROLS_DEFAULT} which lets {Wx::MediaCtrl} decide what native controls on the interface. Be sure to review the caveats outlined in Video size before doing so.
   # 
   # ## Choosing a backend
-  # 
   # Generally, you should almost certainly leave this part up to {Wx::MediaCtrl} - but if you need a certain backend for a particular reason, such as QuickTime for playing .mov files, all you need to do to choose a specific backend is to pass the name of the backend class to {Wx::MediaCtrl#create}.
   # The following are valid backend identifiers:
   # 
@@ -59,7 +54,6 @@ module Wx
   # - <b>{Wx::MEDIABACKEND_WMP10}</b>, Use Windows Media Player 10 (Windows only). Works on systems with either Windows Media Player 9 or 10 installed.
   # 
   # ## Creating a backend
-  # 
   # Creating a backend for {Wx::MediaCtrl} is a rather simple process. Simply derive from {Wx::MediaBackendCommonBase} and implement the methods you want. The methods in {Wx::MediaBackend} correspond to those in {Wx::MediaCtrl} except for {Wx::MediaCtrl::CreateControl} which does the actual creation of the control, in cases where a custom control is not needed you may simply call {Wx::Control#create}.
   # You need to make sure to use the {Wx::DECLARE_CLASS} and {Wx::IMPLEMENT_CLASS} macros.
   # The only real tricky part is that you need to make sure the file in compiled in, which if there are just backends in there will not happen and you may need to use a force link hack (see {Wx::FORCE_LINK_MODULE} usage in the mediactrl sample).

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

@@ -106,7 +106,7 @@ module Wx
   class MediaEvent < NotifyEvent
   
     # Default ctor.
-    # @param commandType [Wx::StaticLine::EventType] 
+    # @param commandType [Wx::Notebook::EventType] 
     # @param winid [Integer] 
     # @return [Wx::MediaEvent]
     def initialize(commandType=Wx::EVT_NULL, winid=0) end

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

@@ -21,12 +21,10 @@ module Wx
   # The radio items are similar to the check items except that all the other items in the same radio group are unchecked when a radio item is checked. The radio group is formed by a contiguous range of radio items, i.e. it starts at the first item of this kind and ends with the first item of a different kind (or the end of the menu). Notice that because the radio groups are defined in terms of the item positions inserting or removing the items in the menu containing the radio items risks to not work correctly.
   # 
   # ## Allocation strategy
-  # 
   # All menus must be created on the <b>heap</b> because all menus attached to a menubar or to another menu will be deleted by their parent when it is deleted. The only exception to this rule are the popup menus (i.e. menus used with {Wx::Window#popup_menu}) as wxWidgets does not destroy them to allow reusing the same menu more than once. But the exception applies only to the menus themselves and not to any submenus of popup menus which are still destroyed by wxWidgets as usual and so must be heap-allocated.
   # As the frame menubar is deleted by the frame itself, it means that normally all menus used are deleted automatically.
   # 
   # ## Event handling
-  # 
   # Event handlers for the commands generated by the menu items can be connected directly to the menu object itself using {Wx::EvtHandler#bind}. If this menu is a submenu of another one, the events from its items can also be processed in the parent menu and so on, recursively.
   # If the menu is part of a menu bar, then events can also be handled in {Wx::MenuBar} object.
   # Finally, menu events can also be handled in the associated window, which is either the {Wx::Frame} associated with the menu bar this menu belongs to or the window for which {Wx::Window#popup_menu} was called for the popup menus.

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

@@ -91,7 +91,6 @@ module Wx
   # - {Wx::EvtHandler#evt_notebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_NOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
   # 
   # ## Page backgrounds
-  # 
   # On Windows, the default theme paints a background on the notebook's pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use {Wx::NB_NOPAGETHEME} to disable themed drawing for a particular notebook, you can call {Wx::SystemOptions.set_option} to disable it for the whole application, or you can disable it for individual pages by using {Wx::Notebook#set_background_colour}.
   # To disable themed pages globally: 
   # ```ruby

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