KoDocument Class Reference
The KOffice document classThe KOffice document class. More...
#include <koDocument.h>
Collaboration diagram for KoDocument:

Public Types | |
enum | { SaveAsKOffice1dot1 = 1, SaveAsDirectoryStore = 2 } |
enum | InitDocFlags { InitDocAppStarting, InitDocFileNew, InitDocFileClose, InitDocEmbedded, InitDocEmpty } |
Signals | |
void | childChanged (KoDocumentChild *child) |
void | sigProgress (int value) |
void | sigStatusBarMessage (const QString &text) |
void | sigClearStatusBarMessage () |
void | sigBeginOperation () |
void | sigEndOperation () |
Public Member Functions | |
KoDocument (QWidget *parentWidget, const char *widgetName, QObject *parent, const char *name, bool singleViewMode=false) | |
virtual | ~KoDocument () |
bool | isSingleViewMode () const |
bool | isEmbedded () const |
virtual KAction * | action (const QDomElement &element) const |
virtual QDomDocument | domDocument () const |
virtual void | setManager (KParts::PartManager *manager) |
virtual bool | openURL (const KURL &url) |
bool | import (const KURL &url) |
bool | exp0rt (const KURL &url) |
virtual void | setReadWrite (bool readwrite=true) |
virtual QCString | nativeFormatMimeType () const |
QCString | nativeOasisMimeType () const |
bool | isNativeFormat (const QCString &mimetype) const |
virtual QStringList | extraNativeMimeTypes () const |
virtual int | supportedSpecialFormats () const |
QCString | mimeType () const |
void | setMimeType (const QCString &mimeType) |
void | setOutputMimeType (const QCString &mimeType, int specialOutputFlag=0) |
QCString | outputMimeType () const |
int | specialOutputFlag () const |
bool | confirmNonNativeSave (const bool exporting) const |
void | setConfirmNonNativeSave (const bool exporting, const bool on) |
void | setErrorMessage (const QString &errMsg) |
QString | errorMessage () const |
void | showSavingErrorDialog () |
void | showLoadingErrorDialog () |
KoView * | createView (QWidget *parent=0, const char *name=0) |
virtual void | addView (KoView *view) |
virtual void | removeView (KoView *view) |
const QPtrList< KoView > & | views () const |
int | viewCount () const |
virtual KParts::Part * | hitTest (QWidget *widget, const QPoint &globalPos) |
virtual KoDocument * | hitTest (const QPoint &pos, const QWMatrix &matrix=QWMatrix()) |
virtual void | paintEverything (QPainter &painter, const QRect &rect, bool transparent=false, KoView *view=0L, double zoomX=1.0, double zoomY=1.0) |
virtual QPixmap | generatePreview (const QSize &size) |
virtual void | paintChildren (QPainter &painter, const QRect &rect, KoView *view, double zoomX=1.0, double zoomY=1.0) |
virtual void | paintChild (KoDocumentChild *child, QPainter &painter, KoView *view, double zoomX=1.0, double zoomY=1.0) |
virtual void | paintContent (QPainter &painter, const QRect &rect, bool transparent=false, double zoomX=1.0, double zoomY=1.0)=0 |
bool | checkAutoSaveFile () |
virtual bool | initDoc (InitDocFlags flags, QWidget *parentWidget=0)=0 |
virtual void | setModified (bool _mod) |
virtual void | setTitleModified () |
virtual bool | isEmpty () const |
virtual void | setEmpty () |
virtual bool | loadFromStore (KoStore *store, const QString &url) |
virtual bool | loadOasisFromStore (KoStore *store) |
virtual bool | saveToStore (KoStore *store, const QString &path) |
virtual bool | loadXML (QIODevice *, const QDomDocument &doc)=0 |
virtual bool | loadOasis (const QDomDocument &doc, KoOasisStyles &oasisStyles, const QDomDocument &settings, KoStore *store)=0 |
virtual bool | saveOasis (KoStore *store, KoXmlWriter *manifestWriter)=0 |
virtual QDomDocument | saveXML () |
QDomDocument | createDomDocument (const QString &tagName, const QString &version) const |
virtual bool | saveToStream (QIODevice *dev) |
virtual bool | loadNativeFormat (const QString &file) |
virtual bool | saveNativeFormat (const QString &file) |
void | setAutoSave (int delay) |
bool | isAutosaving () const |
void | setCheckAutoSaveFile (bool b) |
void | setAutoErrorHandlingEnabled (bool b) |
bool | isAutoErrorHandlingEnabled () const |
const QPtrList< KoDocumentChild > & | children () const |
KoDocumentChild * | child (KoDocument *doc) |
KoDocumentInfo * | documentInfo () const |
void | setViewBuildDocument (KoView *view, const QDomDocument &doc) |
QDomDocument | viewBuildDocument (KoView *view) |
virtual void | addShell (KoMainWindow *shell) |
virtual void | removeShell (KoMainWindow *shell) |
const QPtrList< KoMainWindow > & | shells () const |
int | shellCount () const |
virtual DCOPObject * | dcopObject () |
QCString | dcopObjectId () const |
void | emitProgress (int value) |
bool | isInOperation () const |
virtual void | emitBeginOperation () |
virtual void | emitEndOperation () |
virtual bool | isStoredExtern () const |
KoPageLayout | pageLayout () const |
void | removeAutoSaveFiles () |
void | setBackupFile (bool _b) |
bool | backupFile () const |
bool | isModified () const |
bool | isLoading () const |
int | queryCloseExternalChildren () |
int | queryCloseDia () |
void | setDoNotSaveExtDoc (bool on=true) |
void | setBackupPath (const QString &_path) |
QString | backupPath () const |
void | setCurrent (bool on=true) |
void | forceCurrent (bool on) |
bool | isCurrent () const |
void | setTitleModified (const QString caption, bool mod) |
void | resetURL () |
void | setStoreInternal (bool i) |
bool | storeInternal () const |
bool | hasExternURL () const |
void | setURL (const KURL &url) |
QString & | file () |
void | setFile (const QString &file) |
void | setMimeTypeAfterLoading (const QString &mimeType) |
Static Public Member Functions | |
static QCString | readNativeFormatMimeType (KInstance *instance=0) |
static QStringList | readExtraNativeMimeTypes (KInstance *instance=0) |
static void | setupXmlReader (QXmlSimpleReader &reader, bool namespaceProcessing=false) |
static KoXmlWriter * | createOasisXmlWriter (QIODevice *dev, const char *rootElementName) |
static QDomDocument | createDomDocument (const QString &appName, const QString &tagName, const QString &version) |
static int | defaultAutoSave () |
static QPtrList< KoDocument > * | documentList () |
Protected Member Functions | |
QString | autoSaveFile (const QString &path) const |
virtual KoView * | createViewInstance (QWidget *parent, const char *name)=0 |
virtual bool | openFile () |
virtual bool | saveFile () |
bool | isImporting () const |
bool | isExporting () const |
virtual bool | loadChildren (KoStore *) |
virtual bool | saveChildren (KoStore *store) |
virtual bool | saveChildrenOasis (KoStore *store, KoXmlWriter *manifestWriter) |
virtual bool | completeLoading (KoStore *store) |
virtual bool | completeSaving (KoStore *store) |
virtual void | insertChild (KoDocumentChild *child) |
virtual void | setModified () |
virtual void | insertChild (QObject *o) |
virtual bool | saveExternalChildren () |
Protected Attributes | |
KoPageLayout | m_pageLayout |
Properties | |
QCString | dcopObjectId |
bool | backupFile |
Detailed Description
The KOffice document classThe KOffice document class.This class provides some functionality each KOffice document should have.
Definition at line 58 of file koDocument.h.
Member Enumeration Documentation
|
Enum values used by specialOutputFlag - note that it's a bitfield for supportedSpecialFormats.
Definition at line 226 of file koDocument.h. |
|
This setting indicates who is calling initDoc. Usually the app will want to
Definition at line 434 of file koDocument.h. |
Constructor & Destructor Documentation
|
Constructor. The first 4 arguments are the same as the ones passed to KParts::Factory::createPart.
Definition at line 210 of file koDocument.cc. References KoPageLayout::ptBottom, KoPageLayout::ptHeight, KoPageLayout::ptLeft, KoPageLayout::ptRight, KoPageLayout::ptTop, KoPageLayout::ptWidth, and setAutoSave(). |
|
Destructor. The destructor does not delete any attached KoView objects and it does not delete the attached widget as returned by widget. Definition at line 255 of file koDocument.cc. |
Member Function Documentation
|
Tells whether this document is in singleview mode. This mode can only be set in the constructor. Definition at line 287 of file koDocument.cc. Referenced by insertChild(). |
|
Is the document embedded?
Definition at line 292 of file koDocument.cc. Referenced by setAutoSave(). |
|
Returns the action described action object. In fact only the "name" attribute of element is of interest here. The method searches first in the KActionCollection of the first view and then in the KActionCollection of this document. This allows KOffice applications to define actions in both the view and the document. They should only define view-actions (like zooming and stuff) in the view. Every action which changes the document should be defined in the document. Please notice that KoDocument indirectly inherits KXMLGUIClient.
Definition at line 532 of file koDocument.cc. |
|
Returns the DOM document which describes the GUI of the first view.
Definition at line 547 of file koDocument.cc. |
|
Reimplemented from KParts::ReadWritePart for internal reasons (for the autosave functionality).
Definition at line 1313 of file koDocument.cc. References file(), and resetURL(). Referenced by checkAutoSaveFile(), and import(). |
|
Opens the document given by Call this instead of openURL() to implement KoMainWindow's File --> Import feature.
Definition at line 1289 of file koDocument.cc. References openURL(), resetURL(), and setTitleModified(). |
|
Saves the document as ). Call this instead of KParts::ReadWritePart::saveAs() to implement KoMainWindow's File --> Export feature.
Definition at line 304 of file koDocument.cc. References isModified(), mimeType(), and setModified(). Referenced by KoMainWindow::saveDocument(). |
|
Sets whether the document can be edited or is read only. This recursively applied to all child documents and KoView::updateReadWrite is called for every attached view. Definition at line 573 of file koDocument.cc. References setAutoSave(). |
|
Used by KoApplication, and by KoMainWindow, when no document exists yet.
With the help of
Definition at line 2135 of file koDocument.cc. Referenced by KoTemplateChooseDia::choose(), KoMainWindow::createDoc(), KoMainWindow::slotFileOpen(), and KoApplication::start(). |
|
Used by KoMainWindow, when no document exists yet.
With the help of
Definition at line 2156 of file koDocument.cc. Referenced by KoTemplateChooseDia::choose(), and KoMainWindow::slotFileOpen(). |
|
setup the XML reader, so that we don't have to duplicate the code.
Definition at line 2164 of file koDocument.cc. Referenced by KoOasisStore::loadAndParse(). |
|
To be preferred when a document exists. It is fast when calling it multiple times since it caches the result that readNativeFormatMimeType delivers. This comes from the X-KDE-NativeMimeType key in the .desktop file You do NOT have to reimplement this (it is only virtual for kounavail). Definition at line 2093 of file koDocument.cc. Referenced by KoFilterManager::exp0rt(), KoFilterManager::import(), isNativeFormat(), openFile(), saveChildrenOasis(), KoMainWindow::saveDocument(), saveFile(), and saveNativeFormat(). |
|
Returns the OASIS OpenDocument mimetype of the document, if supported This comes from the X-KDE-NativeOasisMimeType key in the .desktop file.
Definition at line 2101 of file koDocument.cc. Referenced by saveChildrenOasis(), and saveNativeFormat(). |
|
Checks whether a given mimetype can be handled natively.
Definition at line 2180 of file koDocument.cc. References extraNativeMimeTypes(), and nativeFormatMimeType(). Referenced by openFile(), KoMainWindow::saveDocument(), and saveFile(). |
|
Returns a list of the mimetypes considered "native", i.e. which can be saved by KoDocument without a filter, in *addition* to the main one Definition at line 2187 of file koDocument.cc. Referenced by KoFilterManager::import(), isNativeFormat(), and KoMainWindow::saveDocument(). |
|
Return the set of SupportedSpecialFormats that the application wants to offer in the "Save" file dialog.
Definition at line 2199 of file koDocument.cc. Referenced by KoMainWindow::saveDocument(). |
|
Returns the actual mimetype of the document.
Definition at line 448 of file koDocument.cc. Referenced by exp0rt(), KoMainWindow::saveDocument(), and saveNativeFormat(). |
|
Sets the mime type for the document. When choosing "save as" this is also the mime type selected by default. Definition at line 453 of file koDocument.cc. |
|
Set the format in which the document should be saved. This is called on loading, and in "save as", so you shouldn't have to call it.
Definition at line 458 of file koDocument.cc. Referenced by KoMainWindow::saveDocument(). |
|
Returns true if this document was the result of opening a foreign file format and if the user hasn't yet saved the document (in any format). Used by KoMainWindow to warn the user when s/he lazily presses CTRL+S to save in the same foreign format, putting all his/her formatting at risk (normally an export confirmation only comes up with Save As).
Definition at line 474 of file koDocument.cc. Referenced by KoMainWindow::saveDocument(). |
|
Sets the error message to be shown to the user (use i18n()!) when loading or saving fails. If you asked the user about something and he chose "Cancel", set the message to the magic string "USER_CANCELED", to skip the error dialog. Definition at line 2243 of file koDocument.cc. |
|
Return the last error message. Usually KoDocument takes care of showing it; this method is mostly provided for non-interactive use.
Definition at line 2248 of file koDocument.cc. |
|
Show the last error message in a message box. The dialog box will mention a saving problem. Note that save/saveFile takes care of doing it.
Definition at line 2253 of file koDocument.cc. Referenced by saveFile(). |
|
Show the last error message in a message box. The dialog box will mention a loading problem. openURL/openFile takes care of doing it, but not loadNativeFormat itself, so this is often called after loadNativeFormat returned false.
Definition at line 2265 of file koDocument.cc. Referenced by openFile(). |
|
Create a new view for the document.
Definition at line 297 of file koDocument.cc. References addView(). Referenced by openFile(). |
|
Adds a view to the document. This calls KoView::updateReadWrite to tell the new view whether the document is readonly or not. Definition at line 598 of file koDocument.cc. Referenced by createView(). |
|
Removes a view of the document.
Definition at line 607 of file koDocument.cc. Referenced by openFile(). |
|
Definition at line 612 of file koDocument.cc. |
|
Definition at line 617 of file koDocument.cc. |
|
Reimplemented from KParts::Part.
Definition at line 664 of file koDocument.cc. |
|
Find the most nested child document which contains the requested point. The point is in the coordinate system of this part. If no child document contains this point, then a pointer to this document is returned. This function has to be overloaded if the document features child documents.
Definition at line 682 of file koDocument.cc. |
|
Paints the whole document into the given painter object.
Definition at line 743 of file koDocument.cc. References paintChildren(), and paintContent(). Referenced by generatePreview(). |
|
Generates a preview picture of the document.
Definition at line 1189 of file koDocument.cc. References paintEverything(), KoPageLayout::ptHeight, and KoPageLayout::ptWidth. |
|
Paints all of the documents children into the given painter object.
Definition at line 749 of file koDocument.cc. References paintChild(). Referenced by paintEverything(). |
|
Paint a given child. Normally called by paintChildren.
Definition at line 761 of file koDocument.cc. References KoChild::contentRect(), KoDocumentChild::document(), KoDocumentChild::isDeleted(), KoChild::isTransparent(), KoView::koDocument(), KoView::partManager(), KoChild::transform(), KoChild::xScaling(), and KoChild::yScaling(). Referenced by paintChildren(). |
|
Paints the data itself. Normally called by paintEverthing. It does not paint the children. It's this method that KOffice Parts have to implement.
Referenced by paintEverything(). |
|
Called by koApplication to check for an autosave file in $HOME.
Definition at line 1259 of file koDocument.cc. References openURL(), and resetURL(). Referenced by KoMainWindow::openDocument(). |
|
Initializes an empty document (display the template dialog!). You have to overload this method to initialize all your document variables.
Referenced by KoMainWindow::openDocument(). |
|
Sets the modified flag on the document. This means that it has to be saved or not before deleting it. Definition at line 1847 of file koDocument.cc. References children(), isAutosaving(), isModified(), setAutoSave(), setModified(), and setTitleModified(). Referenced by exp0rt(), insertChild(), saveChildren(), saveChildrenOasis(), KoMainWindow::saveDocument(), saveFile(), and setModified(). |
|
Tells the document that its title has been modified, either because the modified status changes (this is done by setModified) or because the URL or the document-info's title changed.
Definition at line 1974 of file koDocument.cc. References documentInfo(), isEmpty(), isModified(), isStoredExtern(), and setTitleModified(). Referenced by import(), KoMainWindow::saveDocument(), setCurrent(), setModified(), setTitleModified(), and KoApplication::start(). |
|
Definition at line 459 of file koDocument.h. Referenced by KoMainWindow::chooseNewDocument(), setTitleModified(), and KoMainWindow::slotReloadFile(). |
|
Sets the document to empty. Used after loading a template (which is not empty, but not the user's input).
Definition at line 469 of file koDocument.h. Referenced by KoApplication::start(). |
|
Loads a document from a store. You should never have to reimplement.
Definition at line 1741 of file koDocument.cc. References KoStore::close(), completeLoading(), KoStore::device(), KoStore::enterDirectory(), loadChildren(), loadXML(), KoStore::open(), KoStore::popDirectory(), and KoStore::pushDirectory(). |
|
Loads an OASIS document from a store. This is used for both the main document and embedded objects. Definition at line 1782 of file koDocument.cc. References KoOasisStyles::createStyleMap(), KoStore::hasFile(), KoOasisStore::loadAndParse(), and loadOasis(). |
|
Saves a document to a store. You should not have to reimplement this - but call it in saveChildren. Definition at line 1113 of file koDocument.cc. References completeSaving(), KoStore::enterDirectory(), KoStore::open(), KoStore::popDirectory(), KoStore::pushDirectory(), saveChildren(), and saveToStream(). Referenced by saveChildren(). |
|
Reimplement this method to load the contents of your KOffice document, from the XML document. This is for the pre-Oasis file format (maindoc.xml). You are supposed to use the QDomDocument. The QIODevice is provided only for the cases where some pre-processing is needed, like kpresenter's kprconverter. Note that the QIODevice could be 0L, when called from an import filter. Referenced by loadFromStore(), and loadNativeFormat(). |
|
Reimplement this method to load the contents of your KOffice document, from the XML document ("content.xml"). The styles have been parsed already, you can find them in the oasisStyles parameter. The store can be used to load images and embedded documents. Referenced by loadOasisFromStore(). |
|
Reimplement this method to save the contents of your KOffice document, using the OASIS format.
Referenced by saveNativeFormat(). |
|
Reimplement this to save the contents of the KOffice document into a QDomDocument. The framework takes care of saving it to the store. Definition at line 2078 of file koDocument.cc. Referenced by saveToStream(). |
|
Return a correctly created QDomDocument for this KoDocument, including processing instruction, complete DOCTYPE tag (with systemId and publicId), and root element.
Definition at line 2026 of file koDocument.cc. Referenced by Document::createDomDocument(). |
|
Return an XML writer for saving Oasis XML into the device You can add more namespaces afterwards with addAttribute.
Definition at line 2046 of file koDocument.cc. References KoXmlWriter::addAttribute(), KoXmlWriter::startDocument(), and KoXmlWriter::startElement(). Referenced by KoOasisStore::contentWriter(). |
|
Return a correctly created QDomDocument for an old (1.3-style) KOffice document, including processing instruction, complete DOCTYPE tag (with systemId and publicId), and root element. This static method can be used e.g. by filters.
Definition at line 2032 of file koDocument.cc. |
|
Save the document. The default implementation is to call saveXML. This method exists only for applications that don't use QDomDocument for saving, i.e. kword and kpresenter. Definition at line 1099 of file koDocument.cc. References saveXML(). Referenced by saveNativeFormat(), and saveToStore(). |
|
Loads a document in the native format from a given URL. Reimplement if your native format isn't XML.
Definition at line 1572 of file koDocument.cc. References completeLoading(), and loadXML(). Referenced by openFile(). |
|
Saves the document in native format, to a given file You should never have to reimplement. Made public for writing templates. Definition at line 941 of file koDocument.cc. References KoXmlWriter::addManifestEntry(), KoStore::bad(), KoStore::close(), KoOasisStore::closeManifestWriter(), completeSaving(), KoStore::createStore(), KoStore::disallowNameExpansion(), KoOasisStore::manifestWriter(), mimeType(), nativeFormatMimeType(), nativeOasisMimeType(), KoStore::open(), saveChildren(), saveChildrenOasis(), saveExternalChildren(), saveOasis(), saveToStream(), and KoStoreDevice::writeBlock(). Referenced by saveFile(). |
|
Activate/deactivate/configure the autosave feature.
Definition at line 589 of file koDocument.cc. References isEmbedded(). Referenced by KoDocument(), saveFile(), setModified(), and setReadWrite(). |
|
Checks whether the document is currently in the process of autosaving.
Definition at line 2277 of file koDocument.cc. Referenced by setModified(). |
|
Set whether the next openURL call should check for an auto-saved file and offer to open it. This is usually true, but can be turned off (e.g. for the preview module). Definition at line 496 of file koDocument.cc. |
|
Set whether the next openURL call should show error message boxes in case of errors. This is usually the case, but e.g. not when generating thumbnail previews. Definition at line 501 of file koDocument.cc. |
|
Checks whether error message boxes should be shown.
Definition at line 506 of file koDocument.cc. Referenced by KoFilterManager::import(). |
|
Retrieve the default value for autosave in seconds. Called by the applications to use the correct default in their config Definition at line 618 of file koDocument.h. |
|
Definition at line 659 of file koDocument.cc. Referenced by isModified(), saveChildren(), saveChildrenOasis(), saveExternalChildren(), and setModified(). |
|
Definition at line 695 of file koDocument.cc. |
|
Definition at line 705 of file koDocument.cc. Referenced by setTitleModified(). |
|
Appends the shell to the list of shells which show this document as their root document. This method is automatically called from KoMainWindow::setRootDocument, so you dont need to call it. Definition at line 2206 of file koDocument.cc. |
|
Removes the shell from the list. That happens automatically if the shell changes its root document. Usually you dont need to call this method. Definition at line 2215 of file koDocument.cc. |
|
Definition at line 2221 of file koDocument.cc. Referenced by saveFile(). |
|
Definition at line 2226 of file koDocument.cc. |
|
Definition at line 672 of file koDocument.h. Referenced by KoMainWindow::chooseNewDocument(). |
|
Return a DCOP interface for this document. KOffice parts are strongly recommended to reimplement this method, so that their DCOP interface provides more functionality than the basic KoDocumentIface Definition at line 2231 of file koDocument.cc. |
|
|
|
Signal the progress of operations such as loading or saving.
Definition at line 690 of file koDocument.h. |
|
Return true if url() is a real filename, false if url() is an internal url in the store, like "tar:/. .." Definition at line 1842 of file koDocument.cc. References storeInternal(). Referenced by saveChildren(), saveChildrenOasis(), saveExternalChildren(), setCurrent(), and setTitleModified(). |
|
Definition at line 707 of file koDocument.h. |
|
Performs a cleanup of unneeded backup files.
Definition at line 2287 of file koDocument.cc. Referenced by saveFile(). |
|
Returns true if this document or any of its internal child documents are modified.
Definition at line 821 of file koDocument.cc. References children(), and isModified(). Referenced by exp0rt(), isModified(), saveExternalChildren(), saveFile(), setModified(), setTitleModified(), and KoMainWindow::slotReloadFile(). |
|
Returns true during loading (openURL can be asynchronous).
Definition at line 2282 of file koDocument.cc. |
|
Set when we do not want to save external children when saving our 'main' doc. This makes it possible to save 'main' doc + all its internal children first, then go on to save external children. Typically used by query close. Use: doc->setDoNotSaveExtDoc(); doc->save(); // saves doc and its internal children, //also calls saveExternalChildren() which sets setDoNotSaveExtDoc(false) doc->saveExternalChildren(); Definition at line 1883 of file koDocument.cc. Referenced by saveExternalChildren(). |
|
Sets the backup path of the document.
Definition at line 2309 of file koDocument.cc. |
|
Definition at line 2314 of file koDocument.cc. |
|
Indicates that this document is currently viewed and thus should control the title caption. Also resets current flag for all parents. Definition at line 2319 of file koDocument.cc. References forceCurrent(), isStoredExtern(), setCurrent(), and setTitleModified(). Referenced by setCurrent(). |
|
Sets current flag for this document and all its parents.
Definition at line 2346 of file koDocument.cc. References forceCurrent(). Referenced by forceCurrent(), and setCurrent(). |
|
Sets the document URL to empty URL KParts doesn't allow this, but KOffice apps have e.g. templates After using loadNativeFormat on a template, one wants to set the url to KURL() Definition at line 777 of file koDocument.h. Referenced by checkAutoSaveFile(), import(), openFile(), openURL(), KoMainWindow::saveDocument(), saveFile(), and KoApplication::start(). |
|
Set when you want an external embedded document to be stored internally.
Definition at line 2367 of file koDocument.cc. |
|
Definition at line 2362 of file koDocument.cc. Referenced by isStoredExtern(). |
|
Sets the document URL to
Definition at line 795 of file koDocument.h. Referenced by KoMainWindow::saveDocument(). |
|
_Only_ use these functions to restore m_file (in KoMainWindow) after a failed save (remember to use setURL() to restore the URL as well).
Definition at line 805 of file koDocument.h. Referenced by openURL(), and KoMainWindow::saveDocument(). |
|
_Only_ use these functions to restore m_file (in KoMainWindow) after a failed save (remember to use setURL() to restore the URL as well).
Definition at line 815 of file koDocument.h. Referenced by KoMainWindow::saveDocument(). |
|
This signal is emitted when a direct or indirect child document changes and needs to be updated in all views. If one of your child documents emits the childChanged signal, then you may usually just want to redraw this child. In this case you can ignore the parameter passed by the signal. |
|
Progress info while loading or saving. The value is in percents (i.e. a number between 0 and 100) Your KoDocument-derived class should emit the signal now and then during load/save. KoMainWindow will take care of displaying a progress bar automatically. |
|
Emitted e.g. at the beginning of a save operation This is emitted by KoDocument and used by KoView to display a statusbar message Referenced by saveFile(). |
|
Emitted e.g. at the end of a save operation This is emitted by KoDocument and used by KoView to clear the statusbar message Referenced by saveFile(). |
|
Loads a document from KReadOnlyPart::m_file (KParts takes care of downloading remote documents). Applies a filter if necessary, and calls loadNativeFormat in any case You should not have to reimplement, except for very special cases. This method is called from the KReadOnlyPart::openURL method. Definition at line 1372 of file koDocument.cc. References createView(), isNativeFormat(), loadNativeFormat(), nativeFormatMimeType(), removeView(), resetURL(), and showLoadingErrorDialog(). |
|
Saves a document to KReadOnlyPart::m_file (KParts takes care of uploading remote documents) Applies a filter if necessary, and calls saveNativeFormat in any case You should not have to reimplement, except for very special cases.
Definition at line 354 of file koDocument.cc. References isExporting(), isModified(), isNativeFormat(), nativeFormatMimeType(), removeAutoSaveFiles(), resetURL(), saveNativeFormat(), setAutoSave(), setModified(), shells(), showSavingErrorDialog(), sigClearStatusBarMessage(), and sigStatusBarMessage(). |
|
Returns whether or not the current openURL() or openFile() call is actually an import operation (like File --> Import). This is for informational purposes only. Definition at line 486 of file koDocument.cc. |
|
Returns whether or not the current saveFile() call is actually an export operation (like File --> Export). If this function returns true during saveFile() and you are changing some sort of state, you _must_ restore it before the end of saveFile(); otherwise, File --> Export will not work properly. Definition at line 491 of file koDocument.cc. Referenced by saveChildren(), saveChildrenOasis(), and saveFile(). |
|
OLD XML method. For OASIS just call KoDocumentChild::loadOasisDocument after KoDocumentChild::loadOasis. You need to overload this function if your document may contain embedded documents. This function is called to load embedded documents. An example implementation may look like this: QPtrListIterator<KoDocumentChild> it( children() ); for( ; it.current(); ++it ) { if ( !it.current()->loadDocument( _store ) ) { return false; } } return true; Definition at line 2011 of file koDocument.cc. Referenced by loadFromStore(). |
|
Saves all internal children (only!).
Definition at line 839 of file koDocument.cc. References children(), isExporting(), isStoredExtern(), saveToStore(), and setModified(). Referenced by saveNativeFormat(), and saveToStore(). |
|
Saves all internal children (only!), to the store, using the OASIS format. This is called automatically during saveNativeFormat.
Definition at line 865 of file koDocument.cc. References KoXmlWriter::addManifestEntry(), children(), isExporting(), isStoredExtern(), nativeFormatMimeType(), nativeOasisMimeType(), and setModified(). Referenced by saveNativeFormat(). |
|
Overload this function if you have to load additional files from a store. This function is called after loadXML and after loadChildren have been called. Definition at line 2016 of file koDocument.cc. Referenced by loadFromStore(), and loadNativeFormat(). |
|
If you want to write additional files to a store, then you must do it here. In the implementation, you should prepend the document url (using url().url()) before the filename, so that everything is kept relative to this document. For instance it will produce urls such as tar:/1/pictures/picture0.png, if the doc url is tar:/1 But do this ONLY if the document is not stored extern (see isStoredExtern). If it is, then the pictures should be saved to tar:/pictures. Definition at line 2021 of file koDocument.cc. Referenced by saveNativeFormat(), and saveToStore(). |
|
Inserts the new child in the list of children and emits the childChanged signal. At the same time this method marks this document as modified. To remove a child, just delete it. KoDocument will detect this and remove the child from its lists.
Definition at line 622 of file koDocument.cc. References isSingleViewMode(), and setModified(). |
|
Saves all externally stored children. Returns true on success.
Definition at line 907 of file koDocument.cc. References children(), KoDocumentChild::document(), KoDocumentChild::isDeleted(), isModified(), isStoredExtern(), saveExternalChildren(), and setDoNotSaveExtDoc(). Referenced by saveExternalChildren(), and saveNativeFormat(). |
The documentation for this class was generated from the following files: