libIntegra
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Static Public Member Functions | List of all members
integra_api::IMoveCommand Class Reference

Command to move nodes to different branches of the node hierarchy. More...

#include "api/command.h"

Inheritance diagram for integra_api::IMoveCommand:
Inheritance graph
[legend]
Collaboration diagram for integra_api::IMoveCommand:
Collaboration graph
[legend]

Static Public Member Functions

static IMoveCommandcreate (const CPath &node_path, const CPath &new_parent_path)
 Create an instance of IMoveCommand Moves nodes within the node tree. More...
 

Additional Inherited Members

- Public Member Functions inherited from integra_api::ICommand
virtual CError execute (integra_internal::CServer &server, CCommandSource source, CCommandResult *result)=0
 Internal use only.
 

Detailed Description

Command to move nodes to different branches of the node hierarchy.

Member Function Documentation

static IMoveCommand* integra_api::IMoveCommand::create ( const CPath node_path,
const CPath new_parent_path 
)
static

Create an instance of IMoveCommand Moves nodes within the node tree.

Note
libIntegra doesn't attach any importance to the order of sibling nodes, so the only repositioning possible is re-parenting.
Parameters
node_paththe node to move
new_parent_pathpath of the node which should become the new parent of the node referred to by node_path. To move a node to the top level, use an empty path.
Returns
a pointer to the command, created on the heap.

The documentation for this class was generated from the following file: