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

Public Member Functions | Properties

ISkpText Interface Reference

A Text entity. More...

Inheritance diagram for ISkpText:
SkpText

List of all members.

Public Member Functions

HRESULT _GetLeaderPoints ([in] ISkpView *pView,[out]double *pLeaderStartPoint3d,[out]double *pLeaderEndPoint3d,[out]double *pExtensionEndPoint3d,[out]double *pTextOffsetPoint3d,[out]SkpTextJustification *just,[out]SkpTextAlignment *align)
 [propget] Returns the leader points of this text entity relative to the given view.
HRESULT LeaderPoints ([in] ISkpView *pView,[out]ISkpPoint3d **pLeaderStartPoint3d,[out]ISkpPoint3d **pLeaderEndPoint3d,[out]ISkpPoint3d **pExtensionEndPoint3d,[out]ISkpPoint3d **pTextOffsetPoint3d,[out]SkpTextJustification *just,[out]SkpTextAlignment *align)
 [propget] Returns the leader points of this text entity relative to the given view.

Properties

BSTR Text [get]
 [propget] Returns the text string.
ISkpFont DrawingFont [get]
 [propget] Returns the font used to render the text.
SkpTextLeader LeaderType [get]
 [propget] Returns the type of text leader.
BOOL DisplayLeader [get]
 [propget] Returns whether or not the leader is displayed
SkpDimensionArrow ArrowType [get]
 [propget] Returns the type of arrow used.

Detailed Description

A Text entity.


Member Function Documentation

HRESULT ISkpText::_GetLeaderPoints ( [in] ISkpView pView,
[out] double *  pLeaderStartPoint3d,
[out] double *  pLeaderEndPoint3d,
[out] double *  pExtensionEndPoint3d,
[out] double *  pTextOffsetPoint3d,
[out] SkpTextJustification *  just,
[out] SkpTextAlignment *  align 
)

[propget] Returns the leader points of this text entity relative to the given view.

In this method it is assumed that the calling application has allocated double arrays of size 3 for all the output values, as appropriate.

Parameters:
pView The non-NULL view.
pLeaderStartPoint3d The start point of the leader.
pLeaderEndPoint3d The start point of the leader.
pExtensionEndPoint3d The end point of the extension.
pTextOffsetPoint3d The text offset point.
just The text justification.
align The text alignment.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
HRESULT ISkpText::LeaderPoints ( [in] ISkpView pView,
[out] ISkpPoint3d **  pLeaderStartPoint3d,
[out] ISkpPoint3d **  pLeaderEndPoint3d,
[out] ISkpPoint3d **  pExtensionEndPoint3d,
[out] ISkpPoint3d **  pTextOffsetPoint3d,
[out] SkpTextJustification *  just,
[out] SkpTextAlignment *  align 
)

[propget] Returns the leader points of this text entity relative to the given view.

Parameters:
pView The non-NULL view.
pLeaderStartPoint3d The start point of the leader.
pLeaderEndPoint3d The start point of the leader.
pExtensionEndPoint3d The end point of the extension.
pTextOffsetPoint3d The text offset point.
just The text justification.
align The text alignment.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors

Property Documentation

SkpDimensionArrow ISkpText::ArrowType [get]

[propget] Returns the type of arrow used.

Return values:
pVal The type of arrow used.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BOOL ISkpText::DisplayLeader [get]

[propget] Returns whether or not the leader is displayed

Return values:
pVal TRUE iff the leader is displayed.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
ISkpFont ISkpText::DrawingFont [get]

[propget] Returns the font used to render the text.

Return values:
pVal The ISkpFont used to render the text.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
SkpTextLeader ISkpText::LeaderType [get]

[propget] Returns the type of text leader.

Return values:
pVal The type of text leader.
Returns:
S_OK : if successful
E_POINTER : if any of the inputs are NULL
E_FAIL : indicates internal errors
BSTR ISkpText::Text [get]

[propget] Returns the text string.

Return values:
pVal The text string.
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