The document class. A document controls which UI is active for this particular model, which views are available, and undo transaction handling.
More...
#include <idocument.h>
List of all members.
Detailed Description
The document class. A document controls which UI is active for this particular model, which views are available, and undo transaction handling.
Member Function Documentation
virtual void atlast::sketchup::ISketchUpDocument::DisableUndo |
( |
bool |
disable |
) |
[pure virtual] |
Enable or disable Undo handling.
See the Undo management discussion in UNDO.
- Parameters:
-
| disable | If true, undo handling is disabled. Otherwise it is enabled. |
virtual ISketchUpViewPtr atlast::sketchup::ISketchUpDocument::GetActiveView |
( |
|
) |
const [pure virtual] |
Retrieves the active view.
- Returns:
- The active View. Note that this may be NULL if the current application doesn't support views.
Get the Angle Formatter.
- Returns:
- The Angle formatter using this document's options.
Retrieves the controller associated with the current document.
- Returns:
- The controller object.
Retrieves the current selection set.
- Returns:
- The current selection set.
Get the Length Formatter.
- Returns:
- The Length formatter using this document's options.
virtual ISketchUpModelPtr atlast::sketchup::ISketchUpDocument::GetModel |
( |
|
) |
const [pure virtual] |
Get the Model held by this Document.
- Returns:
- The model held by this document.
virtual void atlast::sketchup::ISketchUpDocument::SaveFile |
( |
LPCWSTR |
fileName, |
|
|
SketchUpFileVersion |
version = MostRecent | |
|
) |
| | [pure virtual] |
Save the current document to a file at the given filename.
- Parameters:
-
| fileName | The name of the file. |
| version | The SketchUp file version. |
virtual void atlast::sketchup::ISketchUpDocument::SelectTool |
( |
sketchup::ISketchUpTool * |
pTool |
) |
[pure virtual] |
Selects the given tool to be active. Note that this will do nothing if the current application does not support tools.
- Parameters:
-
| pTool | The tool to make active. |
virtual void atlast::sketchup::ISketchUpDocument::SetStatusText |
( |
LPCWSTR |
text, |
|
|
unsigned int |
paneNumber = 0 | |
|
) |
| | [pure virtual] |
Writes text to the status bar of the application.
This method is a no-op in the case that the application does not have a status bar.
- Parameters:
-
| text | The text to write. |
| paneNumber | The number of the pane. |
virtual void atlast::sketchup::ISketchUpDocument::StartTransaction |
( |
LPCWSTR |
transactionName |
) |
[pure virtual] |
Start an undo transation with the given name. See the Undo management discussion in UNDO.
- Parameters:
-
| transactionName | The name of the transaction. |