#include <INewLayerCmdData.h>
Data interface for new layer command to create a new document layer.
- See Also
- kNewLayerCmdBoss
- IDocumentLayer
- ILayerList
| virtual UID INewLayerCmdData::GetColor | ( | | ) | |
| pure virtual |
Gets the data value for color to be used for the handles of selected items on this layer. Default is kInvalidUID, which means to just use the next available color in the list.
- Returns
- the UID of the kTrue if the new layer should appear in the Layers palette, kFalse if it should not. Non-UI layers are not visible to scripting either.
- See Also
- IUIColorUtils.h
| virtual bool16 INewLayerCmdData::GetIgnoreTextWrapWhenNotVisible | ( | | ) | |
| pure virtual |
Description: Get whether or not text wrap items on this layer will be ignored when the layer is invisible.
- Parameters
- Returns
- bool16
| virtual const UIDRef& INewLayerCmdData::GetLayerList | ( | | ) | |
| pure virtual |
Returns the target of the command, the layer list to make the new document layer in.
- Returns
- a UIDRef to the layer list the command will modify.
| virtual const PMString& INewLayerCmdData::GetName | ( | | ) | |
| pure virtual |
Gets the data value for the name of the new layer.
- Returns
- the new layer's name.
| virtual bool16 INewLayerCmdData::IsGuideLocked | ( | | ) | |
| pure virtual |
Gets the data value for ruler guide lock flag for the new layer. Guides can be locked just on a particular layer, independently of the overall document lock guides/unlock guides setting.
- Returns
- kTrue if guides are locked on the new layer, kFalse if unlocked.
| virtual bool16 INewLayerCmdData::IsGuideVisible | ( | | ) | |
| pure virtual |
Gets the data value for ruler guide visible flag for the new layer. Guides can be invisible just on a particular layer, independently of the overall document hide guides/show guides setting.
- Returns
- kTrue if guides are visible on the new layer, kFalse if hidden.
| virtual bool16 INewLayerCmdData::IsLayerExpendable | ( | | ) | |
| pure virtual |
Gets the data value for expendable/deletable data member.
- Returns
- kTrue if the new layer should be deletable, kFalse if it cannot be deleted.
| virtual bool16 INewLayerCmdData::IsLocked | ( | | ) | |
| pure virtual |
Gets the data value for lock flag for the new layer. Locked layers are skipped for hittesting. Items cannot be selected on a locked layer.
- Returns
- kTrue if the layer is locked, kFalse if unlocked.
| virtual bool16 INewLayerCmdData::IsPrintable | ( | | ) | |
| pure virtual |
Gets the data value for printable/nonprintable data member.
- Returns
- kTrue if new layer should be printable, kFalse for nonprintable.
| virtual bool16 INewLayerCmdData::IsUILayer | ( | | ) | |
| pure virtual |
Gets the data value for UI data member.
- Returns
- kTrue if the new layer should appear in the Layers palette, kFalse if it should not. Non-UI layers are not visible to scripting either.
| virtual bool16 INewLayerCmdData::IsVisible | ( | | ) | |
| pure virtual |
Gets the data value for visible flag for the new layer. Hidden layers are skipped for hittesting. Items cannot be selected on a hidden layer.
- Returns
- kTrue if the layer is visible, kFalse if hidden.
| virtual void INewLayerCmdData::Set | ( | const UIDRef & | layerList, | | | const PMString * | name = nil, | | | bool16 | isVisible = kTrue, | | | bool16 | isLocked = kFalse, | | | bool16 | isGuideVisible = kTrue, | | | bool16 | isGuideLocked = kFalse, | | | UID | layerColor = kInvalidUID, | | | bool16 | isUILayer = kTrue, | | | bool16 | isExpendable = kTrue | | ) | | |
| pure virtual |
Set method to control all the data values for the new document layer to create. Default values may be used for all but the first parameter to just create a new visible, unlocked document layer (Layer 2, Layer 3, etc).
- Parameters
| layerList | The layer list for the document to create the new layer in. |
| name | A pointer to the layer name, nil to autogenerate a unique name. |
| isVisible | The setting for the new layer's visibility. Default is kTrue for visible, kFalse for hidden. |
| isLocked | The setting for the new layer's locked state. Default is kTrue for unlocked, kFalse for locked. |
| isGuideVisible | The setting for the new layer's ruler guide visibility. Default is kTrue for visible guides on this layer, kFalse for hidden. |
| isGuideLocked | The setting for the new layer's ruler guide locked state. Default is kTrue for unlocked guides, kFalse for locked. |
| layerColor | A UID from the documents IID_IUICOLORLIST. Use kInvalidUID to generate the next available color. |
| isUILayer | The setting for whether the new layer should appear in the UID (Layers palette). Defaults to kTrue. |
| isExpendable | The setting for whether the new layer should be expendable/deletable. Defaults to kTrue. |
| virtual void INewLayerCmdData::SetIgnoreTextWrapWhenNotVisible | ( | bool16 | bIgnoreWhenNotVisible | ) | |
| pure virtual |
For new layer, if kTrue, then ignore all text wrap items on this layer when the layer is invisible.
- Parameters
| bIgnoreWhenNotVisible. | If not specified, new layers default to kFalse for this value. |
| virtual void INewLayerCmdData::SetPrintable | ( | bool16 | bPrintable | ) | |
| pure virtual |
Sets the data value for printable/nonprintable data member.
- Parameters
| bPrintable | The setting for the new layer's printable setting. If not specified, new layers default to printable. |
Public Member Functions inherited from IPMUnknown
1.8.3.1 
