Class EntryGroup
object --+
|
EntryGroup
A class which represents an entry group in the project table. Entry
groups are returned from the Project.group property.
The entry group itself has a number of properties:
collapsed - set or get the entry collapse/expand state
title - set or get the entry group title (What the user sees)
name - set or get the entry group name (Hidden unique name)
The following iterators are available which are very similar to those
available from the Project class but only operate on the entries in the
group:
all_rows - an iterator for all the rows in the group
selected_rows - an iterator for selected rows in the group
included_rows - an iterator for included rows in the group
|
|
__init__(self,
pt,
group_index)
x.__init__(...) initializes x; see help(type(x)) for signature |
|
|
|
|
|
|
|
_getName(self)
Return the name of this group |
|
|
|
|
_setName(self,
gname)
Set the name of this group |
|
|
|
|
_getParent(self)
Return the name of parent group, empty if group is under root. |
|
|
|
|
|
|
|
_getTitle(self)
Return the title of this group |
|
|
|
|
_setTitle(self,
gtitle)
Set the title of this group |
|
|
|
|
_getCollapsed(self)
Return the collapsed state of this group |
|
|
|
|
_setCollapsed(self,
collapsed)
Set the collapsed state of this group |
|
|
|
|
| _getAllRowsIterator(self) |
|
|
|
|
_getAllEntryIndices(self)
Return all entry indices of the group, it also includes entries of
children groups. |
|
|
|
|
| _getSelectedRowsIterator(self) |
|
|
|
|
|
|
Inherited from object:
__delattr__,
__format__,
__getattribute__,
__hash__,
__new__,
__reduce__,
__reduce_ex__,
__repr__,
__setattr__,
__sizeof__,
__subclasshook__
|
|
|
name
Get and set the name of this group
|
|
|
title
Get and set the title of this group
|
|
|
collapsed
Get and set the collapsed state of this group
|
|
|
all_rows
Iterator for all rows in the group using the visible project table
order
|
|
|
selected_rows
Iterator for the selected rows in the group usig the visible project
table order
|
|
|
included_rows
Iterator for all included rows in the group.
|
|
Inherited from object:
__class__
|
__init__(self,
pt,
group_index)
(Constructor)
|
|
x.__init__(...) initializes x; see help(type(x)) for signature
- Overrides:
object.__init__
- (inherited documentation)
|
__str__(self)
(Informal representation operator)
|
|
str(x)
- Overrides:
object.__str__
- (inherited documentation)
|
_getIncludedRowsIterator(self)
|
|
Private method. The property should be used to access the
iterator.
|
name
Get and set the name of this group
- Get Method:
- _getName(self)
- Return the name of this group
- Set Method:
- _setName(self,
gname)
- Set the name of this group
|
title
Get and set the title of this group
- Get Method:
- _getTitle(self)
- Return the title of this group
- Set Method:
- _setTitle(self,
gtitle)
- Set the title of this group
|
collapsed
Get and set the collapsed state of this group
- Get Method:
- _getCollapsed(self)
- Return the collapsed state of this group
- Set Method:
- _setCollapsed(self,
collapsed)
- Set the collapsed state of this group
|
all_rows
Iterator for all rows in the group using the visible project table
order
- Get Method:
- _getAllRowsIterator(self)
|
selected_rows
Iterator for the selected rows in the group usig the visible project
table order
- Get Method:
- _getSelectedRowsIterator(self)
|
included_rows
Iterator for all included rows in the group. Order should be treated
as random
- Get Method:
- _getIncludedRowsIterator(self)
- Private method.
|