dmIDocument Class Reference

Daim document interface. More...

#include <CCI_Document.h>

Inherits dmINotify.

Inherited by dmIImageInfo, and dmIManager.

List of all members.

Public Member Functions

bool SaveDocument (const char_t *path, dm_uint bReplace)
 Save the content of the document at location path.
bool OpenDocument (const char_t *path, dm_uint bReplace)
 Open a document.
bool CloseDocument ()
 Close the document.
bool Initialize ()
 Initialize the document.
bool GetSize (dm_uint &width, dm_uint &height)
 Return the size of the document content.
bool Draw (dm_uint flags)
 Ask the document to render its content.
bool Update ()
 Ask the document to update its content.
bool OnCommand (dm_uint cmd)
 Send a UI command to the document.
bool OnCmdUpdate (dm_uint cmd, dm_uint &enabled, dm_int &checked)
 Get the state of a UI command.
bool SetDisplay (dm_int left, dm_int top, dm_uint width, dm_uint height)
 Set the display size for the document.
bool SetGraphics (dmGraphics *new_gfx, dmGraphics **old_gfx=NULL)
 Assign a graphic object to the document.
bool GetProperties (dm_param key, cci_object *propertylist)
 Return the objects properties.
dm_bool ExecCommand (const char_t *command, const char_t *arg, cci_Object *param)
 Execute a command.
dm_bool IsCommandSupported (const char_t *command)
 Check if a command is supported.


Detailed Description

Daim document interface.

Base interface for all daim document object.


Member Function Documentation

bool dmIDocument::CloseDocument  )  [inline]
 

Close the document.

Clear document path and image.

bool dmIDocument::Draw dm_uint  flags  )  [inline]
 

Ask the document to render its content.

Parameters:
flags specify, what kind of rendering should be done. It could take one of the following values:
  • CCIV_Document_DrawNormal normal/foreground rendering
  • CCIV_Document_DrawBckgnd background rendering

bool dmIDocument::GetProperties dm_param  key,
cci_object *  propertylist
[inline]
 

Return the objects properties.

Note that propertylist must implemenent a valid dmIPropertyList interface.

bool dmIDocument::Initialize  )  [inline]
 

Initialize the document.

This method will ask the document to recompute its internal state.

bool dmIDocument::OpenDocument const char_t *  path,
dm_uint  bReplace
[inline]
 

Open a document.

If bReplace is false then only the content of the document is replaced, all others attributs (path etc.) are not modified.

bool dmIDocument::SaveDocument const char_t *  path,
dm_uint  bReplace
[inline]
 

Save the content of the document at location path.

If bReplace is false attributs (path etc.) are not modified.

bool dmIDocument::SetGraphics dmGraphics *  new_gfx,
dmGraphics **  old_gfx = NULL
[inline]
 

Assign a graphic object to the document.

See also:
dmIGraphics::SetDocument.

bool dmIDocument::Update  )  [inline]
 

Ask the document to update its content.

Usually, Daim documents will update automatically when needed, you should call this method only if you're sure that the document was unaware of a state change of its content.


Generated on Tue May 9 12:34:57 2006 for Daim Library Module Set by  doxygen 1.4.6-NO