IpeLayer Class Reference
[Ipe Document]
A layer of an IpePage.
More...
List of all members.
Public Types
- enum { EDim = 0x01,
ELocked = 0x02,
ENoSnapping = 0x04
}
Public Member Functions
Public Attributes
Detailed Description
A layer of an IpePage.
Each object on an IpePage belongs to one of the layers of the page. Layers are orthogonal to the back-to-front ordering of objects, so a "layer" is just another attribute of the object.
Layers have several attributes:
- They may be editable or locked. Objects in a locked layer cannot be selected, and a locked layer cannot be made active in the Ipe UI. This more or less means that the contents of such a layer cannot be modified---but that's a consequence of the UI, Ipelib contains no special handling of locked layers.
- A layer may be dimmed (on the screen - no dimming appears on PDF or Postscript output).
- A layer may have snapping on or off---objects will behave magnetically only if their layer has snapping on.
The PDF output generated for an IpePage depends on its views. Each view may list a number of layers to be displayed at that stage. Multiple views may show different subsets of layers.
Constructor & Destructor Documentation
IpeLayer::IpeLayer |
( |
IpeString |
name |
) |
[explicit] |
|
|
Construct with name. Default attributes.
|
|
Construct from a single XML tag.
|
Member Function Documentation
void IpeLayer::SaveAsXml |
( |
IpeStream & |
stream |
) |
const |
|
|
Write a single XML tag describing this layer.
|
void IpeLayer::SetName |
( |
const IpeString & |
name |
) |
[inline] |
|
bool IpeLayer::IsDimmed |
( |
|
) |
const [inline] |
|
bool IpeLayer::IsLocked |
( |
|
) |
const [inline] |
|
bool IpeLayer::IsSnapping |
( |
|
) |
const [inline] |
|
void IpeLayer::SetDimmed |
( |
bool |
flag |
) |
|
|
void IpeLayer::SetLocked |
( |
bool |
flag |
) |
|
|
void IpeLayer::SetSnapping |
( |
bool |
flag |
) |
|
|
The documentation for this class was generated from the following files: