libs/kotext

KoTextDocument Class Reference

KoTextDocument provides an easy mechanism to set and access the editing members of a QTextDocument. More...

#include <KoTextDocument.h>

List of all members.

Public Types

enum  ResourceType {
  StyleManager = QTextDocument::UserResource, Lists, InlineTextManager, ChangeTrackerResource,
  UndoStack, TextEditor
}

Public Member Functions

 KoTextDocument (const QTextDocument *document)
 KoTextDocument (QTextDocument *document)
 ~KoTextDocument ()
void addList (KoList *list)
KoChangeTracker * changeTracker () const
void clearText ()
QTextDocument * document () const
KoInlineTextObjectManager * inlineTextObjectManager () const
KoList * list (QTextList *textList) const
KoList * list (const QTextBlock &block) const
QList< KoList * > lists () const
void removeList (KoList *list)
void setChangeTracker (KoChangeTracker *changeTracker)
void setInlineTextObjectManager (KoInlineTextObjectManager *manager)
void setLists (const QList< KoList * > &lists)
void setStyleManager (KoStyleManager *styleManager)
void setTextEditor (KoTextEditor *textEditor)
void setUndoStack (KoUndoStack *undoStack)
KoStyleManager * styleManager () const
KoTextEditor * textEditor ()
KoUndoStack * undoStack () const

Static Public Attributes

static const QUrl ChangeTrackerURL = QUrl("kotext://changetracker")
static const QUrl InlineObjectTextManagerURL = QUrl("kotext://inlineObjectTextManager")
static const QUrl ListsURL = QUrl("kotext://lists")
static const QUrl StyleManagerURL = QUrl("kotext://stylemanager")
static const QUrl TextEditorURL = QUrl("kotext://textEditor")
static const QUrl UndoStackURL = QUrl("komain://undoStack")

Detailed Description

KoTextDocument provides an easy mechanism to set and access the editing members of a QTextDocument.

The meta data are stored as resources in the QTextDocument using QTextDocument::addResource() and fetched using QTextDocument::resource().

Definition at line 44 of file KoTextDocument.h.

Member Enumeration Documentation

enum KoTextDocument::ResourceType

Enum (type) used to add resources using QTextDocument::addResource().

Enumerator:
StyleManager 
Lists 
InlineTextManager 
ChangeTrackerResource 
UndoStack 
TextEditor 

Definition at line 113 of file KoTextDocument.h.

Constructor & Destructor Documentation

KoTextDocument::KoTextDocument ( QTextDocument *  document  ) 

Constructor.

Definition at line 45 of file KoTextDocument.cpp.

KoTextDocument::KoTextDocument ( const QTextDocument *  document  ) 

Constructor.

Definition at line 51 of file KoTextDocument.cpp.

KoTextDocument::~KoTextDocument (  ) 

Destructor.

Definition at line 57 of file KoTextDocument.cpp.

Member Function Documentation

void KoTextDocument::addList ( KoList *  list  ) 

Adds a list to the document.

Definition at line 145 of file KoTextDocument.cpp.

KoChangeTracker * KoTextDocument::changeTracker (  )  const

Returns the change tracker of the document.

Definition at line 112 of file KoTextDocument.cpp.

void KoTextDocument::clearText (  ) 

Clears the text in the document.

Unlike QTextDocument::clear(), this function does not clear the resources of the QTextDocument.

Definition at line 183 of file KoTextDocument.cpp.

QTextDocument * KoTextDocument::document (  )  const

Returns the document that was passed in the constructor.

Definition at line 61 of file KoTextDocument.cpp.

KoInlineTextObjectManager * KoTextDocument::inlineTextObjectManager (  )  const

Returns the KoInlineTextObjectManager.

Definition at line 190 of file KoTextDocument.cpp.

KoList * KoTextDocument::list ( QTextList *  textList  )  const

Returns the KoList that holds list.

Definition at line 173 of file KoTextDocument.cpp.

KoList * KoTextDocument::list ( const QTextBlock &  block  )  const

Returns the KoList that holds block; 0 if block is not part of any list.

Definition at line 165 of file KoTextDocument.cpp.

QList< KoList * > KoTextDocument::lists (  )  const

Returns the lists in the document.

Definition at line 139 of file KoTextDocument.cpp.

void KoTextDocument::removeList ( KoList *  list  ) 

Removes a list from the document.

Definition at line 156 of file KoTextDocument.cpp.

void KoTextDocument::setChangeTracker ( KoChangeTracker *  changeTracker  ) 

Sets the change tracker of the document.

Definition at line 105 of file KoTextDocument.cpp.

void KoTextDocument::setInlineTextObjectManager ( KoInlineTextObjectManager *  manager  ) 

Set the KoInlineTextObjectManager.

Definition at line 88 of file KoTextDocument.cpp.

void KoTextDocument::setLists ( const QList< KoList * > &  lists  ) 

Sets the lists of the document.

Definition at line 131 of file KoTextDocument.cpp.

void KoTextDocument::setStyleManager ( KoStyleManager *  styleManager  ) 

Sets the style manager that defines the named styles in the document.

Definition at line 79 of file KoTextDocument.cpp.

void KoTextDocument::setTextEditor ( KoTextEditor *  textEditor  ) 

Sets the text editor for the document.

Definition at line 66 of file KoTextDocument.cpp.

void KoTextDocument::setUndoStack ( KoUndoStack *  undoStack  ) 

Sets the global undo stack.

Definition at line 118 of file KoTextDocument.cpp.

KoStyleManager * KoTextDocument::styleManager (  )  const

Returns the style manager.

Definition at line 99 of file KoTextDocument.cpp.

KoTextEditor * KoTextDocument::textEditor (  ) 

Returns the text editor for that document.

Definition at line 73 of file KoTextDocument.cpp.

KoUndoStack * KoTextDocument::undoStack (  )  const

Returns the global undo stack.

Definition at line 125 of file KoTextDocument.cpp.

Member Data Documentation

const QUrl KoTextDocument::ChangeTrackerURL = QUrl("kotext://changetracker") [static]

Definition at line 124 of file KoTextDocument.h.

const QUrl KoTextDocument::InlineObjectTextManagerURL = QUrl("kotext://inlineObjectTextManager") [static]

Definition at line 123 of file KoTextDocument.h.

const QUrl KoTextDocument::ListsURL = QUrl("kotext://lists") [static]

Definition at line 122 of file KoTextDocument.h.

const QUrl KoTextDocument::StyleManagerURL = QUrl("kotext://stylemanager") [static]

Definition at line 121 of file KoTextDocument.h.

const QUrl KoTextDocument::TextEditorURL = QUrl("kotext://textEditor") [static]

Definition at line 126 of file KoTextDocument.h.

const QUrl KoTextDocument::UndoStackURL = QUrl("komain://undoStack") [static]

Definition at line 125 of file KoTextDocument.h.

The documentation for this class was generated from the following files: