Constructor.

Destructor.

Constructs and appends a new visual to the owner control.

Moves a point according to the visual's origin position. If this is called on both the iTl and iBr corners of a rectangle, the result is that the rectangle is aligned by the origin. This method is used during the calculations to determine a visual's display rectangle.

Applies mirroring to a coordinate point according to the base unit of the local coordinate system.

Converts a box metric to a pixel rectangle. This method is used for converting visual padding boxes to pixels.

Returns the brushes of the visual.

Returns the brushes of the visual.

Gets the visual's bounding rectangle in display coordinates that were calculated during previous frame. Display coordinates are defined relative to the display's visible area. Uses the current values of the position and size. Only calculated once per frame. The rect is always in pixels.

Determines if the visual has changed since the last change notification. Changed means becoming dirty, so that the area of the visual has to be redrawn.

Clears the changed status of the visual. This is called automatically by the refresh loop after a frame has been drawn.

Unset flags that affect the visual's behaviour.

Clear one or more flags that affect the visual's behaviour.

Determines whether the visual is clipping its contents.

Second-phase constructor, must be called in deriving class.

Returns the number of child visuals.

Returns the display of the visual (if shown).

Calculates the visual's bounding rectangle in display coordinates. Display coordinates are defined relative to the display's visible area. Uses the current values of the position and size. Only calculated once per frame. The rect is always in pixels.

Calculates the visual's bounding rectangle animation target in display coordinates. Display coordinates are defined relative to the display's visible area. Uses the target values of the rectangle position and size, which means transitions are always immediate in the returned rectangle. Only calculated once per frame. The rect is always in pixels.

Converts display coordinates to local coordinates. This method can be used when determining where a particular point on the display is in the local coordinate system of a layout, for instance when handling pointer input events. Display coordinates are defined relative to the display's visible area.

Converts display coordinates to local coordinates. This method can be used when determining where a particular point on the display is in the local coordinate system of a layout, for instance when handling pointer input events. Display coordinates are defined relative to the display's visible area.

Converts display coordinates to local coordinates. This method can be used when determining where a particular point on the display is in the local coordinate system of a layout, for instance when handling pointer input events. Display coordinates are defined relative to the display's visible area.

Draws the visual.

This default implementation applies local transformation, draws foreground brushes (over the content), background brushes (under the content) and content itself (by calling DrawSelf() ) with clipping.

Draws a layer of brushes for the visual.

Overridden by subclasses to draw the content of the visual. By default the base class DrawSelf does not draw anything.

Returns the drop shadow parameter handler.

Debug method for dumping the structure of a visual tree into the console.

Returns the currently active effect for the visual or NULL if no effect is active.

Returns the opacity of the visual, taking into account the opacity of parent visuals.

Enables or disables brushes for the visual.

Enables the drop shadow. Currently implemented for the image and text visuals.

Enables or disables transformation of the visual.

Applies or restores the local projection of the visual.

Returns the environment of the visual.

Expands the dirty region of the visual depending on the content of the visual. This includes any brushes attached to the visual. Used during dirty region reporting.

Finds a tacticon from this visual.

Finds a visual whose tag descriptor contains a specific tag.

CHuiVisual::FindTag() is the basic implementation that checks if this visual's tag matches the specified tag. CHuiLayout::FindTag() extends the search into child visuals, covering recursively entire visual hierarchies.

CHuiVisual::Tag() CHuiVisual::SetTagL() CHuiVisual::IsTagged() CHuiLayout::FindTag()

Returns the flags of the visual.

Returns the name of the class.

Calculate dual alpha levels. Used when crossfading images.

Handle flags changes.

Checks whether a tactile feedback has been assigned. Eventhough, this returns EFalse the layout may have feedback defined.

Determines the horizontal origin.

Determines if the visual has a tag.

CHuiVisual::Tag() CHuiVisual::SetTagL() CHuiVisual::FindTag()

Checks if this visual is transformed.

Returns the layout this visual belongs to.

Determines the base unit of the local coordinate system, in which this visual's position and size are stored. The position and size of the visual are multiplied by this metric to get the actual position and size.

! deprecated, use method with THuiReferenceState instead

Converts a point in the local coordinate system to pixels in the local coordinate system. The local coordinate system is relative to the top left corner of the parent. This method only does a unit conversion from the base units to pixels.

Converts local coordinates to display coordinates. This method is used for calculating the position of the visual on the display when the visual is about to be drawn. Display coordinates are defined relative to the display's visible area.

Converts local coordinates to display coordinates. This method is used for calculating the position of the visual on the display when the visual is about to be drawn. Display coordinates are defined relative to the display's visible area.

Converts local coordinates to display coordinates. This method is used for calculating the position of the visual on the display when the visual is about to be drawn. Display coordinates are defined relative to the display's visible area.

Use base unit version instead

Returns the maximum size of the visual.

Returns the maximum size of the visual in base units.

! deprecated, use method with THuiReferenceState instead

Calculates the reference size for a metric. The reference size is, for example, the size of the parent layout in the case of the EHuiUnitNormalized unit.

! deprecated, use method with THuiReferenceState instead

Converts an XY metric to a pixel point.

Positions and sizes this visual to match another.

This method should be used only when doing manual layouting. If the visuals are under a layout, then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Use base unit version instead

Returns the minimum size of the visual.

Returns the minimum size of the visual in base units.

Use base unit version instead

Moves the visual's position.

Move() should be used only when doing manual layouting (same goes for SetPos() and SetSize() ). If the visuals are under a layout that defines positions for its children (such as CHuiGridLayout ), then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Moves the visual's position.

Move() should be used only when doing manual layouting (same goes for SetPos() and SetSize() ). If the visuals are under a layout that defines positions for its children (such as CHuiGridLayout ), then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Converts a box metric to a rectangle in local coordinates. This method is used for converting visual padding boxes to local coordinate units when doing layout.

Notifies the visual that the environment's skin has been changed or updated. The visual should update its state (e.g., fonts) accordingly.

Returns the owner of the visual.

Returns the padding of the visual.

! deprecated, use method with THuiReferenceState instead

Returns the padding of the visual, in pixels.

Determines if the visuals parent has changed since the last change notification so that it may require also this visual to report itself as changed.

! deprecated, use method with THuiReferenceState instead

Converts a pixel point in the local coordinate system to a point that uses the base unit of the local coordinate system. The local coordinate system is relative to the top left corner of the parent. This method only does a unit conversion from pixels to the base units.

Converts a pixel point to a specific unit.

! deprecated, use method with THuiReferenceState instead

Converts a pixel point to an XY metric. The destination unit of the conversion is taken from the aMetric parameter.

Returns the position of the visual. This is set by UpdateLayout().

Returns the position of the visual.

PrepareDrawL prepares the visual for drawing (screen refresh). Can be used to update the visual or execute any Leaving operations such as resource allocation needed for the actual drawing.

By default the base class PrepareDrawL does not do anything.

Queries canvas flags of the visual, returns result

Checks if external content drawing is enabled for this visual, returns result

Checks if visual has something to draw, returns result

Destroys a hierarchy of visuals, along with this visual. The visuals are first removed from their owner.

Removes tactile feedback for the visual.

Called to inform the display that a dirty region has to be defined.

Reports a layout update to the owner. The owner is notified of the layout update if the layout update notification flag is set for the visual.

EHuiVisualFlagLayoutUpdateNotification

Gets the session id for object.

Use base unit version instead

Sets the position and size of the visual.

This method should be used only when doing manual layouting. If the visuals are under a layout, then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Sets the position and size of the visual.

This method should be used only when doing manual layouting. If the visuals are under a layout, then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Raises the change flag for this visual. Visual will be updated as soon as possible.

Sets the clipping mode of the layout.

Sets the display on which the visual is being shown.

Assign an effect for the visual. The ownership of the effect is transferred to the visual.

Assign the effect parser to the visual. The ownership is transferred to the visual This must be done because the parsing is asynchronous, and we must be sure that the visual is still alive when the parsing completes.

Set a flag that affects the visual's behaviour.

Sets one or more flags that affect the visual's behaviour.

Sets the layout this visual belongs to.

Use base unit version instead

Sets the maximum size of the visual.

Sets the maximum size of the visual.

Use base unit version instead

Sets the minimum size of the visual.

Sets the minimum size of the visual.

