SyncLayer Class Reference

The Synclayer JavaScript global object. Provides utilities for sync and unsync drawing layers. More...

Public Slots
bool	syncLayers (String &drawingToSync, String &parentDrawing)
	Sync the specified layer with the specified parent drawing layer. More...
bool	unsyncLayer (String &syncedDrawing)
	Unsync the specified synced drawing layer. More...

Detailed Description

The Synclayer JavaScript global object. Provides utilities for sync and unsync drawing layers.

Member Function Documentation

syncLayers

bool SyncLayer::syncLayers ( String &  drawingToSync, String &  parentDrawing  )

slot

Sync the specified layer with the specified parent drawing layer.

Convert the specified layer to the synced drawing layer and sync it with the specified parent drawing layer. The specified sync drawing must not be already synced drawing layer, neither parent drawing layer. Moreover the specified sync and parent drawings must be different.

var ret = SyncLayer.syncLayers("Top/Drawing", "Top/Drawing_1");
System.println("Sync operation return : " + ret);

Parameters

drawingToSync	: The name of the layer to be converted to synced drawing layer
parentDrawing	: The name of the parent drawing layer

Returns

true if successful

unsyncLayer

bool SyncLayer::unsyncLayer ( String &  syncedDrawing )

slot

Unsync the specified synced drawing layer.

var ret = SyncLayer.unsyncLayer("Top/Drawing");
System.println("Unsync operation return : " + ret);

Parameters

syncedDrawing

: The name of the synced drawing layer to unsync

Returns

true if successful, false if opration is not permitted, ex if wrong name or parent drawing layer name