wx.propgrid.PGChoices¶Helper class for managing choices of wx.propgrid.PropertyGrid properties.
Each entry can have label, value, bitmap, text colour, and background colour.
wx.propgrid.PGChoices uses reference counting, similar to other wxWidgets classes. This means that assignment operator and copy constructor only copy the reference and not the actual data. Use Copy member function to create a real copy.
Note
If you do not specify value for entry, index is used.
Methods Summary¶Default constructor. |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. |
|
Adds a single item, sorted. |
|
Creates exclusive copy of current choices. |
|
Assigns choices data, using reference counting. |
|
Assigns data from another set of choices. |
|
Deletes all items. |
|
Returns a real copy of the choices. |
|
Changes ownership of data to you. |
|
Returns number of items. |
|
Returns data, increases refcount. |
|
Returns plain data ptr - no refcounting stuff is done. |
|
Gets an number identifying this list. |
|
Returns array of indices matching given strings. |
|
Returns label of item. |
|
Returns array of choice labels. |
|
Returns value of item. |
|
Returns array of values matching the given strings. |
|
Returns index of item with given label. |
|
Inserts a single item. |
|
Returns |
|
Returns item at given index. |
|
Removes count items starting at position nIndex. |
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. |
|
Returns a reference to a :class:PGChoiceEntry using Python list syntax. |
|
Class API¶
Inheritance diagram for class PGChoices:
wx.propgrid.PGChoices(object)¶Possible constructors:
PGChoices()
PGChoices(a)
PGChoices(labels, values=[])
PGChoices(data)
Helper class for managing choices of PropertyGrid properties.
__init__(self, *args, **kw)¶
Overloaded Implementations:
__init__ (self)
Default constructor.
__init__ (self, a)
Copy constructor, uses reference counting.
To create a real copy, use Copy member function instead.
a (wx.propgrid.PGChoices) –
__init__ (self, labels, values=[])
Constructor.
labels (list of strings) – Labels for choices.
values (list of integers) – Values for choices. If empty, indexes are used. Otherwise must have at least the same size as labels.
__init__ (self, data)
Simple interface constructor.
data (wx.propgrid.PGChoicesData) –
Add(self, *args, **kw)¶ Overloaded Implementations:
Add (self, arr, arrint)
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
arr (list of strings) –
arrint (list of integers) –
Add (self, label, value=PG_INVALID_VALUE)
Adds a single choice item.
label (string) – Label for added choice.
value (int) – Value for added choice. If unspecified, index is used.
Add (self, label, bitmap, value=PG_INVALID_VALUE)
Adds a single item, with bitmap.
label (string) –
bitmap (wx.Bitmap) –
value (int) –
Add (self, entry)
Adds a single item with full entry information.
entry (wx.propgrid.PGChoiceEntry) –
AddAsSorted(self, label, value=PG_INVALID_VALUE)¶Adds a single item, sorted.
label (string) –
value (int) –
AllocExclusive(self)¶Creates exclusive copy of current choices.
Assign(self, a)¶Assigns choices data, using reference counting.
To create a real copy, use Copy member function instead.
a (wx.propgrid.PGChoices) –
AssignData(self, data)¶Assigns data from another set of choices.
data (wx.propgrid.PGChoicesData) –
Clear(self)¶Deletes all items.
Copy(self)¶Returns a real copy of the choices.
EnsureData(self)¶ExtractData(self)¶Changes ownership of data to you.
GetCount(self)¶Returns number of items.
int
GetData(self)¶Returns data, increases refcount.
GetDataPtr(self)¶Returns plain data ptr - no refcounting stuff is done.
GetId(self)¶Gets an number identifying this list.
wx.IntPtr
GetIndicesForStrings(self, strings, unmatched=None)¶Returns array of indices matching given strings.
Unmatching strings are added to ‘unmatched’, if not None.
strings (list of strings) –
unmatched (list of strings) –
list of integers
GetLabel(self, ind)¶Returns label of item.
ind (int) –
string
GetLabels(self)¶Returns array of choice labels.
list of strings
GetValue(self, ind)¶Returns value of item.
ind (int) –
int
GetValuesForStrings(self, strings)¶Returns array of values matching the given strings.
Unmatching strings result in PG_INVALID_VALUE entry in array.
strings (list of strings) –
list of integers
Index(self, *args, **kw)¶ Overloaded Implementations:
Index (self, label)
Returns index of item with given label.
label (string) –
int
Index (self, val)
Returns index of item with given value.
val (int) –
int
Insert(self, *args, **kw)¶ Overloaded Implementations:
Insert (self, label, index, value=PG_INVALID_VALUE)
Inserts a single item.
label (string) –
index (int) –
value (int) –
Insert (self, entry, index)
Inserts a single item with full entry information.
entry (wx.propgrid.PGChoiceEntry) –
index (int) –
IsOk(self)¶Returns False if this is a constant empty set of choices, which should not be modified.
bool
Item(self, i)¶Returns item at given index.
i (int) –
RemoveAt(self, nIndex, count=1)¶Removes count items starting at position nIndex.
nIndex (int) –
count (int) –
Set(self, labels, values=[])¶This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
labels (list of strings) –
values (list of integers) –
__getitem__(self, index)¶Returns a reference to a :class:PGChoiceEntry using Python list syntax.
__len__(self)¶DataPtr¶See GetDataPtr