ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
pqHelperProxyRegisterUndoElement Class Reference

This is a special undo element that gets added after a proxy (referred to as "source" proxy) and all its helpers have been registered. More...

#include <pqHelperProxyRegisterUndoElement.h>

Inheritance diagram for pqHelperProxyRegisterUndoElement:
Inheritance graph
[legend]
Collaboration diagram for pqHelperProxyRegisterUndoElement:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetOperationTypeToUndo ()
void SetOperationTypeToRedo ()
virtual int Undo ()
 Description: Undo the operation encapsulated by this element.
virtual int Redo ()
 Description: Redo the operation encaspsulated by this element.
void RegisterHelperProxies (pqProxy *proxy)
 Description: Creates the element to setup helper proxies for the proxy.

Static Public Member Functions

static
pqHelperProxyRegisterUndoElement
New ()
static int IsTypeOf (const char *type)
static
pqHelperProxyRegisterUndoElement
SafeDownCast (vtkObject *o)

Protected Member Functions

 pqHelperProxyRegisterUndoElement ()
 ~pqHelperProxyRegisterUndoElement ()
virtual int DoTheJob ()

Protected Attributes

bool ForUndo

Detailed Description

This is a special undo element that gets added after a proxy (referred to as "source" proxy) and all its helpers have been registered.

AND before it's proxy and all its helpers have been UNregistered. On undo, this element does nothing since the creation of helper proxies will automatically be undone before the undo for creation of the "source" proxy. However, on redo, there is no means for the "source" proxy to be made aware of the helper proxies which will get registered after the "source". That's where this element comes handy. It sets the proxies as helpers on the "source" proxy. For this to work, application must push this element on the stack after the "source" proxy and all its helpers have been registered.

Definition at line 52 of file pqHelperProxyRegisterUndoElement.h.


Constructor & Destructor Documentation

pqHelperProxyRegisterUndoElement::pqHelperProxyRegisterUndoElement ( ) [protected]
pqHelperProxyRegisterUndoElement::~pqHelperProxyRegisterUndoElement ( ) [protected]

Member Function Documentation

static pqHelperProxyRegisterUndoElement* pqHelperProxyRegisterUndoElement::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* pqHelperProxyRegisterUndoElement::GetClassName ( ) [virtual]

Reimplemented from vtkSMUndoElement.

static int pqHelperProxyRegisterUndoElement::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkSMUndoElement.

virtual int pqHelperProxyRegisterUndoElement::IsA ( const char *  type) [virtual]

Reimplemented from vtkSMUndoElement.

static pqHelperProxyRegisterUndoElement* pqHelperProxyRegisterUndoElement::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkSMUndoElement.

void pqHelperProxyRegisterUndoElement::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkSMUndoElement.

void pqHelperProxyRegisterUndoElement::SetOperationTypeToUndo ( ) [inline]

Definition at line 58 of file pqHelperProxyRegisterUndoElement.h.

void pqHelperProxyRegisterUndoElement::SetOperationTypeToRedo ( ) [inline]

Definition at line 59 of file pqHelperProxyRegisterUndoElement.h.

virtual int pqHelperProxyRegisterUndoElement::Undo ( ) [inline, virtual]

Description: Undo the operation encapsulated by this element.

We make the pqProxy aware of its helper proxies.

Implements vtkUndoElement.

Definition at line 64 of file pqHelperProxyRegisterUndoElement.h.

virtual int pqHelperProxyRegisterUndoElement::Redo ( ) [inline, virtual]

Description: Redo the operation encaspsulated by this element.

We make the pqProxy aware of its helper proxies.

Implements vtkUndoElement.

Definition at line 69 of file pqHelperProxyRegisterUndoElement.h.

void pqHelperProxyRegisterUndoElement::RegisterHelperProxies ( pqProxy proxy)

Description: Creates the element to setup helper proxies for the proxy.

virtual int pqHelperProxyRegisterUndoElement::DoTheJob ( ) [protected, virtual]

Member Data Documentation

Definition at line 80 of file pqHelperProxyRegisterUndoElement.h.


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