wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,511 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The possible styles for a {Wx::Pen}.
+  # 
+  # Note that hatched pen styles are not supported by X11-based ports, including WXGTK.
+  # 
+  class PenStyle < Wx::Enum
+  
+    # 
+    # 
+    PENSTYLE_INVALID = Wx::PenStyle.new(-1)
+    
+    # Solid style.
+    # 
+    PENSTYLE_SOLID = Wx::PenStyle.new(100)
+    
+    # Dotted style.
+    # 
+    PENSTYLE_DOT = Wx::PenStyle.new(101)
+    
+    # Long dashed style.
+    # 
+    PENSTYLE_LONG_DASH = Wx::PenStyle.new(102)
+    
+    # Short dashed style.
+    # 
+    PENSTYLE_SHORT_DASH = Wx::PenStyle.new(103)
+    
+    # Dot and dash style.
+    # 
+    PENSTYLE_DOT_DASH = Wx::PenStyle.new(104)
+    
+    # Use the user dashes: see {Wx::Pen#set_dashes}.
+    # 
+    PENSTYLE_USER_DASH = Wx::PenStyle.new(105)
+    
+    # No pen is used.
+    # 
+    PENSTYLE_TRANSPARENT = Wx::PenStyle.new(106)
+    
+    # Use the stipple bitmap.
+    # 
+    PENSTYLE_STIPPLE = Wx::PenStyle.new(110)
+    
+    # Backward diagonal hatch.
+    # 
+    PENSTYLE_BDIAGONAL_HATCH = Wx::PenStyle.new(111)
+    
+    # Cross-diagonal hatch.
+    # 
+    PENSTYLE_CROSSDIAG_HATCH = Wx::PenStyle.new(112)
+    
+    # Forward diagonal hatch.
+    # 
+    PENSTYLE_FDIAGONAL_HATCH = Wx::PenStyle.new(113)
+    
+    # Cross hatch.
+    # 
+    PENSTYLE_CROSS_HATCH = Wx::PenStyle.new(114)
+    
+    # Horizontal hatch.
+    # 
+    PENSTYLE_HORIZONTAL_HATCH = Wx::PenStyle.new(115)
+    
+    # Vertical hatch.
+    # 
+    PENSTYLE_VERTICAL_HATCH = Wx::PenStyle.new(116)
+    
+    # First of the hatch styles (inclusive).
+    # 
+    PENSTYLE_FIRST_HATCH = Wx::PenStyle.new(111)
+    
+    # Last of the hatch styles (inclusive).
+    # 
+    PENSTYLE_LAST_HATCH = Wx::PenStyle.new(116)
+    
+  end # PenStyle
+  
+  # Possible values for pen quality.
+  # 
+  # Pen quality is currently only used in WXMSW; the other ports ignore it and always use the same default pen quality.
+  # In WXMSW, the choice of quality affects whether "cosmetic" or "geometric" native pens are used in situations when both are usable. Notably, for dotted and dashed pens of width 1, high quality geometric pens are used by default since wxWidgets 3.1.4, while previous versions used lower quality (but much faster) cosmetic pens. If drawing performance is more important than the exact appearance of the lines drawn using this pen, low quality may be explicitly selected.
+  # See {Wx::PenInfo#quality} and {Wx::Pen#set_quality}.
+  # 
+  class PenQuality < Wx::Enum
+  
+    # Select the appropriate quality automatically.
+    # 
+    PEN_QUALITY_DEFAULT = Wx::PenQuality.new(0)
+    
+    # Less good looking but faster.
+    # 
+    PEN_QUALITY_LOW = Wx::PenQuality.new(1)
+    
+    # Best looking, at the expense of speed.
+    # 
+    PEN_QUALITY_HIGH = Wx::PenQuality.new(2)
+    
+  end # PenQuality
+  
+  # The possible join values of a {Wx::Pen}.
+  # 
+  # Todouse {Wx::PENJOIN_} prefix
+  # 
+  class PenJoin < Wx::Enum
+  
+    # 
+    # 
+    JOIN_INVALID = Wx::PenJoin.new(-1)
+    
+    # The intersection of two lines will have a diagonal edge "cut" into it.
+    # 
+    JOIN_BEVEL = Wx::PenJoin.new(120)
+    
+    # The intersection of two lines will have a sharp corner.
+    # 
+    JOIN_MITER = Wx::PenJoin.new(121)
+    
+    # The intersection of two lines will have a rounded edge.
+    # 
+    JOIN_ROUND = Wx::PenJoin.new(122)
+    
+  end # PenJoin
+  
+  # The possible cap values of a {Wx::Pen}.
+  # 
+  # Todouse {Wx::PENCAP_} prefix
+  # 
+  class PenCap < Wx::Enum
+  
+    # 
+    # 
+    CAP_INVALID = Wx::PenCap.new(-1)
+    
+    # The pen will have a rounded edge and will extend beyond the start and end of a line.
+    # 
+    CAP_ROUND = Wx::PenCap.new(130)
+    
+    # The pen's edge will be square and will extend beyond the start and end of a line.
+    # 
+    CAP_PROJECTING = Wx::PenCap.new(131)
+    
+    # The pen's edge will be square and will not extend beyond the start and end of a line.
+    # 
+    CAP_BUTT = Wx::PenCap.new(132)
+    
+  end # PenCap
+  
+  # An empty pen.
+  # 
+  NULL_PEN = nil
+  
+  # A pen is a tool for drawing outlines.
+  # 
+  # It is used for drawing lines and painting the outline of rectangles, ellipses, etc. It has a colour, a width and a style.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>On a monochrome display, wxWidgets shows all non-white pens as black.
+  # </p>
+  # </div>
+  # 
+  # Do not initialize objects on the stack before the program commences, since other required structures may not have been set up yet. Instead, define global pointers to objects and create them in {Wx::App#on_init} or when required.
+  # An application may wish to dynamically create pens with different characteristics, and there is the consequent danger that a large number of duplicate pens will be created. Therefore, an application may wish to get a pointer to a pen by using the global list of pens, {Wx::ThePenList}, and calling the member function Wx::PenList#find_or_create_pen. See {Wx::PenList} for more info.
+  # This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed, it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: 
+  # 
+  # - {Wx::NULL_PEN} 
+  # 
+  # - {Wx::BLACK_DASHED_PEN} 
+  # 
+  # - {Wx::BLACK_PEN} 
+  # 
+  # - {Wx::BLUE_PEN} 
+  # 
+  # - {Wx::CYAN_PEN} 
+  # 
+  # - {Wx::GREEN_PEN} 
+  # 
+  # - {Wx::YELLOW_PEN} 
+  # 
+  # - {Wx::GREY_PEN} 
+  # 
+  # - {Wx::LIGHT_GREY_PEN} 
+  # 
+  # - {Wx::MEDIUM_GREY_PEN} 
+  # 
+  # - {Wx::RED_PEN} 
+  # 
+  # - {Wx::TRANSPARENT_PEN} 
+  # 
+  # - {Wx::WHITE_PEN}
+  # @see Wx::PenList
+  # @see  Wx::DC
+  # @see  Wx::DC#set_pen 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class Pen < GDIObject
+  
+    # @overload set_colour(colour)
+    #   The pen's colour is changed to the given colour.
+    #   
+    #   
+    #   @see Wx::Pen#get_colour 
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @return [void]
+    # @overload set_colour(red, green, blue)
+    #   The pen's colour is changed to the given colour.
+    #   
+    #   
+    #   @see Wx::Pen#get_colour 
+    #   @param red [Integer] 
+    #   @param green [Integer] 
+    #   @param blue [Integer] 
+    #   @return [void]
+    def set_colour(*args) end
+    alias_method :colour=, :set_colour
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   The pen will be uninitialised, and {Wx::Pen#is_ok} will return false.
+    #   @return [Wx::Pen]
+    # @overload initialize(colour, width=1, style=Wx::PenStyle::PENSTYLE_SOLID)
+    #   Constructs a pen from a colour object, pen width and style.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Different versions of Windows and different versions of other platforms support very different subsets of the styles above, so handle with care.
+    #   </p>
+    #   </div>
+    #   @see Wx::Pen#set_style
+    #   @see  Wx::Pen#set_colour
+    #   @see  Wx::Pen#set_width 
+    #   @param colour [Wx::Colour,String,Symbol]  A colour object.
+    #   @param width [Integer]  Pen width. Under Windows, the pen width cannot be greater than 1 if the style is {Wx::PenStyle::PENSTYLE_DOT}, {Wx::PenStyle::PENSTYLE_LONG_DASH}, {Wx::PenStyle::PENSTYLE_SHORT_DASH}, {Wx::PenStyle::PENSTYLE_DOT_DASH}, or {Wx::PenStyle::PENSTYLE_USER_DASH}.
+    #   @param style [Wx::PenStyle]  The style may be one of the {Wx::PenStyle} values.
+    #   @return [Wx::Pen]
+    # @overload initialize(pen)
+    #   Copy constructor, uses Reference Counting.
+    #   @param pen [Wx::Pen]  A pointer or reference to a pen to copy.
+    #   @return [Wx::Pen]
+    def initialize(*args) end
+    
+    # Returns the pen cap style, which may be one of {Wx::PenCap::CAP_ROUND}, {Wx::PenCap::CAP_PROJECTING} or {Wx::PenCap::CAP_BUTT}.
+    # 
+    # The default is {Wx::PenCap::CAP_ROUND}.
+    # @see Wx::Pen#set_cap 
+    # @return [Wx::PenCap]
+    def get_cap; end
+    alias_method :cap, :get_cap
+    
+    # Returns the pen quality.
+    # 
+    # The default is {Wx::PenQuality::PEN_QUALITY_DEFAULT}.
+    # @see Wx::PenQuality
+    # @see  Wx::Pen#set_quality 
+    # @return [Wx::PenQuality]
+    def get_quality; end
+    alias_method :quality, :get_quality
+    
+    # Returns a reference to the pen colour.
+    # 
+    # 
+    # @see Wx::Pen#set_colour 
+    # @return [Wx::Colour]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+    # Returns the pen join style, which may be one of {Wx::PenJoin::JOIN_BEVEL}, {Wx::PenJoin::JOIN_ROUND} or {Wx::PenJoin::JOIN_MITER}.
+    # 
+    # The default is {Wx::PenJoin::JOIN_ROUND}.
+    # @see Wx::Pen#set_join 
+    # @return [Wx::PenJoin]
+    def get_join; end
+    alias_method :join, :get_join
+    
+    # Gets a pointer to the stipple bitmap.
+    # 
+    # 
+    # @see Wx::Pen#set_stipple 
+    # @return [Wx::Bitmap]
+    def get_stipple; end
+    alias_method :stipple, :get_stipple
+    
+    # Returns the pen style.
+    # 
+    # 
+    # @see Wx::Pen#initialize
+    # @see  Wx::Pen#set_style 
+    # @return [Wx::PenStyle]
+    def get_style; end
+    alias_method :style, :get_style
+    
+    # Returns the pen width.
+    # 
+    # 
+    # @see Wx::Pen#set_width 
+    # @return [Integer]
+    def get_width; end
+    alias_method :width, :get_width
+    
+    # Returns true if the pen is initialised.
+    # 
+    # Notice that an uninitialized pen object can't be queried for any pen properties and all calls to the accessor methods on it will result in an assert failure.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns true if the pen is a valid non-transparent pen.
+    # 
+    # This method returns true if the pen object is initialized and has a non-transparent style. Notice that this should be used instead of simply testing whether {Wx::Pen#get_style} returns a style different from {Wx::PenStyle::PENSTYLE_TRANSPARENT} if the pen may be invalid as {Wx::Pen#get_style} would assert in this case.
+    # @see Wx::Pen#is_transparent
+    # @return [Boolean]
+    def is_non_transparent; end
+    alias_method :non_transparent?, :is_non_transparent
+    
+    # Returns true if the pen is transparent.
+    # 
+    # A transparent pen is simply a pen with {Wx::PenStyle::PENSTYLE_TRANSPARENT} style.
+    # Notice that this function works even for non-initialized pens (for which it returns false) unlike tests of the form <code>Wx::Pen#get_style == wxPENSTYLE_TRANSPARENT</code> which would assert if the pen is invalid.
+    # @see Wx::Pen#is_non_transparent
+    # @return [Boolean]
+    def is_transparent; end
+    alias_method :transparent?, :is_transparent
+    
+    # Sets the pen cap style, which may be one of {Wx::PenCap::CAP_ROUND}, {Wx::PenCap::CAP_PROJECTING} or {Wx::PenCap::CAP_BUTT}.
+    # 
+    # The default is {Wx::PenCap::CAP_ROUND}.
+    # @see Wx::Pen#get_cap 
+    # @param capStyle [Wx::PenCap] 
+    # @return [void]
+    def set_cap(capStyle) end
+    alias_method :cap=, :set_cap
+    
+    # Sets the pen quality.
+    # 
+    # Explicitly selecting low pen quality may be useful in WXMSW if drawing performance is more important than the exact appearance of the lines drawn with this pen.
+    # @see Wx::PenQuality
+    # @param quality [Wx::PenQuality] 
+    # @return [void]
+    def set_quality(quality) end
+    alias_method :quality=, :set_quality
+    
+    # Sets the pen join style, which may be one of {Wx::PenJoin::JOIN_BEVEL}, {Wx::PenJoin::JOIN_ROUND} or {Wx::PenJoin::JOIN_MITER}.
+    # 
+    # The default is {Wx::PenJoin::JOIN_ROUND}.
+    # @see Wx::Pen#get_join 
+    # @param join_style [Wx::PenJoin] 
+    # @return [void]
+    def set_join(join_style) end
+    alias_method :join=, :set_join
+    
+    # Sets the bitmap for stippling.
+    # 
+    # 
+    # @see Wx::Pen#get_stipple 
+    # @param stipple [Wx::Bitmap] 
+    # @return [void]
+    def set_stipple(stipple) end
+    alias_method :stipple=, :set_stipple
+    
+    # Set the pen style.
+    # 
+    # 
+    # @see Wx::Pen#initialize 
+    # @param style [Wx::PenStyle] 
+    # @return [void]
+    def set_style(style) end
+    alias_method :style=, :set_style
+    
+    # Sets the pen width.
+    # 
+    # 
+    # @see Wx::Pen#get_width 
+    # @param width [Integer] 
+    # @return [void]
+    def set_width(width) end
+    alias_method :width=, :set_width
+    
+    # Equality operator.
+    # 
+    # See reference-counted object comparison for more info.
+    # @param pen [Wx::Pen] 
+    # @return [Boolean]
+    def ==(pen) end
+    
+  end # Pen
+  
+  # This class is a helper used for {Wx::Pen} creation using named parameter idiom: it allows specifying various {Wx::Pen} attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to {Wx::Pen} constructors.
+  # 
+  # For instance, to create a dotted blue pen with the given join style you could do 
+  # ```ruby
+  #   pen = Wx::Pen.new(Wx::PenInfo.new(Wx::BLUE).style(Wx::PENSTYLE_DOT).join(Wx::JOIN_BEVEL))  
+  # ```
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class PenInfo < ::Object
+  
+    # Constructor, which can set the colour, width and style for the pen.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @param width [Integer] 
+    # @param style [Wx::PenStyle] 
+    # @return [Wx::PenInfo]
+    def initialize(colour=(Wx::Colour.new()), width=1, style=Wx::PenStyle::PENSTYLE_SOLID) end
+    
+    # Sets the colour for the pen.
+    # @param col [Wx::Colour,String,Symbol] 
+    # @return [Wx::PenInfo]
+    def colour(col) end
+    
+    # Sets the line width for the pen.
+    # @param width [Integer] 
+    # @return [Wx::PenInfo]
+    def width(width) end
+    
+    # Sets the style for the pen.
+    # @param style [Wx::PenStyle] 
+    # @return [Wx::PenInfo]
+    def style(style) end
+    
+    # Sets the bitmap used for stippling.
+    # 
+    # When the pen is used, a repeating pattern of this bitmap will be drawn.
+    # @param stipple [Wx::Bitmap] 
+    # @return [Wx::PenInfo]
+    def stipple(stipple) end
+    
+    # Sets the join for the pen, which is the appearance of where two lines meet or overlap.
+    # @param join [Wx::PenJoin] 
+    # @return [Wx::PenInfo]
+    def join(join) end
+    
+    # Sets the cap (i.e., the end point) for the pen.
+    # @param cap [Wx::PenCap] 
+    # @return [Wx::PenInfo]
+    def cap(cap) end
+    
+    # Set the pen quality.
+    # 
+    # Using {Wx::PenInfo#low_quality} or {Wx::PenInfo#high_quality} is usually more convenient.
+    # @see Wx::Pen#set_quality
+    # @param quality [Wx::PenQuality] 
+    # @return [Wx::PenInfo]
+    def quality(quality) end
+    
+    # Set low pen quality.
+    # 
+    # This is the same as calling {Wx::PenInfo#quality} with {Wx::PenQuality::PEN_QUALITY_LOW}.
+    # @return [Wx::PenInfo]
+    def low_quality; end
+    
+    # Set high pen quality.
+    # 
+    # This is the same as calling {Wx::PenInfo#quality} with {Wx::PenQuality::PEN_QUALITY_HIGH}.
+    # @return [Wx::PenInfo]
+    def high_quality; end
+    
+    # Returns the pen's colour.
+    # @return [Wx::Colour]
+    def get_colour; end
+    
+    # Returns the pen's stipple bitmap.
+    # @return [Wx::Bitmap]
+    def get_stipple; end
+    
+    # Returns the pen's style.
+    # @return [Wx::PenStyle]
+    def get_style; end
+    
+    # Returns the pen's joining method.
+    # @return [Wx::PenJoin]
+    def get_join; end
+    
+    # Returns the pen's cap (i.e., end-point style).
+    # @return [Wx::PenCap]
+    def get_cap; end
+    
+    # Returns the pen's quality.
+    # @return [Wx::PenQuality]
+    def get_quality; end
+    
+    # Returns the number of dashes in the pen's dash pattern.
+    # @return [Integer]
+    def get_dash_count; end
+    alias_method :dash_count, :get_dash_count
+    
+    # Returns whether the pen is transparent.
+    # @return [Boolean]
+    def is_transparent; end
+    alias_method :transparent?, :is_transparent
+    
+    # Returns the pen's line width.
+    # @return [Integer]
+    def get_width; end
+    
+  end # PenInfo
+  
+
+end

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 nil 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 Wx::PersistentWindow<> 
+  # 
+  # 
+  # @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