• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeedu API Reference
  • KDE Home
  • Contact Us
 

rocs/RocsCore

Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
DocumentManager Class Reference

#include <DocumentManager.h>

Inheritance diagram for DocumentManager:
Inheritance graph
[legend]

Public Slots

void addDocument (Document *document)
 
void changeDocument (Document *document)
 
void changeDocument (int index)
 
void changeDocument ()
 
void closeAllDocuments ()
 
void convertToDataStructure ()
 
void exportDocument (Document *document, const KUrl &documentUrl)
 
Document * newDocument ()
 
Document * openDocument (const KUrl &documentUrl)
 
void removeDocument (Document *document)
 
void saveDocumentAs (Document *document, const KUrl &documentUrl)
 

Signals

void activateDocument ()
 
void deactivateDocument (Document *document)
 
void documentListChanged ()
 
void documentRemoved (Document *document)
 

Public Member Functions

virtual ~DocumentManager ()
 
Document * activeDocument () const
 
Document * document (int index) const
 
QList< Document * > documentList () const
 
QSvgRenderer * registerSharedRenderer (const QString &iconPackage)
 
void removeSharedRenderer (const QString &iconPackage)
 
QSvgRenderer * sharedRenderer (const QString &iconPackage)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Static Public Member Functions

static DocumentManager & self ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 35 of file DocumentManager.h.

Constructor & Destructor Documentation

DocumentManager::~DocumentManager ( )
virtual

Definition at line 76 of file DocumentManager.cpp.

Member Function Documentation

void DocumentManager::activateDocument ( )
signal

Signal is emitted if the currently active document changes.

Document * DocumentManager::activeDocument ( ) const

Returns the currently active document, or 0 if there document list is empty.

Returns
currently active document

Definition at line 96 of file DocumentManager.cpp.

void DocumentManager::addDocument ( Document *  document)
slot

Add document to document list and set this document as active document.

Parameters
documentthat shall be added to document list

Definition at line 106 of file DocumentManager.cpp.

void DocumentManager::changeDocument ( Document *  document)
slot

Change active document to be document.

Parameters
documentis the document to be set active.

Definition at line 143 of file DocumentManager.cpp.

void DocumentManager::changeDocument ( int  index)
slot

Change to document with given index.

Parameters
indexis expected to be a valid index

Definition at line 119 of file DocumentManager.cpp.

void DocumentManager::changeDocument ( )
slot

Definition at line 130 of file DocumentManager.cpp.

void DocumentManager::closeAllDocuments ( )
slot

Close all documents from document list.

This method does not write data to document files.

Definition at line 165 of file DocumentManager.cpp.

void DocumentManager::convertToDataStructure ( )
slot

Convert document to new data structure.

Definition at line 196 of file DocumentManager.cpp.

void DocumentManager::deactivateDocument ( Document *  document)
signal

Signal is emitted if the currently active document is deactivated.

(This can be caused by a removal or a change.)

Document * DocumentManager::document ( int  index) const

Returns document with index i in document list.

Note that index can change due to various operations. Signal

See also
documentListChanged() is emitted if this happens.
Parameters
indexof document in document list
Returns
the document

Definition at line 91 of file DocumentManager.cpp.

QList< Document * > DocumentManager::documentList ( ) const

Returns the document list of the document manager.

Position of document in this list is temporary document index. List order can change by

See also
removeDocument().
Returns
list with documents

Definition at line 101 of file DocumentManager.cpp.

void DocumentManager::documentListChanged ( )
signal

Signal is emitted if the document list changes and older document index values get invalid.

void DocumentManager::documentRemoved ( Document *  document)
signal

Signal is emitted if document was removed from list.

If document is the active document, both, deactivateDocument() and activeDocument() were called before this signal.

void DocumentManager::exportDocument ( Document *  document,
const KUrl &  documentUrl 
)
slot

Save graph document document at url documentUrl.

The document is not changed by this operation.

Parameters
documentis the graph document to be save
documentUrlis the target file for saving

Definition at line 271 of file DocumentManager.cpp.

Document * DocumentManager::newDocument ( )
slot

Creates and loads a new graph document.

Returns
created document

Definition at line 215 of file DocumentManager.cpp.

Document * DocumentManager::openDocument ( const KUrl &  documentUrl)
slot

Loads graph document specified by documentUrl and adds document to document list.

Sets loaded document as active document.

Parameters
documentUrlis Url specifying the to be opened document
Returns
loaded document

Definition at line 245 of file DocumentManager.cpp.

QSvgRenderer * DocumentManager::registerSharedRenderer ( const QString &  iconPackage)

Definition at line 293 of file DocumentManager.cpp.

void DocumentManager::removeDocument ( Document *  document)
slot

Remove document from document list.

If the document is currently active, then the last document from document list becomes active. If document list contains only this document, a new (empty) document is created. This method does not write data to document files.

Parameters
documentthat shall be removed

Definition at line 173 of file DocumentManager.cpp.

void DocumentManager::removeSharedRenderer ( const QString &  iconPackage)

Definition at line 303 of file DocumentManager.cpp.

void DocumentManager::saveDocumentAs ( Document *  document,
const KUrl &  documentUrl 
)
slot

Save graph document document at url documentUrl.

The internal file url for the document is reset with documentUrl and the modification state is set to false. To save document without changing its properties

See also
exportDocument(...).
Parameters
documentis the graph document to be save
documentUrlis the target file for saving

Definition at line 263 of file DocumentManager.cpp.

DocumentManager & DocumentManager::self ( )
static

Definition at line 57 of file DocumentManager.cpp.

QSvgRenderer * DocumentManager::sharedRenderer ( const QString &  iconPackage)

Definition at line 284 of file DocumentManager.cpp.


The documentation for this class was generated from the following files:
  • DocumentManager.h
  • DocumentManager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:16:18 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

rocs/RocsCore

Skip menu "rocs/RocsCore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdeedu API Reference

Skip menu "kdeedu API Reference"
  • Analitza
  •     lib
  • kalgebra
  • kalzium
  •   libscience
  • kanagram
  • kig
  •   lib
  • klettres
  • marble
  • parley
  • rocs
  •   App
  •   RocsCore
  •   VisualEditor
  •   stepcore

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal