Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftTextProperties

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftTextProperties

Behaviour interface to modify elements which contains Texts.

Method Index

o GetAnchorPoint(DftAnchorPoint*): Gets the AnchorPoint of the text box.
o GetBold(boolean*): Gets the Bold style of the font.
o GetCharacterSpacing(double*): Gets the character spacing of the font.
o GetColor(unsigned int*): Gets the Color of the text.
o GetFontName(wchar_t**): Gets the short name of the font.
o GetFontRatio(double*): Gets the FontRatio value of the text.
o GetFontSize(double*): Gets the size of the font in millimeter (mm).
o GetFrameType(DftFrameType*): Gets the Type of the Frame surrounding the text.
o GetItalic(boolean*): Gets the Italic style of the font.
o GetJustification(DftJustification*): Gets the Justification of the text inside of its box.
o GetKerning(boolean*): Gets the Kerning style of the font.
o GetOverline(boolean*): Gets the Overline style of the font.
o GetStrikeThru(boolean*): Gets the StrikeThru style of the font.
o GetSubscript(boolean*): Gets the Subscript style of the font.
o GetSuperscript(boolean*): Gets the Superscript style of the font.
o GetSymbol(DftGDTSymbol*)
o GetUnderline(boolean*): Gets the Underline style of the font.
o Refresh(CATDftRefreshContext): Refreshes the object visualization according to its properties.
o SetAnchorPoint(DftAnchorPoint): Sets the AnchorPoint of the text box.
o SetBold(boolean): Sets the Bold style of the font.
o SetCharacterSpacing(double): Sets the character spacing of the font.
o SetColor(unsigned int): Sets the Color of the text.
o SetFontName(wchar_t*): Sets the short name of the font.
o SetFontRatio(double): Sets the FontRatio value of the text.
o SetFontSize(double): Sets the size of the font in millimeter (mm).
o SetFrameType(DftFrameType): Sets the Type of the Frame surrounding the text.
o SetItalic(boolean): Sets the Italic style of the font.
o SetJustification(DftJustification): Sets the Justification of the text inside of its box.
o SetKerning(boolean): Sets the Kerning style of the font.
o SetOverline(boolean): Sets the Overline style of the font.
o SetStrikeThru(boolean): Sets the StrikeThru style of the font.
o SetSubscript(boolean): Sets the Subscript style of the font.
o SetSuperscript(boolean): Sets the Superscript style of the font.
o SetSymbol(DftGDTSymbol)
o SetUnderline(boolean): Sets the Underline style of the font.

Methods

o GetAnchorPoint

public virtual GetAnchorPoint( oAnchorPoint)

Gets the AnchorPoint of the text box.

Parameters:

oAnchorPoint

Returns:

S_OK : Method correctly executed.
No restriction.
S_READONLY : Method correctly executed.
Returned value cannot be modified, it's read-only.
Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED : Method correctly executed.
Returned value is undefined.
Case of an object having several subparts supporting the same property with a different value.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o GetBold

public virtual GetBold( oBold)

Gets the Bold style of the font.

Parameters:

oBold

Returns:

o GetCharacterSpacing

public virtual GetCharacterSpacing( oCharSpacing)

Gets the character spacing of the font.

Parameters:

oCharSpacing: The space between two character.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetColor

public virtual GetColor( oColor)

Gets the Color of the text.

Parameters:

oColor

Returns:

o GetFontName

public virtual GetFontName( oFontName)

Gets the short name of the font.

Parameters:

oFontName

Returns:

See also:

o GetFontRatio

public virtual GetFontRatio( oFontRatio)

Gets the FontRatio value of the text.

Parameters:

oFontRatio: The font ratio (width/height) value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFontSize

public virtual GetFontSize( oFontSize)

Gets the size of the font in millimeter (mm).

Parameters:

oFontSize

Returns:

o GetFrameType

public virtual GetFrameType( oFrameType)

Gets the Type of the Frame surrounding the text.

Parameters:

oFrameType

Returns:

See also:

o GetItalic

public virtual GetItalic( oItalic)

Gets the Italic style of the font.

Parameters:

oItalic

Returns:

o GetJustification

public virtual GetJustification( oJustification)

Gets the Justification of the text inside of its box.

Parameters:

oJustification

Returns:

