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

Public Member Functions | Properties

ISkpApplication Interface Reference

The application controlling distribution of the ISkpDocument. More...

Inheritance diagram for ISkpApplication:
SkpApplication

List of all members.

Public Member Functions

HRESULT CreateTextureWriter ([out, retval]ISkpTextureWriter **pWriter)
 A utility method that will create a texture writer.

Properties

BSTR Name [get]
 [propget] Returns the name of the application.
BSTR Fullname [get]
 [propget] Returns the full name of the application.
BSTR Version [get]
 [propget] Returns the version of the application.
ISkpDocument ActiveDocument [get]
 [propget] Returns the current ISkpDocument.
BSTR StatusText [set]
 Set the status line text.
BSTR TypeName [get]
 [propget] Returns the type name for this object.

Detailed Description

The application controlling distribution of the ISkpDocument.

The ISkpApplication interface holds information about the application providing the SketchUp document. This application may be, for example, the Reader application or the SketchUp application.

See also:
ISkpFileReader
Examples:

GetCurrentView.cpp.


Member Function Documentation

HRESULT ISkpApplication::CreateTextureWriter ( [out, retval] ISkpTextureWriter **  pWriter  ) 

A utility method that will create a texture writer.

This method is provided for those applications that do not, for whatever reason, want to use a CoCreateInstance type of call to create a texture writer. This method simply creates an ISkpTextureWriter and returns it.

Return values:
pWriter The newly created ISkpTextureWriter
Returns:
S_OK : if successful
E_POINTER : if pWriter == NULL

Property Documentation

ISkpDocument ISkpApplication::ActiveDocument [get]

[propget] Returns the current ISkpDocument.

Return values:
pVal The current ISkpDocument.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
BSTR ISkpApplication::Fullname [get]

[propget] Returns the full name of the application.

Return values:
pVal The full name (name plus path) of the application.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
BSTR ISkpApplication::Name [get]

[propget] Returns the name of the application.

Return values:
pVal The name of the application.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
BSTR ISkpApplication::StatusText [set]

Set the status line text.

If the current application has a status line (as in the SketchUp application case), this method will set the text on the status line. Otherwise, this is a no-op method.

Parameters:
str The string to use for the status line.
Returns:
S_OK : if successful
BSTR ISkpApplication::TypeName [get]

[propget] Returns the type name for this object.

Return values:
pVal "SketchUp.Application"
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
BSTR ISkpApplication::Version [get]

[propget] Returns the version of the application.

Return values:
pVal The version of the underlying SketchUp application. This is not necessarily the same thing as the version of the API.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL

©2010 Google - Google Home - About Google