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.
Class Hierarchy¶
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. |
|
Properties Summary¶
See |
|
See |
|
See |
|
See |
|
See |
Class API¶
- class wx.propgrid.PGChoices(object)¶
Possible constructors:
PGChoices() -> None PGChoices(a) -> None PGChoices(labels, values=[]) -> None PGChoices(data) -> None
Helper class for managing choices of PropertyGrid properties.
Methods¶
- __init__(self, *args, **kw)¶
-
__init__ (self)
Default constructor.
- Return type:
None
__init__ (self, a)
Copy constructor, uses reference counting.
To create a real copy, use
Copy
member function instead.- Parameters:
- Return type:
None
__init__ (self, labels, values=[])
Constructor.
- Parameters:
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.
- Return type:
None
__init__ (self, data)
Simple interface constructor.
- Parameters:
data (wx.propgrid.PGChoicesData)
- Return type:
None
- Add(self, *args, **kw)¶
-
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.
- Parameters:
arr (list of strings)
arrint (list of integers)
- Return type:
None
Add (self, label, value=PG_INVALID_VALUE)
Adds a single choice item.
- Parameters:
label (string) – Label for added choice.
value (int) – Value for added choice. If unspecified, index is used.
- Return type:
Add (self, label, bitmap, value=PG_INVALID_VALUE)
Adds a single item, with bitmap.
- Parameters:
label (string)
bitmap (wx.Bitmap)
value (int)
- Return type:
Add (self, entry)
Adds a single item with full entry information.
- Parameters:
entry (wx.propgrid.PGChoiceEntry)
- Return type:
- AddAsSorted(self, label, value=PG_INVALID_VALUE)¶
Adds a single item, sorted.
- Parameters:
label (string)
value (int)
- Return type:
- AllocExclusive(self)¶
Creates exclusive copy of current choices.
- Return type:
None
- Assign(self, a)¶
Assigns choices data, using reference counting.
To create a real copy, use
Copy
member function instead.- Parameters:
- Return type:
None
- AssignData(self, data)¶
Assigns data from another set of choices.
- Parameters:
data (wx.propgrid.PGChoicesData)
- Return type:
None
- Clear(self)¶
Deletes all items.
- Return type:
None
- Copy(self)¶
Returns a real copy of the choices.
- Return type:
- EnsureData(self)¶
- Return type:
None
- ExtractData(self)¶
Changes ownership of data to you.
- Return type:
- GetCount(self)¶
Returns number of items.
- Return type:
int
- GetData(self)¶
Returns data, increases refcount.
- Return type:
- GetDataPtr(self)¶
Returns plain data ptr - no refcounting stuff is done.
- Return type:
- GetId(self)¶
Gets an number identifying this list.
- Return type:
wx.IntPtr
- GetIndicesForStrings(self, strings, unmatched=None)¶
Returns array of indices matching given strings.
Unmatching strings are added to ‘unmatched’, if not
None
.- Parameters:
strings (list of strings)
unmatched (list of strings)
- Return type:
List[int]
- GetLabel(self, ind)¶
Returns label of item.
- Parameters:
ind (int)
- Return type:
str
- GetLabels(self)¶
Returns array of choice labels.
- Return type:
List[str]
- GetValue(self, ind)¶
Returns value of item.
- Parameters:
ind (int)
- Return type:
int
- GetValuesForStrings(self, strings)¶
Returns array of values matching the given strings.
Unmatching strings result in
PG_INVALID_VALUE
entry in array.- Parameters:
strings (list of strings)
- Return type:
List[int]
- Index(self, *args, **kw)¶
-
Index (self, label)
Returns index of item with given label.
- Parameters:
label (string)
- Return type:
int
Index (self, val)
Returns index of item with given value.
- Parameters:
val (int)
- Return type:
int
- Insert(self, *args, **kw)¶
-
Insert (self, label, index, value=PG_INVALID_VALUE)
Inserts a single item.
- Parameters:
label (string)
index (int)
value (int)
- Return type:
Insert (self, entry, index)
Inserts a single item with full entry information.
- Parameters:
entry (wx.propgrid.PGChoiceEntry)
index (int)
- Return type:
- IsOk(self)¶
Returns
False
if this is a constant empty set of choices, which should not be modified.- Return type:
bool
- Item(self, i)¶
Returns item at given index.
- Parameters:
i (int)
- Return type:
- RemoveAt(self, nIndex, count=1)¶
Removes count items starting at position nIndex.
- Parameters:
nIndex (int)
count (int)
- Return type:
None
- 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.
- Parameters:
labels (list of strings)
values (list of integers)
- Return type:
None
- __getitem__(self, index)¶
Returns a reference to a :class:PGChoiceEntry using Python list syntax.
- __len__(self)¶
Properties¶
- DataPtr¶
See
GetDataPtr