layout_attributes_t Class Reference [Layout Attributes, Layout Engine]

Layout data interface from the client to the engine. More...

#include <adobe/layout_attributes.hpp>

List of all members.

Classes
class	slice_t
	placeable object geometry for a single orientation of layout_attributes_t. More...
Public Types
typedef std::vector< int >	spacing_t
Public Member Functions
int &	height ()
const int &	height () const
const slice_t &	horizontal () const
slice_t &	horizontal ()
	layout_attributes_t ()
slice_t &	vertical ()
const slice_t &	vertical () const
int &	width ()
const int &	width () const
Public Attributes
bool	create_m
extents_t	extents_m
int	indent_m
placement_t	placement_m
boost::array< slice_t, 2 >	slice_m
spacing_t	spacing_m

---

Detailed Description

layout_attributes_t slice-independent placeable object geometry

Todo:

(sparent) : We have a mechanism for defaulting container attributes. This needs to be extended to view attributes such as supressing guides.

Definition at line 68 of file layout_attributes.hpp.

---

Member Typedef Documentation

typedef std::vector<int> spacing_t

Definition at line 84 of file layout_attributes.hpp.

---

Constructor & Destructor Documentation

layout_attributes_t

(

)

Definition at line 75 of file layout_attributes.hpp.

---

Member Function Documentation

int& height

(

)

Definition at line 118 of file layout_attributes.hpp.

const int& height

(

)

const

Definition at line 121 of file layout_attributes.hpp.

slice_t& horizontal

(

)

Definition at line 112 of file layout_attributes.hpp.

const slice_t& horizontal

(

)

const

Definition at line 115 of file layout_attributes.hpp.

slice_t& vertical

(

)

Definition at line 111 of file layout_attributes.hpp.

const slice_t& vertical

(

)

const

Definition at line 114 of file layout_attributes.hpp.

int& width

(

)

Definition at line 119 of file layout_attributes.hpp.

const int& width

(

)

const

Definition at line 122 of file layout_attributes.hpp.

---

Member Data Documentation

create_m

create is a boolean denoting whether or not this placeable object will

actually exist as a UI framework. If false, this placeable object's geometry will affect the view layout but will not send a place call through the layout element object. Noncreating views such as row and column are good examples of placeable object types whose create_m is false.

See also:

poly_placeable_t

Definition at line 104 of file layout_attributes.hpp.

extents_t extents_m

Definition at line 102 of file layout_attributes.hpp.

indent_m

indent is a cross-stream value denoting the amount of indent for this single value. Cross-stream means that it is a value perpendicular to the orientation of the slice in which it is defined. Therefore, the horizontal indent is the amount in which the placeable object will be moved down vertically inside its parent.

Definition at line 103 of file layout_attributes.hpp.

placement_m

placement is the enumeration denoting the orientation children will have with respect to one another when being laid out.

See also:

adobe::layout_attributes_placement_t::placement_t

Definition at line 109 of file layout_attributes.hpp.

slice_m

This array contains the orientation-specific geometry for the placeable object in the two relative orientations (horiztonal and vertical).

See also:

adobe::layout_attributes_t::slice_t

Definition at line 106 of file layout_attributes.hpp.

spacing_m

spacing is the amount of space between children. Because the spacing vector is used to determine spacing between children, for a container with N children only the first N-1 spacing values will be used. If the spacing vector has a single element, that value is used for all spacing between all children. This only applies to container placeable objects.

Definition at line 105 of file layout_attributes.hpp.