fsf::CPassiveHandle Class Reference
[Handles]
The passive handle class.
More...
#include <FsfHandle.h>
Public Member Functions | |
Creators | |
| CPassiveHandle () | |
| 0-parameter constructor | |
| CPassiveHandle (CNode *pNode, long nHandleID) | |
| 2-parameter constructor: pointer to node and handle ID | |
| CPassiveHandle (const CPassiveHandle &h) | |
| Copy constructor. | |
| ~CPassiveHandle () | |
| Destructor. Recursively destroys subhandles. | |
Accessors | |
| CNode * | getNode () const |
| Gets a pointer to this handle's target node. | |
| long | getHandleID () const |
| Gets this handle's ID. | |
| void | getChildren (std::list< CPassiveHandle * > &listHandles) |
| Gets a list of pointer to this handle's subhendles. | |
Manipulators | |
| void | setHandleID (long nID) |
| Sets this handle's ID. | |
| void | addChild (CPassiveHandle *pHandle) |
| Adds the argument handle to the list of this handle's subhandles. | |
| void | spliceChildren (std::list< CPassiveHandle * > &listHandles) |
| Moves the handle pointers in the argument list to this handle's list of subhandles. | |
| void | addChildren (std::list< CPassiveHandle * > &listHandles) |
| Copies the handle pointers in the argument list to this handle's list of subhandles. | |
| void | deleteChildren () |
| Deletes this handle's subhandles. | |
Detailed Description
The passive handle class.
Constructor & Destructor Documentation
| fsf::CPassiveHandle::CPassiveHandle | ( | ) | [inline] |
0-parameter constructor
| fsf::CPassiveHandle::CPassiveHandle | ( | CNode * | pNode, | |
| long | nHandleID | |||
| ) | [inline] |
2-parameter constructor: pointer to node and handle ID
| CPassiveHandle::CPassiveHandle | ( | const CPassiveHandle & | h | ) |
Copy constructor.
| fsf::CPassiveHandle::~CPassiveHandle | ( | ) | [inline] |
Destructor. Recursively destroys subhandles.
Member Function Documentation
| void fsf::CPassiveHandle::addChild | ( | CPassiveHandle * | pHandle | ) | [inline] |
Adds the argument handle to the list of this handle's subhandles.
| void fsf::CPassiveHandle::addChildren | ( | std::list< CPassiveHandle * > & | listHandles | ) | [inline] |
Copies the handle pointers in the argument list to this handle's list of subhandles.
Argument listHandles is not empty after execution, its elements (pointers) have the same values as those created and added to m_listChildren.
| void fsf::CPassiveHandle::deleteChildren | ( | ) |
Deletes this handle's subhandles.
| void fsf::CPassiveHandle::getChildren | ( | std::list< CPassiveHandle * > & | listHandles | ) | [inline] |
Gets a list of pointer to this handle's subhendles.
| long fsf::CPassiveHandle::getHandleID | ( | ) | const [inline] |
Gets this handle's ID.
| CNode* fsf::CPassiveHandle::getNode | ( | ) | const [inline] |
Gets a pointer to this handle's target node.
| void fsf::CPassiveHandle::setHandleID | ( | long | nID | ) | [inline] |
Sets this handle's ID.
| void fsf::CPassiveHandle::spliceChildren | ( | std::list< CPassiveHandle * > & | listHandles | ) | [inline] |
Moves the handle pointers in the argument list to this handle's list of subhandles.
Argument listHandles is empty after execution.
The documentation for this class was generated from the following files:
