vtkSMProxyClipboard Class Reference

helper class to help copy/paste properties on proxies. More...

#include <vtkSMProxyClipboard.h>

Inheritance diagram for vtkSMProxyClipboard:

Collaboration diagram for vtkSMProxyClipboard:

Public Types
typedef vtkSMObject	Superclass
Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
bool	Copy (vtkSMProxy *source)
	Put a proxy's state on the clipboard. More...
bool	CanPaste (vtkSMProxy *target)
	Returns true of the proxy state on the clipboard can be pasted on to the specified target. More...
bool	Paste (vtkSMProxy *target)
	Paste the state on the clipboard on to the target proxy. More...
void	Clear ()
	Clears the clipboard. More...
Public Member Functions inherited from vtkSMObject
void	PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions
static vtkSMProxyClipboard *	New ()
static int	IsTypeOf (const char *type)
static vtkSMProxyClipboard *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()
static int	IsTypeOf (const char *type)
static vtkSMObject *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkSMProxyClipboard ()
	~vtkSMProxyClipboard ()
Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()
	~vtkSMObject ()

Protected Attributes
vtkSmartPointer< vtkPVXMLElement >	CopiedState

Detailed Description

helper class to help copy/paste properties on proxies.

vtkSMProxyClipboard is a helper class used to enable copy/paste for properties on proxies. Copy/Paste is more that simply copying values from a proxy to another (for which one should simply use vtkSMProxy::Copy()). This has several extra smarts including the following:

• Skips input properties.
• Skips properties that are hidden by setting vtkSMProperty::PanelVisibility to "never".
• Specially handles properties with vtkSMProxyListDomain to select the same type of proxy from the target domain when pasting and then loading the state for the value proxy separately.
• For other vtkSMProxyProperty instances (e.g. LookupTable, ScalarOpacityFunction, etc.) on Paste, it tries to locate the requested proxy value on the session.

Definition at line 46 of file vtkSMProxyClipboard.h.

Member Typedef Documentation

Superclass

typedef vtkSMObject vtkSMProxyClipboard::Superclass

Definition at line 50 of file vtkSMProxyClipboard.h.

Constructor & Destructor Documentation

vtkSMProxyClipboard()

vtkSMProxyClipboard::vtkSMProxyClipboard ( )

protected

~vtkSMProxyClipboard()

vtkSMProxyClipboard::~vtkSMProxyClipboard ( )

protected

Member Function Documentation

New()

static vtkSMProxyClipboard* vtkSMProxyClipboard::New ( )

static

GetClassName()

virtual const char* vtkSMProxyClipboard::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

IsTypeOf()

static int vtkSMProxyClipboard::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkSMProxyClipboard::IsA ( const char *  type )

virtual

Reimplemented from vtkSMObject.

SafeDownCast()

static vtkSMProxyClipboard* vtkSMProxyClipboard::SafeDownCast ( vtkObject *  o )

static

PrintSelf()

void vtkSMProxyClipboard::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Copy()

bool vtkSMProxyClipboard::Copy

(

vtkSMProxy *

source

)

Put a proxy's state on the clipboard.

Return true if the operation was successful.

CanPaste()

bool vtkSMProxyClipboard::CanPaste

(

vtkSMProxy *

target

)

Returns true of the proxy state on the clipboard can be pasted on to the specified target.

Current implementation doesn't check for the types of the proxies. In future, we can make this type-aware or add other criteria.

Paste()

bool vtkSMProxyClipboard::Paste

(

vtkSMProxy *

target

)

Paste the state on the clipboard on to the target proxy.

Clear()

void vtkSMProxyClipboard::Clear ( )

inline

Clears the clipboard.

Same as calling Copy(NULL).

Definition at line 74 of file vtkSMProxyClipboard.h.

Member Data Documentation

CopiedState

vtkSmartPointer<vtkPVXMLElement> vtkSMProxyClipboard::CopiedState

protected

Definition at line 80 of file vtkSMProxyClipboard.h.

---

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

• /builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/ServerManager/Default/vtkSMProxyClipboard.h