stlab.adobe.com Adobe Systems Incorporated

Eve engine.

#include <eve.hpp>

List of all members.

Public Types

enum  evaluate_options_t { evaluate_nested, evaluate_flat }

Public Member Functions

iterator add_placeable (iterator parent, const layout_attributes_t &initial, bool is_container_type, poly_placeable_t &placeable, bool reverse=false)
std::pair< int, int > adjust (evaluate_options_t options, int width, int height)
std::pair< int, int > evaluate (evaluate_options_t options, int width=0, int height=0)
void set_visible (iterator, bool)

Detailed Description

Definition at line 65 of file eve.hpp.


Member Enumeration Documentation

Specifies the coordinate system origin for the place_data_t of a given view.

Enumerator:
evaluate_nested 

Specifies the origin of the coordinate system to be the top left point of the parent view

evaluate_flat 

Specifies the origin of the coordinate system to be the top left point of the topmost view in the hierarchy.

Definition at line 85 of file eve.hpp.


Member Function Documentation

iterator add_placeable ( iterator  parent,
const layout_attributes_t initial,
bool  is_container_type,
poly_placeable_t placeable,
bool  reverse = false 
)

Adds a new view element to the view hierarchy being formed for layout.

Parameters:
parentthe parent of this view. Specify a default-constructed adobe::eve_t::iterator if this view is to be the topmost view. There can only be one topmost view when Eve goes to solve for the layout.
initialinitial layout attributes
is_container_typewhether or not the new node is to be a container view or not, irrespective of whether or not it will actually contain subviews.
Available Parameter Keys
NamePossible ValuesDefaultNotes
child_horizontal Any of the adobe::layout_attributes_alignment_t::alignment_t enumeration labels as an adobe::name_t align_default
child_vertical Any of the adobe::layout_attributes_alignment_t::alignment_t enumeration labels as an adobe::name_t align_default
guide_mask array containing any of [ guide_baseline, guide_label ] empty (no suppression) Suppression of horizontal and/or vertical guides
horizontal Any of the adobe::layout_attributes_alignment_t::alignment_t enumeration labels as an adobe::name_t align_default
indent integer 0
placement Any of the adobe::layout_attributes_placement_t enumeration labels as an adobe::name_t place_leaf
spacing array of integers [ 0 ] A single value here will propagate for all needed spacing values
vertical Any of the adobe::layout_attributes_alignment_t::alignment_t enumeration labels as an adobe::name_t align_default
Parameters:
placeablemust be a poly_placeable_t (which might be castable via adobe::poly_cast a poly_placeable_twopass_t).
reverseif false (default), this element should be added as last child of parent. If true, then the add as first child of parent. reverse is intended for implementing support for right-to-left languages. See Implementing Right-To-Left Layout.
Returns:
An opaque adobe::eve_t::iterator, which can be used as the parent parameter in another call to add_placeable to place subviews inside this one.
std::pair<int, int> adjust ( evaluate_options_t  options,
int  width,
int  height 
)

Adjusts the solved view layout to fit within the newly specified dimensions. Eve will relay the new solved layout information to individual placeable objects through thier place() functions. Specifying a width or hight less than that returned by evaluate() results in undefined behavior.

Parameters:
widthif not zero, the new width for the view layout.
heightif not zero, the new height for the view layout.
optionsoptions to be passed to the solution engine.
See also:
adobe::eve_t::evaluate_options_t
std::pair<int, int> evaluate ( evaluate_options_t  options,
int  width = 0,
int  height = 0 
)

This call performs the layout, it will call each element to get its dimentions, solve the layout, and place each item. Specifying a width and height less than the solved width and height will give undefined results. To resize a view, call evaluate() to get the minimum size then use adjust().

Parameters:
optionsoptions to be passed to the solution engine.
widthif not zero, width is used for the width of the layout rather than the solved width.
heightif not zero, height is used for the height of the layout rather than the solved height.
See also:
adobe::eve_t::evaluate_options_t
void set_visible ( iterator  ,
bool   
)

set_visible

Copyright © 2006-2007 Adobe Systems Incorporated.

Use of this website signifies your agreement to the Terms of Use and Online Privacy Policy.

Search powered by Google