Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Public Member Functions | Properties

ISkpFont Interface Reference

A font. More...

List of all members.

Public Member Functions

HRESULT GetBoundsMultiLine ([in]ISkpView *pView,[in] BSTR text,[out, retval] ISkpBoundingBox3d **ppBox)
 Returns the bounds for the given text.

Properties

long PointSize [get]
 [propget] What is point size of this font?
BSTR FontFace [get]
 [propget] Returns the font face for this font.
BOOL Bold [get]
 [propget] Returns whether or not the font is in bold.
BOOL Italic [get]
 [propget] Returns whether or not the font is in italics.
double WorldSize [get]
 [propget] Returns whether the world size of the font
BOOL UseWorldSize [get]
 [propget] Returns whether the font is world size.

Detailed Description

A font.


Member Function Documentation

HRESULT ISkpFont::GetBoundsMultiLine ( [in] ISkpView pView,
[in] BSTR  text,
[out, retval] ISkpBoundingBox3d **  ppBox 
)

Returns the bounds for the given text.

Parameters:
pView The non-NULL view to use to compute the bounds of the given text.
text The text to be drawn.
Return values:
ppBox The 3d bounding box containing the text drawn with this font.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

Property Documentation

BOOL ISkpFont::Bold [get]

[propget] Returns whether or not the font is in bold.

Return values:
pVal TRUE iff the font is bold.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BSTR ISkpFont::FontFace [get]

[propget] Returns the font face for this font.

Return values:
pVal The font's face.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpFont::Italic [get]

[propget] Returns whether or not the font is in italics.

Return values:
pVal TRUE iff the font is in italics.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
long ISkpFont::PointSize [get]

[propget] What is point size of this font?

Return values:
pVal The font's point size.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpFont::UseWorldSize [get]

[propget] Returns whether the font is world size.

Return values:
pVal TRUE iff the font is world size. Otherwise it uses the PointSize property.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
double ISkpFont::WorldSize [get]

[propget] Returns whether the world size of the font

Return values:
pVal The world size (in inches) of the font. Use this only if the UseWorldSize property is TRUE. Otherwise use the Pointsize property.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

©2010 Google - Google Home - About Google