lib Library API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

KoDocumentIface Class Reference

DCOP interface for any KOffice document Use KoApplicationIface to get hold of an existing document's interface, or to create a document. More...

#include <KoDocumentIface.h>

Collaboration diagram for KoDocumentIface:

Collaboration graph
[legend]
List of all members.

DCOP Member Functions

QString url ()
void openURL (QString url)
bool isLoading ()
bool isModified ()
int viewCount ()
DCOPRef view (int idx)
DCOPRef action (const QCString &name)
QCStringList actions ()
QMap< QCString, DCOPRef > actionMap ()
void save ()
void saveAs (const QString &url)
void setOutputMimeType (const QCString &mimetype)
QString documentInfoAuthorName () const
QString documentInfoEmail () const
QString documentInfoCompanyName () const
QString documentInfoTitle () const
QString documentInfoAbstract () const
QString documentInfoKeywords () const
QString documentInfoSubject () const
QString documentInfoTelephone () const
QString documentInfoTelephoneWork () const
QString documentInfoTelephoneHome () const
QString documentInfoFax () const
QString documentInfoCountry () const
QString documentInfoPostalCode () const
QString documentInfoCity () const
QString documentInfoStreet () const
QString documentInfoInitial () const
QString documentInfoAuthorPostion () const
void setDocumentInfoAuthorName (const QString &text)
void setDocumentInfoEmail (const QString &text)
void setDocumentInfoCompanyName (const QString &text)
void setDocumentInfoTelephone (const QString &text)
void setDocumentInfoTelephoneWork (const QString &text)
void setDocumentInfoTelephoneHome (const QString &text)
void setDocumentInfoFax (const QString &text)
void setDocumentInfoCountry (const QString &text)
void setDocumentInfoTitle (const QString &text)
void setDocumentInfoPostalCode (const QString &text)
void setDocumentInfoCity (const QString &text)
void setDocumentInfoStreet (const QString &text)
void setDocumentInfoAbstract (const QString &text)
void setDocumentInfoInitial (const QString &text)
void setDocumentInfoKeywords (const QString &text)
void setDocumentInfoSubject (const QString &text)
void setDocumentInfoAuthorPosition (const QString &text)

Public Member Functions

 KoDocumentIface (KoDocument *doc, const char *name=0)
virtual QCStringList functionsDynamic ()
virtual bool processDynamic (const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData)

Static Public Member Functions

static QCString newIfaceName ()

Protected Attributes

KoDocument * m_pDoc
KDCOPActionProxy * m_actionProxy

Detailed Description

DCOP interface for any KOffice document Use KoApplicationIface to get hold of an existing document's interface, or to create a document.

Note: KOffice Applications may (and should) reimplement KoDocument::dcopObject() In this case, don't look here... (unless the DCOP interface for the document inherits KoDocumentIface, which is a good thing to do)

Definition at line 39 of file KoDocumentIface.h.

Member Function Documentation

QCString KoDocumentIface::newIfaceName (   )  [static]
 

Generate a name for this interface.

Automatically used if name=0 is passed to the constructor

Definition at line 33 of file KoDocumentIface.cc.

QString KoDocumentIface::url (   ) 
 

Returns the URL for this document (empty, real URL, or internal one).

Definition at line 62 of file KoDocumentIface.cc.

void KoDocumentIface::openURL (  QString  url  ) 
 

Opens a document stored in url Warning: this is asynchronous.

The document might not be loaded yet when this call returns. See isLoading.

Definition at line 52 of file KoDocumentIface.cc.

bool KoDocumentIface::isLoading (   ) 
 

Returns:
TRUE is the document is still loading

Definition at line 57 of file KoDocumentIface.cc.

bool KoDocumentIface::isModified (   ) 
 

Returns:
TRUE is the document has been modified

Definition at line 67 of file KoDocumentIface.cc.

int KoDocumentIface::viewCount (   ) 
 

Returns:
the number of views this document is displayed in

Definition at line 72 of file KoDocumentIface.cc.

DCOPRef KoDocumentIface::view (  int  idx  ) 
 

Returns:
a DCOP reference (DCOPRef) to the view with index idx

Definition at line 77 of file KoDocumentIface.cc.

DCOPRef KoDocumentIface::action (  const QCString &  name  ) 
 

DCOP-action proxy.

Definition at line 92 of file KoDocumentIface.cc.

QCStringList KoDocumentIface::actions (   ) 
 

Returns:
list of actions

Definition at line 97 of file KoDocumentIface.cc.

QMap< QCString, DCOPRef > KoDocumentIface::actionMap (   ) 
 

Returns:
a map of (action name, DCOP reference)

Definition at line 109 of file KoDocumentIface.cc.

void KoDocumentIface::save (   ) 
 

Saves the document under its existing filename.

Definition at line 114 of file KoDocumentIface.cc.

void KoDocumentIface::saveAs (  const QString &  url  ) 
 

Saves the document under a new name.

Definition at line 119 of file KoDocumentIface.cc.

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for lib Library Version 1.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Feb 13 09:40:52 2006 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003