# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx::PG

  # Most of the shared property manipulation interface shared by {Wx::PG::PropertyGrid}, {Wx::PG::PropertyGridPage}, and {Wx::PG::PropertyGridManager} is defined in this class.
  # 
  # <div class="wxrb-remark">
  # <b>Remark:</b>
  # <p>
  # 
  # - In separate {Wx::PG::PropertyGrid} component this class was known as {Wx::PropertyContainerMethods}.
  # - {Wx::PG::PropertyGridInterface}'s property operation member functions all accept a special {Wx::PGPropArg} id argument, using which you can refer to properties either by their pointer (for performance) or by their name (for conveniency).
  # 
  # </p>
  # </div>
  # 
  # Category:  {Wx::PG::PropertyGrid}
  # 
  # 
  # @note  In wxRuby this is a mixin module instead of a (base) class.
  # @wxrb_require USE_PROPGRID
  module PropertyGridInterface
  
    # 
    # 
    # Flags for {Wx::PG::PropertyGridInterface#save_editable_state} and {Wx::PG::PropertyGridInterface#restore_editable_state}.
    # 
    # @wxrb_require USE_PROPGRID
    class EditableStateFlags < Wx::Enum
    
      # Include selected property.
      # 
      SelectionState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(1)
      
      # Include expanded/collapsed property information.
      # 
      ExpandedState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(2)
      
      # Include scrolled position.
      # 
      ScrollPosState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(4)
      
      # Include selected page information.
      # 
      PageState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(8)
      
      # Include splitter position.
      # 
      SplitterPosState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(16)
      
      # Include description box size.
      # 
      DescBoxState = Wx::PG::PropertyGridInterface::EditableStateFlags.new(32)
      
      # Include all supported user editable state information.
      # 
      AllStates = Wx::PG::PropertyGridInterface::EditableStateFlags.new(63)
      
    end # EditableStateFlags
    
    # Appends property to the list.
    # 
    # {Wx::PG::PropertyGrid} assumes ownership of the object. Becomes child of most recently added category.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - {Wx::PG::PropertyGrid} takes the ownership of the property pointer.
    # - If appending a category with name identical to a category already in the {Wx::PG::PropertyGrid}, then newly created category is deleted, and most recently added category (under which properties are appended) is set to the one with same name. This allows easier adding of items to same categories in multiple passes.
    # - Does not automatically redraw the control, so you may need to call Refresh() when calling this function after control has been shown for the first time.
    # - This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
    # 
    # </p>
    # </div>
    # @param property [Wx::PG::PGProperty] 
    # @return [Wx::PG::PGProperty]
    def append(property) end
    
    # Same as {Wx::PG::PropertyGridInterface#append}, but appends under given parent property.
    # @param id [String,Wx::PG::PGProperty]  Name or pointer to parent property.
    # @param newProperty [Wx::PG::PGProperty]  Property to be added.
    # @return [Wx::PG::PGProperty]
    def append_in(id, newProperty) end
    
    # In order to add new items into a property with private children (for instance, {Wx::PG::FlagsProperty}), you need to call this method.
    # 
    # After populating has been finished, you need to call {Wx::PG::PropertyGridInterface#end_add_children}.
    # @see Wx::PG::PropertyGridInterface#end_add_children 
    # @param id [String,Wx::PG::PGProperty] 
    # @return [void]
    def begin_add_children(id) end
    
    # Deletes all properties.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
    # </p>
    # </div>
    # @return [void]
    def clear; end
    
    # Clears current selection, if any.
    # 
    # Returns true if successful or if there was no selection. May fail if validation was enabled and active editor had invalid value.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG_EVT_SELECTED}.
    # </p>
    # </div>
    # @see Wx::PG::PropertyGrid#select_property 
    # @param validation [Boolean]  If set to false, deselecting the property will always work, even if its editor had invalid value in it.
    # @return [Boolean]
    def clear_selection(validation=false) end
    
    # Resets modified status of all properties.
    # @return [void]
    def clear_modified_status; end
    
    # Collapses given category or property with children.
    # 
    # Returns true if actually collapsed.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This function may deselect selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def collapse(id) end
    
    # Collapses all items that can be collapsed.
    # 
    # Return false if failed (may fail if editor value cannot be validated).
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This functions clears selection. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
    # </p>
    # </div>
    # @return [Boolean]
    def collapse_all; end
    
    # Changes value of a property, as if by user.
    # 
    # Use this instead of {Wx::PG::PropertyGridInterface#set_property_value} if you need the value to run through validation process, and also send {Wx::PG::EVT_PG_CHANGED}.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
    # </p>
    # </div>
    # 
    # Returns true if value was successfully changed.
    # @param id [String,Wx::PG::PGProperty] 
    # @param newValue [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
    # @return [Boolean]
    def change_property_value(id, newValue) end
    
    # Removes and deletes a property and any children.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>If you delete a property in a {Wx::PG::PropertyGrid} event handler, the actual deletion is postponed until the next idle event.
    # </p>
    # </div>
    # 
    # This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
    # @param id [String,Wx::PG::PGProperty]  Pointer or name of a property.
    # @return [void]
    def delete_property(id) end
    
    # Disables a property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Property is refreshed with new settings.
    # </p>
    # </div>
    # @see Wx::PG::PropertyGridInterface#enable_property
    # @see  Wx::PG::PGProperty#enable 
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def disable_property(id) end
    
    # Returns true if all property grid data changes have been committed.
    # 
    # Usually only returns false if value in active editor has been invalidated by a {Wx::Validator}.
    # @return [Boolean]
    def editor_validate; end
    
    # Enables or disables property.
    # 
    # Disabled property usually appears as having grey text.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Property is refreshed with new settings.
    # </p>
    # </div>
    # @see Wx::PG::PGProperty#enable 
    # @param id [String,Wx::PG::PGProperty]  Name or pointer to a property.
    # @param enable [Boolean]  If false, property is disabled instead.
    # @return [Boolean]
    def enable_property(id, enable=true) end
    
    # Called after population of property with fixed children has finished.
    # 
    # 
    # @see Wx::PG::PropertyGridInterface#begin_add_children 
    # @param id [String,Wx::PG::PGProperty] 
    # @return [void]
    def end_add_children(id) end
    
    # Expands given category or property with children.
    # 
    # Returns true if actually expanded.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This function may deselect selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def expand(id) end
    
    # Expands all items that can be expanded.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This functions clears selection. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
    # </p>
    # </div>
    # @param expand [Boolean] 
    # @return [Boolean]
    def expand_all(expand=true) end
    
    # Returns auto-resize proportion of the given column.
    # 
    # 
    # @see Wx::PG::PropertyGridInterface#set_column_proportion 
    # @param column [Integer] 
    # @return [Integer]
    def get_column_proportion(column) end
    alias_method :column_proportion, :get_column_proportion
    
    # Returns id of first child of given property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Does not return private children! 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::PG::PGProperty]
    def get_first_child(id) end
    alias_method :first_child, :get_first_child
    
    # @param flags [Integer] 
    # @return [Wx::PG::PGProperty]
    def get_first(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_ALL) end
    alias_method :first, :get_first
    
    # Returns pointer to a property with given name (case-sensitive).
    # 
    # If there is no property with such name, NULL pointer is returned.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>". 
    # </p>
    # </div>
    # @param name [String] 
    # @return [Wx::PG::PGProperty]
    def get_property(name) end
    alias_method :property, :get_property
    
    # Adds to targetArr pointers to properties that have given flags set.
    # 
    # However, if inverse is set to true, then only properties without given flags are stored.
    # @param flags [Integer]  Property flags to use.
    # @param inverse [Boolean]  If false, properties that have given flags are stored, otherwise there are stored only properties without given flags.
    # @param iterFlags [Integer]  Iterator flags to use. Default is everything expect private children. See wxPropertyGridIterator Flags.
    # @return [Array<Wx::PG::PGProperty>]
    def get_properties_with_flag(flags, inverse=false, iterFlags=((Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_PROPERTIES|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_HIDDEN|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_CATEGORIES))) end
    alias_method :properties_with_flag, :get_properties_with_flag
    
    # Returns value of given attribute.
    # 
    # If none found, returns {Wx::NullVariant}.
    # @param id [String,Wx::PG::PGProperty] 
    # @param attrName [String] 
    # @return [Wx::Variant]
    def get_property_attribute(id, attrName) end
    alias_method :property_attribute, :get_property_attribute
    
    # Returns background colour of first cell of a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::Colour]
    def get_property_background_colour(id) end
    alias_method :property_background_colour, :get_property_background_colour
    
    # Returns pointer of property's nearest parent category.
    # 
    # If no category found, returns NULL.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::PG::PropertyCategory]
    def get_property_category(id) end
    alias_method :property_category, :get_property_category
    
    # Returns client data (void*) of a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Object]
    def get_property_client_data(id) end
    alias_method :property_client_data, :get_property_client_data
    
    # Returns first property which label matches given string.
    # 
    # NULL if none found. Note that this operation is very slow when compared to {Wx::PG::PropertyGridInterface#get_property_by_name}.
    # @param label [String] 
    # @return [Wx::PG::PGProperty]
    def get_property_by_label(label) end
    alias_method :property_by_label, :get_property_by_label
    
    # @overload get_property_by_name(name)
    #   Returns pointer to a property with given name (case-sensitive).
    #   
    #   If there is no property with such name, NULL pointer is returned.
    #   
    #   <div class="wxrb-remark">
    #   <b>Remark:</b>
    #   <p>Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>". 
    #   </p>
    #   </div>
    #   @param name [String] 
    #   @return [Wx::PG::PGProperty]
    # @overload get_property_by_name(name, subname)
    #   Returns child property subname of property name.
    #   
    #   Same as calling GetPropertyByName("name.subname"), albeit slightly faster.
    #   @param name [String] 
    #   @param subname [String] 
    #   @return [Wx::PG::PGProperty]
    def get_property_by_name(*args) end
    alias_method :property_by_name, :get_property_by_name
    
    # Returns property's editor.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::PG::PGEditor]
    def get_property_editor(id) end
    alias_method :property_editor, :get_property_editor
    
    # Returns help string associated with a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [String]
    def get_property_help_string(id) end
    alias_method :property_help_string, :get_property_help_string
    
    # Returns property's custom value image (NULL of none).
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::Bitmap]
    def get_property_image(id) end
    alias_method :property_image, :get_property_image
    
    # Returns label of a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::String]
    def get_property_label(id) end
    alias_method :property_label, :get_property_label
    
    # Returns property's name, by which it is globally accessible.
    # @param property [Wx::PG::PGProperty] 
    # @return [String]
    def get_property_name(property) end
    alias_method :property_name, :get_property_name
    
    # Returns parent item of a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::PG::PGProperty]
    def get_property_parent(id) end
    alias_method :property_parent, :get_property_parent
    
    # Returns text colour of first cell of a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::Colour]
    def get_property_text_colour(id) end
    alias_method :property_text_colour, :get_property_text_colour
    
    # Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::Validator]
    # @wxrb_require USE_VALIDATORS
    def get_property_validator(id) end
    alias_method :property_validator, :get_property_validator
    
    # Returns property's value as {Wx::Variant}.
    # 
    # If property value is unspecified, {Wx::NullVariant} is returned.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Wx::Variant]
    def get_property_value(id) end
    alias_method :property_value, :get_property_value
    
    # Return's property's value as {Wx::ArrayInt}.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Array<Integer>]
    def get_property_value_as_array_int(id) end
    alias_method :property_value_as_array_int, :get_property_value_as_array_int
    
    # Returns property's value as {Wx::ArrayString}.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Array<String>]
    def get_property_value_as_array_string(id) end
    alias_method :property_value_as_array_string, :get_property_value_as_array_string
    
    # Returns property's value as bool.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def get_property_value_as_bool(id) end
    alias_method :property_value_as_bool, :get_property_value_as_bool
    
    # Return's property's value as {Wx::DateTime}.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Time,Date,DateTime]
    # @wxrb_require USE_DATETIME
    def get_property_value_as_date_time(id) end
    alias_method :property_value_as_date_time, :get_property_value_as_date_time
    
    # Returns property's value as double-precision floating point number.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Float]
    def get_property_value_as_double(id) end
    alias_method :property_value_as_double, :get_property_value_as_double
    
    # Returns property's value as integer.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Integer]
    def get_property_value_as_int(id) end
    alias_method :property_value_as_int, :get_property_value_as_int
    
    # Returns property's value as integer.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Integer]
    def get_property_value_as_long(id) end
    alias_method :property_value_as_long, :get_property_value_as_long
    
    # Returns property's value as native signed 64-bit integer.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Integer]
    # @wxrb_require USE_LONGLONG
    def get_property_value_as_long_long(id) end
    alias_method :property_value_as_long_long, :get_property_value_as_long_long
    
    # Returns property's value as {Wx::String}.
    # 
    # If property does not use string value type, then its value is converted using {Wx::PG::PGProperty#get_value_as_string}.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [String]
    def get_property_value_as_string(id) end
    alias_method :property_value_as_string, :get_property_value_as_string
    
    # Returns property's value as unsigned integer.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Integer]
    def get_property_value_as_u_long(id) end
    alias_method :property_value_as_u_long, :get_property_value_as_u_long
    
    # Returns property's value as native unsigned 64-bit integer.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Integer]
    # @wxrb_require USE_LONGLONG
    def get_property_value_as_u_long_long(id) end
    alias_method :property_value_as_u_long_long, :get_property_value_as_u_long_long
    
    # Returns a {Wx::Variant} list containing {Wx::Variant} versions of all property values.
    # 
    # Order is not guaranteed.
    # @param listname [String]  Name of the returned {Wx::Variant} list.
    # @param baseparent [Wx::PG::PGProperty]  The base property which children properties will be queried for values.
    # @param flags [Integer]  Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_KEEP_STRUCTURE} to retain category structure; each sub category will be its own {Wx::VariantList} of {Wx::Variant}. Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_INC_ATTRIBUTES} to include property attributes as well. Each attribute will be stored as list variant named "@<propname>@attr."
    # @return [Wx::Variant]
    def get_property_values(listname=(''), baseparent=nil, flags=0) end
    alias_method :property_values, :get_property_values
    
    # Returns list of currently selected properties.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>{Wx::ArrayPGProperty} should be compatible with std::vector API. 
    # </p>
    # </div>
    # @return [Array<Wx::PG::PGProperty>]
    def get_selected_properties; end
    alias_method :selected_properties, :get_selected_properties
    
    # Returns currently selected property.
    # 
    # NULL if none.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>When {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION} extra style is used, this member function returns the focused property, that is the one which can have active editor. 
    # </p>
    # </div>
    # @return [Wx::PG::PGProperty]
    def get_selection; end
    alias_method :selection, :get_selection
    
    # Hides or reveals a property.
    # @param id [String,Wx::PG::PGProperty]  Name or pointer to a property.
    # @param hide [Boolean]  If true, hides property, otherwise reveals it.
    # @param flags [Integer]  By default changes are applied recursively. Set this parameter {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} to prevent this.
    # @return [Boolean]
    def hide_property(id, hide=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
    
    # @overload insert(priorThis, newProperty)
    #   Inserts property to the property container.
    #   
    #   Returns newProperty.
    #   
    #   <div class="wxrb-remark">
    #   <b>Remark:</b>
    #   <p>
    #   </p>
    #   </div>
    #   
    #   - {Wx::PG::PropertyGrid} takes the ownership of the property pointer.
    #   - While Append may be faster way to add items, make note that when both types of data storage (categoric and non-categoric) are active, Insert becomes even more slow. This is especially true if current mode is non-categoric.
    #   - This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value.
    #   
    #   Example of use:
    #   
    #   ```ruby
    #     # append category
    #     my_cat_id = propertygrid.append(Wx::PG::PropertyCategory.new("My Category"))
    #     
    #     ...
    #     
    #     # insert into category - using second overload
    #     my_item_id_1 = propertygrid.insert(my_cat_id, 0, Wx::PG::StringProperty.new("My String 1"))
    #     
    #     # insert before to first item - using first overload
    #     my_item_id_2 = propertygrid.insert(my_item_id, Wx::PG::StringProperty.new("My String 2"))
    #   ```
    #   @param priorThis [String,Wx::PG::PGProperty]  New property is inserted just prior to this. Available only in the first variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
    #   @param newProperty [Wx::PG::PGProperty]  Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
    #   @return [Wx::PG::PGProperty]
    # @overload insert(parent, index, newProperty)
    #   Inserts property to the property container.
    #   
    #   See the other overload for more details.
    #   
    #   Returns newProperty.
    #   @param parent [String,Wx::PG::PGProperty]  New property is inserted under this category. Available only in the second variant. There are two versions of this function to allow this parameter to be either an id or name to a property.
    #   @param index [Integer]  Index under category. Available only in the second variant. If index is < 0, property is appended in category.
    #   @param newProperty [Wx::PG::PGProperty]  Pointer to the inserted property. {Wx::PG::PropertyGrid} will take ownership of this object.
    #   @return [Wx::PG::PGProperty]
    def insert(*args) end
    
    # Returns true if property is a category.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_category(id) end
    alias_method :property_category?, :is_property_category
    
    # Returns true if property is enabled.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_enabled(id) end
    alias_method :property_enabled?, :is_property_enabled
    
    # Returns true if given property is expanded.
    # 
    # Naturally, always returns false for properties that cannot be expanded.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_expanded(id) end
    alias_method :property_expanded?, :is_property_expanded
    
    # Returns true if property has been modified after value set or modify flag clear by software.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_modified(id) end
    alias_method :property_modified?, :is_property_modified
    
    # Returns true if property is selected.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_selected(id) end
    alias_method :property_selected?, :is_property_selected
    
    # Returns true if property is shown (i.e.
    # 
    # {Wx::PG::PropertyGridInterface#hide_property} with true not called for it).
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_shown(id) end
    alias_method :property_shown?, :is_property_shown
    
    # Returns true if property value is set to unspecified.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [Boolean]
    def is_property_value_unspecified(id) end
    alias_method :property_value_unspecified?, :is_property_value_unspecified
    
    # Disables (limit = true) or enables (limit = false) {Wx::TextCtrl} editor of a property, if it is not the sole mean to edit the value.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Property is refreshed with new settings. 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param limit [Boolean] 
    # @return [void]
    def limit_property_editing(id, limit=true) end
    
    # If state is shown in its grid, refresh it now.
    # @param state [Wx::PG::PropertyGridPage,Wx::PG::PropertyGridPageState] 
    # @return [void]
    def refresh_grid(state=nil) end
    
    # Replaces property with id with newly created one.
    # 
    # For example, this code replaces existing property named "Flags" with one that will have different set of items:
    # 
    # ```ruby
    #   pg.replace_property("Flags", Wx::PG::FlagsProperty.new("Flags", Wx::PG::PG_LABEL, newItems))
    # ```
    # @see Wx::PG::PropertyGridInterface#insert 
    # @param id [String,Wx::PG::PGProperty] 
    # @param property [Wx::PG::PGProperty] 
    # @return [Wx::PG::PGProperty]
    def replace_property(id, property) end
    
    # Restores user-editable state.
    # 
    # See also {Wx::PG::PropertyGridInterface#save_editable_state}.
    # 
    # Returns false if there was problem reading the string.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>If some parts of state (such as scrolled or splitter position) fail to restore correctly, please make sure that you call this function after {Wx::PG::PropertyGrid} size has been set (this may sometimes be tricky when sizers are used). 
    # </p>
    # </div>
    # @param src [String]  String generated by SaveEditableState.
    # @param restoreStates [Integer]  Which parts to restore from source string. See list of editable state flags.
    # @return [Boolean]
    def restore_editable_state(src, restoreStates=Wx::PG::PropertyGridPage::EditableStateFlags::AllStates) end
    
    # Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).
    # @param includedStates [Integer]  Which parts of state to include. See list of editable state flags.
    # @return [String]
    def save_editable_state(includedStates=Wx::PG::PropertyGridPage::EditableStateFlags::AllStates) end
    
    # Set proportion of an auto-stretchable column.
    # 
    # {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style needs to be used to indicate that columns are auto- resizable.
    # Returns false on failure.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>You should call this for individual pages of {Wx::PG::PropertyGridManager} (if used).
    # </p>
    # </div>
    # @see Wx::PG::PropertyGridInterface#get_column_proportion 
    # @param column [Integer] 
    # @param proportion [Integer] 
    # @return [Boolean]
    def set_column_proportion(column, proportion) end
    
    # Sets an attribute for this property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - Setting attribute's value to {Wx::NullVariant} will simply remove it from property's set of attributes.
    # - Property is refreshed with new settings. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty]  Name or pointer to a property.
    # @param attrName [String]  Text identifier of attribute. See wxPropertyGrid Property Attribute Identifiers.
    # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]  Value of attribute.
    # @param argFlags [Integer]  Optional. Use {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} to set the attribute to child properties recursively.
    # @return [void]
    def set_property_attribute(id, attrName, value, argFlags=0) end
    
    # Sets property attribute for all applicable properties.
    # 
    # Be sure to use this method only after all properties have been added to the grid.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Properties are refreshed with new settings. 
    # </p>
    # </div>
    # @param attrName [String] 
    # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
    # @return [void]
    def set_property_attribute_all(attrName, value) end
    
    # Sets background colour of given property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - If category is tried to set recursively, only its children are affected.
    # - Property is redrawn with new colour. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty]  Property name or pointer.
    # @param colour [Wx::Colour,String,Symbol]  New background colour.
    # @param flags [Integer]  Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} which causes colour to be set recursively. Omit this flag to only set colour for the property in question and not any of its children.
    # @return [void]
    def set_property_background_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
    
    # Sets text, bitmap, and colours for given column's cell.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - You can set label cell by using column 0.
    # - You can use {Wx::PG::PG_LABEL} as text to use default text for column. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param column [Integer] 
    # @param text [String] 
    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
    # @param fgCol [Wx::Colour,String,Symbol] 
    # @param bgCol [Wx::Colour,String,Symbol] 
    # @return [void]
    def set_property_cell(id, column, text=(''), bitmap=(Wx::BitmapBundle.new()), fgCol=Wx::NULL_COLOUR, bgCol=Wx::NULL_COLOUR) end
    
    # Sets client data (void*) of a property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This untyped client data has to be deleted manually. 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param clientData [Object] 
    # @return [void]
    def set_property_client_data(id, clientData) end
    
    # Resets text and background colours of given property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - If category is tried to set recursively, only its children are affected.
    # - Property is redrawn with new colours. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty]  Property name or pointer.
    # @param flags [Integer]  Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} which causes colour to be reset only for the property in question (for backward compatibility).
    # @return [void]
    def set_property_colours_to_default(id, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE) end
    alias_method :property_colours_to_default=, :set_property_colours_to_default
    
    # @overload set_property_editor(id, editor)
    #   Sets editor for a property.
    #   
    #   For custom editors, use pointer you received from {Wx::PG::PropertyGrid.register_editor_class}.
    #   @param id [String,Wx::PG::PGProperty]  Property name or pointer to a property.
    #   @param editor [Wx::PG::PGEditor]  For builtin editors, use {Wx::PGEditor_X}, where X is builtin editor's name (TextCtrl, Choice, etc. see {Wx::PG::PGEditor} documentation for full list).
    #   @return [void]
    # @overload set_property_editor(id, editorName)
    #   Sets editor control of a property.
    #   
    #   As editor argument, use editor name string, such as "TextCtrl" or "Choice".
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param editorName [String] 
    #   @return [void]
    def set_property_editor(*args) end
    
    # Sets label of a property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - Properties under same parent may have same labels. However, property names must still remain unique. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param newproplabel [String] 
    # @return [void]
    def set_property_label(id, newproplabel) end
    
    # Sets name of a property.
    # @param id [String,Wx::PG::PGProperty]  Name or pointer of property which name to change.
    # @param newName [String]  New name for property.
    # @return [void]
    def set_property_name(id, newName) end
    
    # Sets property (and, recursively, its children) to have read-only value.
    # 
    # In other words, user cannot change the value in the editor, but they can still copy it.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - This is mainly for use with textctrl editor. Only some other editors fully support it.
    # - Property is refreshed with new settings. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty]  Property name or pointer.
    # @param set [Boolean]  Use true to enable read-only, false to disable it.
    # @param flags [Integer]  By default changes are applied recursively. Set this parameter to {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE} to prevent this.
    # @return [void]
    def set_property_read_only(id, set=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
    alias_method :property_read_only=, :set_property_read_only
    
    # Sets property's value to unspecified.
    # 
    # If it has children (it may be category), then the same thing is done to them.
    # @param id [String,Wx::PG::PGProperty] 
    # @return [void]
    def set_property_value_unspecified(id) end
    alias_method :property_value_unspecified=, :set_property_value_unspecified
    
    # @overload set_property_values(list, defaultCategory=Wx::PG::NullProperty)
    #   Sets property values from a list of {Wx::Variants}.
    #   @param list [Wx::VariantList] 
    #   @param defaultCategory [String,Wx::PG::PGProperty] 
    #   @return [void]
    # @overload set_property_values(list, defaultCategory=Wx::PG::NullProperty)
    #   Sets property values from a list of {Wx::Variants}.
    #   @param list [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
    #   @param defaultCategory [String,Wx::PG::PGProperty] 
    #   @return [void]
    def set_property_values(*args) end
    alias_method :property_values=, :set_property_values
    
    # Associates the help string with property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>By default, text is shown either in the manager's "description" text box or in the status bar. If extra window style {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_HELP_AS_TOOLTIPS} is used, then the text will appear as a tooltip. 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param helpString [String] 
    # @return [void]
    def set_property_help_string(id, helpString) end
    
    # Set {Wx::Bitmap} taken from {Wx::BitmapBundle} in front of the value.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>Bitmap will be scaled to a size returned by {Wx::PG::PropertyGrid#get_image_size}; 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param bmp [Wx::BitmapBundle] 
    # @return [void]
    def set_property_image(id, bmp) end
    
    # Sets maximum length of text in property text editor.
    # 
    # Returns true if maximum length was set.
    # @see Wx::PG::PGProperty#set_max_length. 
    # @param id [String,Wx::PG::PGProperty]  Property name or pointer.
    # @param maxLen [Integer]  Maximum number of characters of the text the user can enter in the text editor. If it is 0, the length is not limited and the text can be as long as it is supported by the underlying native text control widget.
    # @return [Boolean]
    def set_property_max_length(id, maxLen) end
    
    # Sets text colour of given property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>
    # 
    # - If category is tried to set recursively, only its children are affected.
    # - Property is redrawn with new colour. 
    # 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty]  Property name or pointer.
    # @param colour [Wx::Colour,String,Symbol]  New text colour.
    # @param flags [Integer]  Default is {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE} which causes colour to be set recursively. Omit this flag to only set colour for the property in question and not any of its children.
    # @return [void]
    def set_property_text_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end
    
    # Sets validator of a property.
    # @param id [String,Wx::PG::PGProperty] 
    # @param validator [Wx::Validator] 
    # @return [void]
    def set_property_validator(id, validator) end
    
    # @overload set_property_value(id, value)
    #   Sets value (long integer) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Integer] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (integer) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Integer] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (floating point) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Float] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (bool) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Boolean] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (wchar_t*) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [String] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (char*) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [String] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (string) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [String] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::ArrayString}) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Array<String>] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::DateTime}) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Time,Date,DateTime] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::Object}*) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Wx::Object] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::Object}&) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Wx::Object] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (native 64-bit int) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Integer] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::LongLong}) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Wx::LongLong] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value (native 64-bit unsigned int) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Integer] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::ULongLong}) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Wx::ULongLong] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::ArrayInt}&) of a property.
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [Array<Integer>] 
    #   @return [void]
    # @overload set_property_value(id, value)
    #   Sets value ({Wx::Variant}) of a property.
    #   
    #   <div class="wxrb-remark">
    #   <b>Remark:</b>
    #   <p>Use {Wx::PG::PropertyGridInterface#change_property_value} instead if you need to run through validation process and send property change event. 
    #   </p>
    #   </div>
    #   @param id [String,Wx::PG::PGProperty] 
    #   @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
    #   @return [void]
    def set_property_value(*args) end
    
    # Sets value ({Wx::String}) of a property.
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This method uses {Wx::PG::PGProperty#set_value_from_string}, which all properties should implement. This means that there should not be a type error, and instead the string is converted to property's actual value type. 
    # </p>
    # </div>
    # @param id [String,Wx::PG::PGProperty] 
    # @param value [String] 
    # @return [void]
    def set_property_value_string(id, value) end
    
    # Sets value ({Wx::Variant}&) of a property.
    # 
    # Same as SetPropertyValue, but accepts reference.
    # @param id [String,Wx::PG::PGProperty] 
    # @param value [Wx::Variant] 
    # @return [void]
    def set_prop_val(id, value) end
    
    # Adjusts how {Wx::PG::PropertyGrid} behaves when invalid value is entered in a property.
    # @param vfbFlags [Integer]  See wxPropertyGrid Validation Failure behaviour Flags for possible values.
    # @return [void]
    def set_validation_failure_behavior(vfbFlags) end
    alias_method :validation_failure_behavior=, :set_validation_failure_behavior
    
    # Sorts all properties recursively.
    # 
    # 
    # @see Wx::PG::PropertyGridInterface#sort_children
    # @see  Wx::PG::PropertyGrid#set_sort_function 
    # @param flags [Integer]  This can contain any of the following options: {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_SORT_TOP_LEVEL_ONLY}: Only sort categories and their immediate children. Sorting done by {Wx::PG::PG_WINDOW_STYLES::PG_AUTO_SORT} option uses this.
    # @return [void]
    def sort(flags=0) end
    
    # Sorts children of a property.
    # 
    # 
    # @see Wx::PG::PropertyGridInterface#sort
    # @see  Wx::PG::PropertyGrid#set_sort_function 
    # @param id [String,Wx::PG::PGProperty]  Name or pointer to a property.
    # @param flags [Integer]  This can contain any of the following options: {Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE}: Sorts recursively.
    # @return [void]
    def sort_children(id, flags=0) end
    
    # {Wx::PG::PropertyGridInterface#get_property_by_name} with assertion error message.
    # @param name [String] 
    # @return [Wx::PG::PGProperty]
    def get_property_by_name_a(name) end
    alias_method :property_by_name_a, :get_property_by_name_a
    
    # 
    # 
    # <div class="wxrb-remark">
    # <b>Remark:</b>
    # <p>This function reselects the property and may cause excess flicker, so to just call Refresh() on a rect of single property, call DrawItem() instead. 
    # </p>
    # </div>
    # @param p [Wx::PG::PGProperty] 
    # @return [void]
    def refresh_property(p) end
    
    # Initializes all property types.
    # 
    # Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.
    # @return [void]
    def self.init_all_type_handlers; end
    
    # Initializes additional property editors (SpinCtrl etc.).
    # 
    # Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library.
    # @return [void]
    def self.register_additional_editors; end
    
    # Sets strings listed in the choice dropdown of a {Wx::PG::BoolProperty}.
    # 
    # Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications.
    # @param trueChoice [String] 
    # @param falseChoice [String] 
    # @return [void]
    def self.set_bool_choices(trueChoice, falseChoice) end
    
    # Returns editor pointer of editor with given name.
    # @param editorName [String] 
    # @return [Wx::PG::PGEditor]
    def self.get_editor_by_name(editorName) end
    
  end # PropertyGridInterface
  

end