Sets the origin of the visual. The origin defines the location of the visual's position in relation to its DisplayRect. By default the visual's position defines its top left corner.

Calling this method is equivalent to setting/clearing the corresponding flags.

Sets the owner of the visual.

Sets the number of pixels that the visual uses for padding its contents. Sets both the horizontal and vertical padding.

Sets the number of pixels that the visual uses for padding its contents. Sets the horizontal and vertical padding separately.

Sets the amount of padding that the visual uses for padding its contents. The box metric can have a different amount on all sides.

Sets the position of the visual.

This method should be used only when doing manual layouting. If the visuals are under a layout that defines positions for its children (such as CHuiGridLayout ), then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using the SetFlag() method.

Sets the position and size of the visual.

This method should be used only when doing manual layouting. If the visuals are under a layout that defines positions and sizes for its children (such as CHuiGridLayout ), then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Sets the session id for object.

Sets the size of the visual.

This method should be used only when doing manual layouting. If the visuals are under a layout that defines sizes for its children (such as CHuiGridLayout ), then the layout class's facilities should be used instead.

If you want to move or otherwise layout the visual manually, you should set the EHuiVisualFlagManualLayout flag using SetFlag() method.

Sets an automatic tactile feedback. If this visual is a layout, the feedback affects to the child visuals as well. This can be overridden in child visuals.

TTouchEventType from touchlogicalfeedback.h TTouchLogicalFeedback from touchlogicalfeedback.h

Sets the tag of the visual.

The tag is a descriptor, in the form of one or more colon-separated character sequences. By default, visuals have no tag (""). Normally, a visual could have a single tag, for example ("caption"). The tag descriptor of the visual may contain multiple tags, for example: "tag1:tag2:tag3".

Tags can be used for identifying visuals. In a typical use case, a control could identify which of its visuals represent certain elements of the control based on the tag descriptors. In this case, the tags would be set by an outside party that also sets the tags of the visuals.

CHuiVisual::Tag() CHuiVisual::IsTagged() CHuiVisual::FindTag()

Returns the size of the visual. This is set by UpdateLayout().

Returns the skin of the owner control's environment.

Return tactile feedback of the event. Checks the parent layouts if this visual has not defined a feedback.

Determines the tag of the visual.

CHuiVisual::SetTagL() CHuiVisual::IsTagged() CHuiVisual::FindTag()

Applies or restores the local transformation matrix of the visual. Should be called before and after drawing the visual.

Returns the transformation of the visual.

Retruns pointer to transformation if this visual is transformed. Otherwise NULL is returned.

Gets the object type.

Update the layout of all children. Subclasses can call this to recalculate the layout of all children.

CHuiStatic::LayoutTransitionTime()

For convenience. Updates the layout of the siblings of this visual. In other words, asks the parent layout to do a children layout.

Determines the vertical origin.

Returns a child visual.

Background brushes.

! Position / order / size of public variables must not change Depth offset.

The display on which the visual is being shown.

Cached display rectangle for the current frame. Defines Calculates the visual's bounding rectangle in display coordinates. The rect is always in pixels. DisplayRect()

Describes during which frame the display rectance cache (iDisplayRect) is valid.

Cached visual's bounding rectangle animation target in display coordinates. Uses the target values of the position and size, which means transitions are always immediate in the returned rectangle.

Describes during which frame the display rectance target cache (iDisplayRectTarget) is valid.

Layout this visual belongs to (may be NULL ).

If effect is still being loaded (parsing), visual may need to be hided

Maximum allowed size for the visual. Layouts will respect this value when layout is being updated.

TodoNeeds to be implemented.

Minimum allowed size for the visual. Layouts will respect this value when layout is being updated.

TodoNeeds to be implemented.

Opacity of this visual. The interpolation style of opacity values by default is linear. A value of 0 is fully transparent, a value of 1 is fully opaque.

Owner of the visual.

Padding between visual edges and content. The box metric can have a different amount of padding on each of the four sides.

Position of the visual.

Display area that was in effect during the previous draw operation. This will be included in the dirty rectangle.

! ------------------------------- Session id

Size of the visual.

Tag.

Used for tracking the visual in different stages of rendering

If not NULL , this transformation is used when the content visual is drawn.