All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftTextProperties

System.IUnknown
  |
  +---DraftingInterfaces.CATIDftProperties
    |
    +---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*)
Gets the engineering symbol attached to the text.
o GetUnderline(boolean*)
Gets the Underline style of the font.
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)
Sets the engineering symbol attached to the text.
o SetUnderline(boolean)
Sets the Underline style of the font.

Methods


o GetAnchorPoint
public virtual HRESULT GetAnchorPoint(DftAnchorPoint* oAnchorPoint)= 0
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:
DftAnchorPoint
o GetBold
public virtual HRESULT GetBold(boolean* oBold)= 0
Gets the Bold style of the font.
Parameters:
oBold
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.
o GetCharacterSpacing
public virtual HRESULT GetCharacterSpacing(double* oCharSpacing)= 0
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 HRESULT GetColor(unsigned int* oColor) = 0
Gets the Color of the text.
Parameters:
oColor
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.
o GetFontName
public virtual HRESULT GetFontName(wchar_t** oFontName)= 0
Gets the short name of the font.
Parameters:
oFontName
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:
CATFont
o GetFontRatio
public virtual HRESULT GetFontRatio(double* oFontRatio)= 0
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 HRESULT GetFontSize(double* oFontSize)= 0
Gets the size of the font in millimeter (mm).
Parameters:
oFontSize
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.
o GetFrameType
public virtual HRESULT GetFrameType(DftFrameType* oFrameType)= 0
Gets the Type of the Frame surrounding the text.
Parameters:
oFrameType
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:
DftFrameType
o GetItalic
public virtual HRESULT GetItalic(boolean* oItalic)= 0
Gets the Italic style of the font.
Parameters:
oItalic
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.
o GetJustification
public virtual HRESULT GetJustification(DftJustification* oJustification)= 0
Gets the Justification of the text inside of its box.
Parameters:
oJustification
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:
DftJustification
o GetKerning
public virtual HRESULT GetKerning(boolean* oKerning)= 0
Gets the Kerning style of the font.
Parameters:
oKerning
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.
o GetOverline
public virtual HRESULT GetOverline(boolean* oOverline)= 0
Gets the Overline style of the font.
Underline and Overline styles are usualy mutualy exclusive.
Parameters:
oOverline
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.
o GetStrikeThru
public virtual HRESULT GetStrikeThru(boolean* oStrikeThru)= 0
Gets the StrikeThru style of the font.
Parameters:
oStrikeThru
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.
o GetSubscript
public virtual HRESULT GetSubscript(boolean* oSubscript)= 0
Gets the Subscript style of the font.
Superscript and Subscript styles are mutualy exclusive.
Parameters:
oSubscript
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.
o GetSuperscript
public virtual HRESULT GetSuperscript(boolean* oSuperscript)= 0
Gets the Superscript style of the font.
Superscript and Subscript styles are mutualy exclusive.
Parameters:
oSuperscript
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.
o GetSymbol
public virtual HRESULT GetSymbol(DftGDTSymbol* oSymbol)= 0
Gets the engineering symbol attached to the text.
Parameters:
oSymbol
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:
DftFrameType
o GetUnderline
public virtual HRESULT GetUnderline(boolean* oUnderline)= 0
Gets the Underline style of the font.
Underline and Overline styles are usualy mutualy exclusive.
Parameters:
oUnderline
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.
o SetAnchorPoint
public virtual HRESULT SetAnchorPoint( const DftAnchorPoint iAnchorPoint)= 0
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:
DftAnchorPoint
o SetBold
public virtual HRESULT SetBold( const boolean iBold)= 0
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 HRESULT SetCharacterSpacing( const double iCharSpacing)= 0
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 HRESULT SetColor( const unsigned int iColor) = 0
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 HRESULT SetFontName( const wchar_t* iFontName)= 0
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:
CATFont
o SetFontRatio
public virtual HRESULT SetFontRatio( const double iFontRatio)= 0
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 HRESULT SetFontSize( const double iFontSize)= 0
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 HRESULT SetFrameType( const DftFrameType iFrameType)= 0
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:
DftFrameType
o SetItalic
public virtual HRESULT SetItalic( const boolean iItalic)= 0
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 HRESULT SetJustification( const DftJustification iJustification)= 0
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:
DftJustification
o SetKerning
public virtual HRESULT SetKerning( const boolean iKerning)= 0
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 HRESULT SetOverline( const boolean iOverline)= 0
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 HRESULT SetStrikeThru( const boolean iStrikeThru)= 0
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 HRESULT SetSubscript( const boolean iSubscript)= 0
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 HRESULT SetSuperscript( const boolean iSuperscript)= 0
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 HRESULT SetSymbol( const DftGDTSymbol iSymbol)= 0
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:
DftFrameType
o SetUnderline
public virtual HRESULT SetUnderline( const boolean iUnderline)= 0
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: CATDraftingInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.