Module: Wx::PG::PropertyGridInterface

Included in:
PropertyGrid, PropertyGridManager, PropertyGridPage
Defined in:
lib/wx/doc/gen/pg/property_grid_interface.rb

Overview

Note:

In wxRuby this is a mixin module instead of a (base) class.

Most of the shared property manipulation interface shared by PropertyGrid, PropertyGridPage, and PropertyGridManager is defined in this class.

Remark:

- In separate PropertyGrid component this class was known as Wx::PropertyContainerMethods. - 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).

Category: PropertyGrid

Requires:

  • USE_PROPGRID

Defined Under Namespace

Classes: EditableStateFlags

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.get_editor_by_name(editorName) ⇒ Wx::PG::PGEditor

Returns editor pointer of editor with given name.

Parameters:

  • editorName (String)

Returns:



1093
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1093

def self.get_editor_by_name(editorName) end

.init_all_type_handlers ⇒ void

This method returns an undefined value.

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.



1074
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1074

def self.init_all_type_handlers; end

.register_additional_editors ⇒ void

This method returns an undefined value.

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.



1080
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1080

def self.register_additional_editors; end

.set_bool_choices(trueChoice, falseChoice) ⇒ void

This method returns an undefined value.

Sets strings listed in the choice dropdown of a BoolProperty.

Defaults are “True” and “False”, so changing them to, say, “Yes” and “No” may be useful in some less technical applications.

Parameters:

  • trueChoice (String)
  • falseChoice (String) 


1088
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1088

def self.set_bool_choices(trueChoice, falseChoice) end

Instance Method Details

#append(property) ⇒ Wx::PG::PGProperty

Appends property to the list.

Wx::PG::PropertyGrid assumes ownership of the object. Becomes child of most recently added category.

Remark:

- 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.

Parameters:

Returns:



84
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 84

def append(property) end

#append_in(id, newProperty) ⇒ Wx::PG::PGProperty

Same as #append, but appends under given parent property.

Parameters:

Returns:



90
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 90

def append_in(id, newProperty) end

#begin_add_children(id) ⇒ void

This method returns an undefined value.

In order to add new items into a property with private children (for instance, FlagsProperty), you need to call this method.

After populating has been finished, you need to call #end_add_children.

Parameters:

See Also:



98
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 98

def begin_add_children(id) end

#change_property_value(id, newValue) ⇒ Boolean

Changes value of a property, as if by user.

Use this instead of #set_property_value if you need the value to run through validation process, and also send EVT_PG_CHANGED.

Remark:

Since this function sends EVT_PG_CHANGED, it should not be called from EVT_PG_CHANGED handler.

Returns true if value was successfully changed.

Parameters:

Returns:

  • (Boolean) 


167
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 167

def change_property_value(id, newValue) end

#clear ⇒ void

This method returns an undefined value.

Deletes all properties.

Remark:

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. 



108
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 108

def clear; end

#clear_modified_status ⇒ void

This method returns an undefined value.

Resets modified status of all properties.



126
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 126

def clear_modified_status; end

#clear_selection(validation = false) ⇒ Boolean

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.

Remark:

In wxWidgets 2.9 and later, this function no longer sends Wx::PG_EVT_SELECTED.

Parameters:

  • validation (Boolean) (defaults to: false) —

    If set to false, deselecting the property will always work, even if its editor had invalid value in it.

Returns:

  • (Boolean)

See Also:



122
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 122

def clear_selection(validation=false) end

#collapse(id) ⇒ Boolean

Collapses given category or property with children.

Returns true if actually collapsed.

Remark:

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.

Parameters:

Returns:

  • (Boolean) 


139
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 139

def collapse(id) end

#collapse_all ⇒ Boolean

Collapses all items that can be collapsed.

Return false if failed (may fail if editor value cannot be validated).

Remark:

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.

Returns:

  • (Boolean) 


151
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 151

def collapse_all; end

#delete_property(id) ⇒ void

This method returns an undefined value.

Removes and deletes a property and any children.

Remark:

If you delete a property in a Wx::PG::PropertyGrid event handler, the actual deletion is postponed until the next idle event.

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.

Parameters:



180
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 180

def delete_property(id) end

#disable_property(id) ⇒ Boolean

Disables a property.

Remark:

Property is refreshed with new settings.

Parameters:

Returns:

  • (Boolean)

See Also:



193
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 193

def disable_property(id) end

#each_property(flags, start, reverse: ) {|item| ... } ⇒ ::Object #each_property(flags, start, reverse: ) ⇒ Enumerator Also known as: properties

When a block is given iterates properties as specified passing each property to the block. Returns an enumerator when no block is given. The start position defaults to Wx::TOP for forward iteration and Wx::BOTTOM for reverse iteration.

Overloads:

  • #each_property(flags, start, reverse: ) {|item| ... } ⇒ ::Object

    Returns result of last block execution.

    Parameters:

    Yield Parameters:

    Returns:

    • (::Object) —

      result of last block execution

  • #each_property(flags, start, reverse: ) ⇒ Enumerator

    Returns an enumerator.

    Parameters:

    Returns:

    • (Enumerator) —

      an enumerator



27
 
# File 'lib/wx/doc/pg/property_grid_interface.rb', line 27

def each_property(flags = Wx::PG::PG_ITERATE_DEFAULT, start = nil, reverse: false, &block) end

#each_property_attribute(id) {|item| ... } ⇒ ::Object #each_property_attribute(id) ⇒ Enumerator Also known as: property_attributes

When a block is given iterates all attributes of the specified property passing each attribute variant to the block. Returns an enumerator when no block is given.

Overloads:

  • #each_property_attribute(id) {|item| ... } ⇒ ::Object

    Returns result of last block execution.

    Parameters:

    Yield Parameters:

    Returns:

    • (::Object) —

      result of last block execution

  • #each_property_attribute(id) ⇒ Enumerator

    Returns an enumerator.

    Parameters:

    Returns:

    • (Enumerator) —

      an enumerator



57
 
# File 'lib/wx/doc/pg/property_grid_interface.rb', line 57

def each_property_attribute; end

#editor_validate ⇒ Boolean

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 Validator.

Returns:

  • (Boolean) 


199
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 199

def editor_validate; end

#enable_property(id, enable = true) ⇒ Boolean

Enables or disables property.

Disabled property usually appears as having grey text.

Remark:

Property is refreshed with new settings.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Name or pointer to a property.

  • enable (Boolean) (defaults to: true) —

    If false, property is disabled instead.

Returns:

  • (Boolean)

See Also:



214
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 214

def enable_property(id, enable=true) end

#end_add_children(id) ⇒ void

This method returns an undefined value.

Called after population of property with fixed children has finished.

Parameters:

See Also:



222
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 222

def end_add_children(id) end

#expand(id) ⇒ Boolean

Expands given category or property with children.

Returns true if actually expanded.

Remark:

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.

Parameters:

Returns:

  • (Boolean) 


235
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 235

def expand(id) end

#expand_all(expand = true) ⇒ Boolean

Expands all items that can be expanded.

Remark:

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.

Parameters:

  • expand (Boolean) (defaults to: true)

Returns:

  • (Boolean) 


246
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 246

def expand_all(expand=true) end

#get_column_proportion(column) ⇒ Integer Also known as: column_proportion

Returns auto-resize proportion of the given column.

Parameters:

  • column (Integer)

Returns:

  • (Integer)

See Also:



254
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 254

def get_column_proportion(column) end

#get_first(flags = Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_ALL) ⇒ Wx::PG::PGProperty Also known as: first

Parameters:

  • flags (Integer) (defaults to: Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_ALL)

Returns:



271
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 271

def get_first(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_ALL) end

#get_first_child(id) ⇒ Wx::PG::PGProperty Also known as: first_child

Returns id of first child of given property.

Remark:

Does not return private children!

Parameters:

Returns:



266
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 266

def get_first_child(id) end

#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))) ⇒ Array<Wx::PG::PGProperty> Also known as: properties_with_flag

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.

Parameters:

  • flags (Integer) —

    Property flags to use.

  • inverse (Boolean) (defaults to: false) —

    If false, properties that have given flags are stored, otherwise there are stored only properties without given flags.

  • iterFlags (Integer) (defaults to: ((Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_PROPERTIES|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_HIDDEN|Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_CATEGORIES))) —

    Iterator flags to use. Default is everything expect private children. See wxPropertyGridIterator Flags.

Returns:



295
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 295

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

#get_property(name) ⇒ Wx::PG::PGProperty Also known as: property

Returns pointer to a property with given name (case-sensitive).

If there is no property with such name, NULL pointer is returned.

Remark:

Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "." instead of "".

Parameters:

  • name (String)

Returns:



285
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 285

def get_property(name) end

#get_property_attribute(id, attrName) ⇒ Wx::Variant Also known as: property_attribute

Returns value of given attribute.

If none found, returns NullVariant.

Parameters:

Returns:



304
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 304

def get_property_attribute(id, attrName) end

#get_property_background_colour(id) ⇒ Wx::Colour Also known as: property_background_colour

Returns background colour of first cell of a property.

Parameters:

Returns:



310
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 310

def get_property_background_colour(id) end

#get_property_by_label(label) ⇒ Wx::PG::PGProperty Also known as: property_by_label

Returns first property which label matches given string.

NULL if none found. Note that this operation is very slow when compared to #get_property_by_name.

Parameters:

  • label (String)

Returns:



332
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 332

def get_property_by_label(label) end

#get_property_by_name(name) ⇒ Wx::PG::PGProperty #get_property_by_name(name, subname) ⇒ Wx::PG::PGProperty Also known as: property_by_name

Overloads:

  • #get_property_by_name(name) ⇒ Wx::PG::PGProperty

    Returns pointer to a property with given name (case-sensitive).

    If there is no property with such name, NULL pointer is returned.

    Remark:

    Properties which have non-category, non-root parent cannot be accessed globally by their name. Instead, use "." instead of "".

    Parameters:

    • name (String)

    Returns:

  • #get_property_by_name(name, subname) ⇒ Wx::PG::PGProperty

    Returns child property subname of property name.

    Same as calling GetPropertyByName(“name.subname”), albeit slightly faster.

    Parameters:

    • name (String)
    • subname (String)

    Returns:



354
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 354

def get_property_by_name(*args) end

#get_property_by_name_a(name) ⇒ Wx::PG::PGProperty Also known as: property_by_name_a

#get_property_by_name with assertion error message.

Parameters:

  • name (String)

Returns:



1056
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1056

def get_property_by_name_a(name) end

#get_property_category(id) ⇒ Wx::PG::PropertyCategory Also known as: property_category

Returns pointer of property’s nearest parent category.

If no category found, returns NULL.

Parameters:

Returns:



318
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 318

def get_property_category(id) end

#get_property_client_data(id) ⇒ Object Also known as: property_client_data

Returns client data (void*) of a property.

Parameters:

Returns:



324
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 324

def get_property_client_data(id) end

#get_property_editor(id) ⇒ Wx::PG::PGEditor Also known as: property_editor

Returns property’s editor.

Parameters:

Returns:



360
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 360

def get_property_editor(id) end

#get_property_help_string(id) ⇒ String Also known as: property_help_string

Returns help string associated with a property.

Parameters:

Returns:

  • (String) 


366
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 366

def get_property_help_string(id) end

#get_property_image(id) ⇒ Wx::Bitmap Also known as: property_image

Returns property’s custom value image (NULL of none).

Parameters:

Returns:



372
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 372

def get_property_image(id) end

#get_property_label(id) ⇒ Wx::String Also known as: property_label

Returns label of a property.

Parameters:

Returns:

  • (Wx::String) 


378
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 378

def get_property_label(id) end

#get_property_name(property) ⇒ String Also known as: property_name

Returns property’s name, by which it is globally accessible.

Parameters:

Returns:

  • (String) 


384
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 384

def get_property_name(property) end

#get_property_parent(id) ⇒ Wx::PG::PGProperty Also known as: property_parent

Returns parent item of a property.

Parameters:

Returns:



390
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 390

def get_property_parent(id) end

#get_property_text_colour(id) ⇒ Wx::Colour Also known as: property_text_colour

Returns text colour of first cell of a property.

Parameters:

Returns:



396
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 396

def get_property_text_colour(id) end

#get_property_validator(id) ⇒ Wx::Validator Also known as: property_validator

Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.

Parameters:

Returns:

Requires:

  • USE_VALIDATORS 


403
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 403

def get_property_validator(id) end

#get_property_value(id) ⇒ Wx::Variant Also known as: property_value

Returns property’s value as Variant.

If property value is unspecified, NullVariant is returned.

Parameters:

Returns:



411
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 411

def get_property_value(id) end

#get_property_value_as_array_int(id) ⇒ Array<Integer> Also known as: property_value_as_array_int

Return’s property’s value as ArrayInt.

Parameters:

Returns:

  • (Array<Integer>) 


417
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 417

def get_property_value_as_array_int(id) end

#get_property_value_as_array_string(id) ⇒ Array<String> Also known as: property_value_as_array_string

Returns property’s value as ArrayString.

Parameters:

Returns:

  • (Array<String>) 


423
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 423

def get_property_value_as_array_string(id) end

#get_property_value_as_bool(id) ⇒ Boolean Also known as: property_value_as_bool

Returns property’s value as bool.

Parameters:

Returns:

  • (Boolean) 


429
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 429

def get_property_value_as_bool(id) end

#get_property_value_as_date_time(id) ⇒ Time, ... Also known as: property_value_as_date_time

Return’s property’s value as DateTime.

Parameters:

Returns:

  • (Time, Date, DateTime)

Requires:

  • USE_DATETIME 


436
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 436

def get_property_value_as_date_time(id) end

#get_property_value_as_double(id) ⇒ Float Also known as: property_value_as_double

Returns property’s value as double-precision floating point number.

Parameters:

Returns:

  • (Float) 


442
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 442

def get_property_value_as_double(id) end

#get_property_value_as_int(id) ⇒ Integer Also known as: property_value_as_int

Returns property’s value as integer.

Parameters:

Returns:

  • (Integer) 


448
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 448

def get_property_value_as_int(id) end

#get_property_value_as_long(id) ⇒ Integer Also known as: property_value_as_long

Returns property’s value as integer.

Parameters:

Returns:

  • (Integer) 


454
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 454

def get_property_value_as_long(id) end

#get_property_value_as_long_long(id) ⇒ Integer Also known as: property_value_as_long_long

Returns property’s value as native signed 64-bit integer.

Parameters:

Returns:

  • (Integer)

Requires:

  • USE_LONGLONG 


461
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 461

def get_property_value_as_long_long(id) end

#get_property_value_as_string(id) ⇒ String Also known as: property_value_as_string

Returns property’s value as String.

If property does not use string value type, then its value is converted using Wx::PG::PGProperty#get_value_as_string.

Parameters:

Returns:

  • (String) 


469
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 469

def get_property_value_as_string(id) end

#get_property_value_as_u_long(id) ⇒ Integer Also known as: property_value_as_u_long

Returns property’s value as unsigned integer.

Parameters:

Returns:

  • (Integer) 


475
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 475

def get_property_value_as_u_long(id) end

#get_property_value_as_u_long_long(id) ⇒ Integer Also known as: property_value_as_u_long_long

Returns property’s value as native unsigned 64-bit integer.

Parameters:

Returns:

  • (Integer)

Requires:

  • USE_LONGLONG 


482
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 482

def get_property_value_as_u_long_long(id) end

#get_property_values(listname = (''), baseparent = nil, flags = 0) ⇒ Wx::Variant Also known as: property_values

Returns a Variant list containing Variant versions of all property values.

Order is not guaranteed.

Parameters:

Returns:



492
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 492

def get_property_values(listname=(''), baseparent=nil, flags=0) end

#get_selected_properties ⇒ Array<Wx::PG::PGProperty> Also known as: selected_properties

Returns list of currently selected properties.

Remark:

ArrayPGProperty should be compatible with std::vector API.

Returns:



503
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 503

def get_selected_properties; end

#get_selection ⇒ Wx::PG::PGProperty Also known as: selection

Returns currently selected property.

NULL if none.

Remark:

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.

Returns:



516
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 516

def get_selection; end

#get_state ⇒ Wx::PG::PropertyGridPage, Wx::PG::PropertyGridPageState Also known as: state

Returns the current grid state. Depending on the actual grid object (Wx::PropertyGrid or Wx::PropertyGridManager) this will return either a Wx::PG::PropertyGridPageState instance or a Wx::PG::PropertyGridPage instance (current page of Wx::PropertyGridManager). Both provide the same interface (Ruby duck typing applies here).

Returns:



66
 
# File 'lib/wx/doc/pg/property_grid_interface.rb', line 66

def get_state; end

#hide_property(id, hide = true, flags = Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) ⇒ Boolean

Hides or reveals a property.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Name or pointer to a property.

  • hide (Boolean) (defaults to: true) —

    If true, hides property, otherwise reveals it.

  • flags (Integer) (defaults to: Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) —

    By default changes are applied recursively. Set this parameter Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE to prevent this.

Returns:

  • (Boolean) 


524
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 524

def hide_property(id, hide=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end

#insert(priorThis, newProperty) ⇒ Wx::PG::PGProperty #insert(parent, index, newProperty) ⇒ Wx::PG::PGProperty

Overloads:

  • #insert(priorThis, newProperty) ⇒ Wx::PG::PGProperty

    Inserts property to the property container.

    Returns newProperty.

    Remark:

    • 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:

    # 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"))

    Parameters:

    • 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.

    • newProperty (Wx::PG::PGProperty) —

      Pointer to the inserted property. Wx::PG::PropertyGrid will take ownership of this object.

    Returns:

  • #insert(parent, index, newProperty) ⇒ Wx::PG::PGProperty

    Inserts property to the property container.

    See the other overload for more details.

    Returns newProperty.

    Parameters:

    • 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.

    • index (Integer) —

      Index under category. Available only in the second variant. If index is < 0, property is appended in category.

    • newProperty (Wx::PG::PGProperty) —

      Pointer to the inserted property. Wx::PG::PropertyGrid will take ownership of this object.

    Returns:



568
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 568

def insert(*args) end

#is_property_category(id) ⇒ Boolean Also known as: property_category?

Returns true if property is a category.

Parameters:

Returns:

  • (Boolean) 


573
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 573

def is_property_category(id) end

#is_property_enabled(id) ⇒ Boolean Also known as: property_enabled?

Returns true if property is enabled.

Parameters:

Returns:

  • (Boolean) 


579
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 579

def is_property_enabled(id) end

#is_property_expanded(id) ⇒ Boolean Also known as: property_expanded?

Returns true if given property is expanded.

Naturally, always returns false for properties that cannot be expanded.

Parameters:

Returns:

  • (Boolean) 


587
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 587

def is_property_expanded(id) end

#is_property_modified(id) ⇒ Boolean Also known as: property_modified?

Returns true if property has been modified after value set or modify flag clear by software.

Parameters:

Returns:

  • (Boolean) 


593
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 593

def is_property_modified(id) end

#is_property_selected(id) ⇒ Boolean Also known as: property_selected?

Returns true if property is selected.

Parameters:

Returns:

  • (Boolean) 


599
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 599

def is_property_selected(id) end

#is_property_shown(id) ⇒ Boolean Also known as: property_shown?

Returns true if property is shown (i.e.

#hide_property with true not called for it).

Parameters:

Returns:

  • (Boolean) 


607
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 607

def is_property_shown(id) end

#is_property_value_unspecified(id) ⇒ Boolean Also known as: property_value_unspecified?

Returns true if property value is set to unspecified.

Parameters:

Returns:

  • (Boolean) 


613
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 613

def is_property_value_unspecified(id) end

#limit_property_editing(id, limit = true) ⇒ void

This method returns an undefined value.

Disables (limit = true) or enables (limit = false) TextCtrl editor of a property, if it is not the sole mean to edit the value.

Remark:

Property is refreshed with new settings.

Parameters:



626
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 626

def limit_property_editing(id, limit=true) end

#refresh_grid(state = nil) ⇒ void

This method returns an undefined value.

If state is shown in its grid, refresh it now.

Parameters:



631
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 631

def refresh_grid(state=nil) end

#refresh_property(p) ⇒ void

This method returns an undefined value.

Remark:

This function reselects the property and may cause excess flicker, so to just call Refresh() on a rect of single property, call DrawItem() instead.

Parameters:



1068
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1068

def refresh_property(p) end

#replace_property(id, property) ⇒ Wx::PG::PGProperty

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:

pg.replace_property("Flags", Wx::PG::FlagsProperty.new("Flags", Wx::PG::PG_LABEL, newItems))

Parameters:

Returns:

See Also:



644
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 644

def replace_property(id, property) end

#restore_editable_state(src, restoreStates = Wx::PG::PropertyGrid::EditableStateFlags::AllStates) ⇒ Boolean

Restores user-editable state.

See also #save_editable_state.

Returns false if there was problem reading the string.

Remark:

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).

Parameters:

  • src (String) —

    String generated by SaveEditableState.

  • restoreStates (Integer) (defaults to: Wx::PG::PropertyGrid::EditableStateFlags::AllStates) —

    Which parts to restore from source string. See list of editable state flags.

Returns:

  • (Boolean) 


660
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 660

def restore_editable_state(src, restoreStates=Wx::PG::PropertyGrid::EditableStateFlags::AllStates) end

#reverse_each_property(flags, start) {|item| ... } ⇒ ::Object #reverse_each_property(flags, start) ⇒ Enumerator Also known as: properties_reversed

Convenience method to perform reverse iteration. Calls #each_property with reverse: true. The start position defaults to Wx::BOTTOM.

Overloads:

  • #reverse_each_property(flags, start) {|item| ... } ⇒ ::Object

    Returns result of last block execution.

    Parameters:

    Yield Parameters:

    Returns:

    • (::Object) —

      result of last block execution

  • #reverse_each_property(flags, start) ⇒ Enumerator

    Returns an enumerator.

    Parameters:

    Returns:

    • (Enumerator) —

      an enumerator



44
 
# File 'lib/wx/doc/pg/property_grid_interface.rb', line 44

def reverse_each_property(flags = Wx::PG::PG_ITERATE_DEFAULT, start = nil, &block) end

#save_editable_state(includedStates = Wx::PG::PropertyGrid::EditableStateFlags::AllStates) ⇒ String

Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).

Parameters:

  • includedStates (Integer) (defaults to: Wx::PG::PropertyGrid::EditableStateFlags::AllStates) —

    Which parts of state to include. See list of editable state flags.

Returns:

  • (String) 


665
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 665

def save_editable_state(includedStates=Wx::PG::PropertyGrid::EditableStateFlags::AllStates) end

#set_column_proportion(column, proportion) ⇒ Boolean

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.

Remark:

You should call this for individual pages of Wx::PG::PropertyGridManager (if used).

Parameters:

  • column (Integer)
  • proportion (Integer)

Returns:

  • (Boolean)

See Also:



681
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 681

def set_column_proportion(column, proportion) end

#set_prop_val(id, value) ⇒ void

This method returns an undefined value.

Sets value (Variant&) of a property.

Same as SetPropertyValue, but accepts reference.

Parameters:



1026
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1026

def set_prop_val(id, value) end

#set_property_attribute(id, attrName, value, argFlags = 0) ⇒ void

This method returns an undefined value.

Sets an attribute for this property.

Remark:

- Setting attribute's value to NullVariant will simply remove it from property's set of attributes. - Property is refreshed with new settings.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Name or pointer to a property.

  • attrName (String) —

    Text identifier of attribute. See wxPropertyGrid Property Attribute Identifiers.

  • value (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue) —

    Value of attribute.

  • argFlags (Integer) (defaults to: 0) —

    Optional. Use Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE to set the attribute to child properties recursively.



699
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 699

def set_property_attribute(id, attrName, value, argFlags=0) end

#set_property_attribute_all(attrName, value) ⇒ void

This method returns an undefined value.

Sets property attribute for all applicable properties.

Be sure to use this method only after all properties have been added to the grid.

Remark:

Properties are refreshed with new settings.

Parameters:

  • attrName (String)
  • value (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue) 


713
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 713

def set_property_attribute_all(attrName, value) end

#set_property_background_colour(id, colour, flags = Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) ⇒ void

This method returns an undefined value.

Sets background colour of given property.

Remark:

- If category is tried to set recursively, only its children are affected. - Property is redrawn with new colour.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Property name or pointer.

  • colour (Wx::Colour, String, Symbol) —

    New background colour.

  • flags (Integer) (defaults to: Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) —

    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.



730
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 730

def set_property_background_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end

#set_property_cell(id, column, text = (''), bitmap = (Wx::BitmapBundle.new()), fgCol = Wx::NULL_COLOUR, bgCol = Wx::NULL_COLOUR) ⇒ void

This method returns an undefined value.

Sets text, bitmap, and colours for given column’s cell.

Remark:

- You can set label cell by using column 0. - You can use Wx::PG::PG_LABEL as text to use default text for column.

Parameters:



750
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 750

def set_property_cell(id, column, text=(''), bitmap=(Wx::BitmapBundle.new()), fgCol=Wx::NULL_COLOUR, bgCol=Wx::NULL_COLOUR) end

#set_property_client_data(id, clientData) ⇒ void

This method returns an undefined value.

Sets client data (void*) of a property.

Remark:

This untyped client data has to be deleted manually.

Parameters:



762
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 762

def set_property_client_data(id, clientData) end

#set_property_colours_to_default(id, flags = Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE) ⇒ void Also known as: property_colours_to_default=

This method returns an undefined value.

Resets text and background colours of given property.

Remark:

- If category is tried to set recursively, only its children are affected. - Property is redrawn with new colours.

Parameters:



778
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 778

def set_property_colours_to_default(id, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE) end

#set_property_editor(id, editor) ⇒ void #set_property_editor(id, editorName) ⇒ void

Overloads:

  • #set_property_editor(id, editor) ⇒ void

    This method returns an undefined value.

    Sets editor for a property.

    For custom editors, use pointer you received from Wx::PG::PropertyGrid.register_editor_class.

    Parameters:

    • id (String, Wx::PG::PGProperty) —

      Property name or pointer to a property.

    • 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).

  • #set_property_editor(id, editorName) ⇒ void

    This method returns an undefined value.

    Sets editor control of a property.

    As editor argument, use editor name string, such as “TextCtrl” or “Choice”.

    Parameters:



795
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 795

def set_property_editor(*args) end

#set_property_help_string(id, helpString) ⇒ void

This method returns an undefined value.

Associates the help string with property.

Remark:

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.

Parameters:



869
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 869

def set_property_help_string(id, helpString) end

#set_property_image(id, bmp) ⇒ void

This method returns an undefined value.

Set Bitmap taken from BitmapBundle in front of the value.

Remark:

Bitmap will be scaled to a size returned by Wx::PG::PropertyGrid#get_image_size;

Parameters:



881
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 881

def set_property_image(id, bmp) end

#set_property_label(id, newproplabel) ⇒ void

This method returns an undefined value.

Sets label of a property.

Remark:

- Properties under same parent may have same labels. However, property names must still remain unique.

Parameters:



810
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 810

def set_property_label(id, newproplabel) end

#set_property_max_length(id, maxLen) ⇒ Boolean

Sets maximum length of text in property text editor.

Returns true if maximum length was set.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Property name or pointer.

  • 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.

Returns:

  • (Boolean)

See Also:

  • Wx::PG::PGProperty#set_max_length.


890
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 890

def set_property_max_length(id, maxLen) end

#set_property_name(id, newName) ⇒ void

This method returns an undefined value.

Sets name of a property.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Name or pointer of property which name to change.

  • newName (String) —

    New name for property.



816
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 816

def set_property_name(id, newName) end

#set_property_read_only(id, set = true, flags = Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) ⇒ void Also known as: property_read_only=

This method returns an undefined value.

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.

Remark:

- This is mainly for use with textctrl editor. Only some other editors fully support it. - Property is refreshed with new settings.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Property name or pointer.

  • set (Boolean) (defaults to: true) —

    Use true to enable read-only, false to disable it.

  • flags (Integer) (defaults to: Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) —

    By default changes are applied recursively. Set this parameter to Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_DONT_RECURSE to prevent this.



835
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 835

def set_property_read_only(id, set=true, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end

#set_property_text_colour(id, colour, flags = Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) ⇒ void

This method returns an undefined value.

Sets text colour of given property.

Remark:

- If category is tried to set recursively, only its children are affected. - Property is redrawn with new colour.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Property name or pointer.

  • colour (Wx::Colour, String, Symbol) —

    New text colour.

  • flags (Integer) (defaults to: Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) —

    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.



907
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 907

def set_property_text_colour(id, colour, flags=Wx::PG::PG_GETPROPERTYVALUES_FLAGS::PG_RECURSE) end

#set_property_validator(id, validator) ⇒ void

This method returns an undefined value.

Sets validator of a property.

Parameters:



913
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 913

def set_property_validator(id, validator) end

#set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void #set_property_value(id, value) ⇒ void

Overloads:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (long integer) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (integer) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (floating point) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (bool) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (wchar_t*) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (char*) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (string) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (ArrayString) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (DateTime) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (Object*) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (Object&) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (native 64-bit int) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (LongLong) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (native 64-bit unsigned int) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (ULongLong) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (ArrayInt&) of a property.

    Parameters:

  • #set_property_value(id, value) ⇒ void

    This method returns an undefined value.

    Sets value (Variant) of a property.

    Remark:

    Use #change_property_value instead if you need to run through validation process and send property change event.

    Parameters:



1006
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1006

def set_property_value(*args) end

#set_property_value_string(id, value) ⇒ void

This method returns an undefined value.

Sets value (String) of a property.

Remark:

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.

Parameters:



1018
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1018

def set_property_value_string(id, value) end

#set_property_value_unspecified(id) ⇒ void Also known as: property_value_unspecified=

This method returns an undefined value.

Sets property’s value to unspecified.

If it has children (it may be category), then the same thing is done to them.

Parameters:



843
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 843

def set_property_value_unspecified(id) end

#set_property_values(list, defaultCategory = Wx::PG::NullProperty) ⇒ void #set_property_values(list, defaultCategory = Wx::PG::NullProperty) ⇒ void Also known as: property_values=

Overloads:

  • #set_property_values(list, defaultCategory = Wx::PG::NullProperty) ⇒ void

    This method returns an undefined value.

    Sets property values from a list of Variants.

    Parameters:

    • list (Wx::VariantList)
    • defaultCategory (String, Wx::PG::PGProperty) (defaults to: Wx::PG::NullProperty)
  • #set_property_values(list, defaultCategory = Wx::PG::NullProperty) ⇒ void

    This method returns an undefined value.

    Sets property values from a list of Variants.

    Parameters:



856
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 856

def set_property_values(*args) end

#set_validation_failure_behavior(vfbFlags) ⇒ void Also known as: validation_failure_behavior=

This method returns an undefined value.

Adjusts how Wx::PG::PropertyGrid behaves when invalid value is entered in a property.

Parameters:

  • vfbFlags (Integer) —

    See wxPropertyGrid Validation Failure behaviour Flags for possible values.



1031
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1031

def set_validation_failure_behavior(vfbFlags) end

#sort(flags = 0) ⇒ void

This method returns an undefined value.

Sorts all properties recursively.

Parameters:

See Also:

  • SortChildren
  • Wx::PG::PropertyGrid#set_sort_function


1041
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1041

def sort(flags=0) end

#sort_children(id, flags = 0) ⇒ void

This method returns an undefined value.

Sorts children of a property.

Parameters:

See Also:

  • Sort
  • Wx::PG::PropertyGrid#set_sort_function


1051
 
# File 'lib/wx/doc/gen/pg/property_grid_interface.rb', line 1051

def sort_children(id, flags=0) end