See also:

o GetKerning

public virtual GetKerning( oKerning)

Gets the Kerning style of the font.

Parameters:

oKerning

Returns:

o GetOverline

public virtual GetOverline( oOverline)

Gets the Overline style of the font.
Underline and Overline styles are usualy mutualy exclusive.

Parameters:

oOverline

Returns:

o GetStrikeThru

public virtual GetStrikeThru( oStrikeThru)

Gets the StrikeThru style of the font.

Parameters:

oStrikeThru

Returns:

o GetSubscript

public virtual GetSubscript( oSubscript)

Gets the Subscript style of the font.
Superscript and Subscript styles are mutualy exclusive.

Parameters:

oSubscript

Returns:

o GetSuperscript

public virtual GetSuperscript( oSuperscript)

Gets the Superscript style of the font.
Superscript and Subscript styles are mutualy exclusive.

Parameters:

oSuperscript

Returns:

o GetSymbol

public virtual GetSymbol( oSymbol)

Deprecated:

R210 use Gets the engineering symbol attached to the text.

Parameters:

oSymbol

Returns:

See also:

o GetUnderline

public virtual GetUnderline( oUnderline)

Gets the Underline style of the font.
Underline and Overline styles are usualy mutualy exclusive.

Parameters:

oUnderline

Returns:

o Refresh

public virtual Refresh( const iRefreshContext =DftRefreshAll)

Refreshes the object visualization according to its properties.

Parameters:

iRefreshContext

Returns:

S_OK : Method correctly executed.
E_FAIL : Method execution failed. Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o SetAnchorPoint

public virtual SetAnchorPoint( const iAnchorPoint)

Sets the AnchorPoint of the text box.

Parameters:

iAnchorPoint

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o SetBold

public virtual SetBold( const iBold)

Sets the Bold style of the font.

Parameters:

iBold

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetCharacterSpacing

public virtual SetCharacterSpacing( const iCharSpacing)

Sets the character spacing of the font.

Parameters:

iCharSpacing: The space between two character.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetColor

public virtual SetColor( const iColor)

Sets the Color of the text.

Parameters:

iColor

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetFontName

public virtual SetFontName( const iFontName)

Sets the short name of the font.

Parameters:

iFontName

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o SetFontRatio

public virtual SetFontRatio( const iFontRatio)

Sets the FontRatio value of the text.

Parameters:

iFontRatio: The font ratio (width/height) value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFontSize

public virtual SetFontSize( const iFontSize)

Sets the size of the font in millimeter (mm).

Parameters:

iFontSize

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetFrameType

public virtual SetFrameType( const iFrameType)

Sets the Type of the Frame surrounding the text.

Parameters:

iFrameType

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o SetItalic

public virtual SetItalic( const iItalic)

Sets the Italic style of the font.

Parameters:

iItalic

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetJustification

public virtual SetJustification( const iJustification)

Sets the Justification of the text inside of its box.

Parameters:

iJustification

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o SetKerning

public virtual SetKerning( const iKerning)

Sets the Kerning style of the font.

Parameters:

iKerning

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetOverline

public virtual SetOverline( const iOverline)

Sets the Overline style of the font.
Underline and Overline styles are usualy mutualy exclusive.

Parameters:

iOverline

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetStrikeThru

public virtual SetStrikeThru( const iStrikeThru)

Sets the StrikeThru style of the font.

Parameters:

iStrikeThru

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetSubscript

public virtual SetSubscript( const iSubscript)

Sets the Subscript style of the font.
Superscript and Subscript styles are mutualy exclusive.

Parameters:

iSubscript

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetSuperscript

public virtual SetSuperscript( const iSuperscript)

Sets the Superscript style of the font.
Superscript and Subscript styles are mutualy exclusive.

Parameters:

iSuperscript

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

o SetSymbol

public virtual SetSymbol( const iSymbol)

Deprecated:

R210 use Sets the engineering symbol attached to the text.

Parameters:

iSymbol

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

See also:

o SetUnderline

public virtual SetUnderline( const iUnderline)

Sets the Underline style of the font.
Underline and Overline styles are usualy mutualy exclusive.

Parameters:

iUnderline

Returns:

S_OK : Method correctly executed.
No restriction.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.

This object is included in the file: CATIDftTextProperties.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf