TGulAlignment Class Reference
Provides a convenient way to describe horizontal and vertical layouts of rectangular objects and to enquire how they occupy an area given their alignment.
Constructor & Destructor Documentation
TGulAlignment(TGulAlignmentValue)
Constructor initialising the object with an alignment value.
TGulAlignment(CGraphicsContext::TTextAlign, TGulVAlignment)
Constructor initialising the object with an alignment value.
Member Functions Documentation
HAlignment()
Gets the absolute horizontal alignment.
Note that this is the alignment in absolute terms. I.e. left and right alignment will not be swapped depending on language directionality.
HAlignment(TBidiText::TDirectionality)
Return the horizontal alignment, relative to the language directionality specified. Calling this method will return a horizontal alignment where left and right has been swapped for any language with RightToLeft directionality, UNLESS the alignment has been set as being absolute, by calling SetAbsoluteHAlignment().
HasAbsoluteHAlignment()
IMPORT_C TBool | HasAbsoluteHAlignment | ( | ) | const |
Return whether horizontal alignment will be treated as an absolute value, or relative the specified language directionality. In the latter case, left and right will be swapped (by TGulAlignment methods for which a TBidiText::TDirectionality is provided) for languages with RightToLeft directionality.
InnerRect(const TRect &, const TSize &)
IMPORT_C TRect | InnerRect | ( | const TRect & | aOuter, |
| const TSize & | aInnerSize |
| ) | const |
Gets the rectangle occupied by an object of size aInnerSize, which is placed in the area of the rectangle aOuter according to the current alignment.
Note that horizontal alignment is always treated as being in absolute terms.
Parameters
const TRect & aOuter | The outer rectangle. |
const TSize & aInnerSize | The size of the inner rectangle. |
InnerRect(const TRect &, const TSize &, TBidiText::TDirectionality)
Gets the rectangle occupied by an object of size aInnerSize, which is placed in the area of the rectangle aOuter according to the current alignment.
Note that if RightToLeft language directionality is specified, left and right horizontal alignment for the inner object will be swapped.
Parameters
const TRect & aOuter | The outer rectangle. |
const TSize & aInnerSize | The size of the inner rectangle. |
TBidiText::TDirectionality aLanguageDirectionality | The language directionality to consider when swapping left and right. |
InnerTopLeft(const TRect &, const TSize &)
Gets the co-ordinates of the top left corner of an object of size aInnerSize, which is placed in the area of the rectangle aOuter according to the current alignment.
Note that horizontal alignment is always treated as being in absolute terms.
Parameters
const TRect & aOuter | The outer rectangle. |
const TSize & aInnerSize | The size of the inner rectangle. |
InnerTopLeft(const TRect &, const TSize &, TBidiText::TDirectionality)
Gets the co-ordinates of the top left corner of an object of size aInnerSize, which is placed in the area of the rectangle aOuter according to the current alignment.
Note that if RightToLeft language directionality is specified, left and right horizontal alignment for the inner object will be swapped.
Parameters
const TRect & aOuter | The outer rectangle. |
const TSize & aInnerSize | The size of the inner rectangle. |
TBidiText::TDirectionality aLanguageDirectionality | The language directionality to consider when swapping left and right. |
SetAbsoluteHAlignment(TBool)
IMPORT_C void | SetAbsoluteHAlignment | ( | TBool | aAbsoluteHAlignment | ) | |
Set the current horizontal alignment to be used as an absolute value. If set to true, this means that the alignment will NOT be swapped depending on language directionality when calling e.g. HAlignment(TBidiText::TDirectionality).
Note that the default is false (i.e. relative alignment), and calling any of the setters on the TGulAlignment object will reset it to relative alignment (i.e. always call this method after the horizontal alignment has been set).
Also note that support for absolute horizontal alignment was added to TGulAlignment late in Symbian OS release 9.1. Hence if this method is called on an object that is passed to a client compiled against an earlier release (or if the client does not yet support absolute alignment) then the resulting alignment may be incorrect.
Parameters
TBool aAbsoluteHAlignment | |
SetHAlignment(TGulHAlignment)
Sets the horizontal alignment. Alignment will be reset to relative. I.e. when calling HAlignment() with a TBidiText::ERightToLeft argument, left and right will be swapped. Calling HAlignment() without argument will always return the alignment in absolute terms.
SetHAlignment(CGraphicsContext::TTextAlign)
Sets the horizontal alignment. Alignment will be reset to relative. I.e. when calling HAlignment() with a TBidiText::ERightToLeft argument, left and right will be swapped. Calling HAlignment() without argument will always return the alignment in absolute terms.
SetHAlignment(CParaFormat::TAlignment)
Sets the horizontal alignment. Alignment will be set to absolute for EAbsoluteLeftAlign and EAbsoluteRightAlign, otherwise relative the language directionality (if specified).
SetVAlignment(TGulVAlignment)
Sets the vertical alignment.
TextAlign()
Gets the absolute horizontal text alignment.
Note that this is the alignment in absolute terms. I.e. left and right alignment will not be swapped depending on language directionality.
TextAlign(TBidiText::TDirectionality)
Return the horizontal alignment, relative to the language directionality specified. Calling this method will return a horizontal alignment where left and right has been swapped for any language with RightToLeft directionality, UNLESS the alignment has been set as being absolute, by calling SetAbsoluteHAlignment().
VAlignment()
Gets the vertical alignment.
operator TGulAlignmentValue()
IMPORT_C | operator TGulAlignmentValue | ( | ) | const |
Gets the (absolute) alignment value as TGulAlignmentValue.
Note that this has the absolute horizontal alignment. I.e. left and right horizontal alignment will not be swapped depending on language directionality.
Member Data Documentation
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.