Trinity API Reference KTextEditor::Document Class Referenceabstract
#include <document.h>
Inheritance diagram for KTextEditor::Document:
Public Member Functions | |
| Document (TQObject *parent=0, const char *name=0) | |
| unsigned int | documentNumber () const |
| TQCString | documentDCOPSuffix () const |
| virtual class View * | createView (TQWidget *parent, const char *name=0)=0 |
| virtual TQPtrList< class View > | views () const =0 |
| long | documentListPosition () const |
| void | setDocumentListPosition (long pos) |
 Public Member Functions inherited from KTextEditor::Editor | |
| Editor (TQObject *parent=0, const char *name=0) | |
| unsigned int | editorNumber () const |
| Public Member Functions inherited from KParts::ReadWritePart | |
| ReadWritePart (TQObject *parent=0, const char *name=0) | |
| bool | isReadWrite () const |
| virtual void | setReadWrite (bool readwrite=true) |
| bool | isModified () const |
| bool | queryClose () |
| virtual bool | closeURL () |
| bool | closeURL (bool promptToSave) |
| virtual bool | saveAs (const KURL &url) |
| virtual void | setModified (bool modified) |
| Public Member Functions inherited from KParts::ReadOnlyPart | |
| ReadOnlyPart (TQObject *parent=0, const char *name=0) | |
| void | setProgressInfoEnabled (bool show) |
| bool | isProgressInfoEnabled () const |
| KURL | url () const |
| virtual bool | closeURL () |
| bool | openStream (const TQString &mimeType, const KURL &url) |
| bool | writeStream (const TQByteArray &data) |
| bool | closeStream () |
| Public Member Functions inherited from KParts::Part | |
| Part (TQObject *parent=0, const char *name=0) | |
| virtual void | embed (TQWidget *parentWidget) |
| virtual TQWidget * | widget () |
| PartManager * | manager () const |
| virtual Part * | hitTest (TQWidget *widget, const TQPoint &globalPos) |
| virtual void | setSelectable (bool selectable) |
| bool | isSelectable () const |
| Public Member Functions inherited from KParts::PartBase | |
| void | setPartObject (TQObject *object) |
| Public Member Functions inherited from KXMLGUIClient | |
| KXMLGUIClient (KXMLGUIClient *parent) | |
| TDEAction * | action (const char *name) const |
| virtual TDEAction * | action (const TQDomElement &element) const |
| virtual TDEActionCollection * | actionCollection () const |
| virtual TDEInstance * | instance () const |
| virtual TQDomDocument | domDocument () const |
| virtual TQString | xmlFile () const |
| void | setXMLGUIBuildDocument (const TQDomDocument &doc) |
| TQDomDocument | xmlguiBuildDocument () const |
| void | setFactory (KXMLGUIFactory *factory) |
| KXMLGUIFactory * | factory () const |
| KXMLGUIClient * | parentClient () const |
| void | insertChildClient (KXMLGUIClient *child) |
| void | removeChildClient (KXMLGUIClient *child) |
| const TQPtrList< KXMLGUIClient > * | childClients () |
| void | setClientBuilder (KXMLGUIBuilder *builder) |
| KXMLGUIBuilder * | clientBuilder () const |
| void | reloadXML () |
| void | plugActionList (const TQString &name, const TQPtrList< TDEAction > &actionList) |
| void | unplugActionList (const TQString &name) |
| void | beginXMLPlug (TQWidget *) |
| void | endXMLPlug () |
| void | prepareXMLUnplug (TQWidget *) |
Friends | |
| class | PrivateDocument |
Additional Inherited Members | |
| Public Slots inherited from KParts::ReadWritePart | |
| virtual void | setModified () |
| virtual bool | save () |
| bool | waitSaveComplete () |
| Public Slots inherited from KParts::ReadOnlyPart | |
| virtual bool | openURL (const KURL &url) |
| Signals inherited from KParts::ReadWritePart | |
| void | sigQueryClose (bool *handled, bool *abortClosing) |
| Signals inherited from KParts::ReadOnlyPart | |
| void | started (TDEIO::Job *) |
| void | completed () |
| void | completed (bool pendingAction) |
| void | canceled (const TQString &errMsg) |
| Signals inherited from KParts::Part | |
| void | setWindowCaption (const TQString &caption) |
| void | setStatusBarText (const TQString &text) |
| Protected Types inherited from KParts::PartBase | |
| enum | PluginLoadingMode |
| Protected Member Functions inherited from KParts::ReadWritePart | |
| virtual bool | saveFile ()=0 |
| virtual bool | saveToURL () |
| Protected Member Functions inherited from KParts::ReadOnlyPart | |
| virtual bool | openFile ()=0 |
| virtual void | guiActivateEvent (GUIActivateEvent *event) |
| Protected Member Functions inherited from KParts::Part | |
| virtual void | setWidget (TQWidget *widget) |
| virtual void | partActivateEvent (PartActivateEvent *event) |
| virtual void | partSelectEvent (PartSelectEvent *event) |
| virtual void | guiActivateEvent (GUIActivateEvent *event) |
| TQWidget * | hostContainer (const TQString &containerName) |
| Protected Member Functions inherited from KParts::PartBase | |
| virtual void | setInstance (TDEInstance *instance) |
| virtual void | setInstance (TDEInstance *instance, bool loadPlugins) |
| void | loadPlugins (TQObject *parent, KXMLGUIClient *parentGUIClient, TDEInstance *instance) |
| void | setPluginLoadingMode (PluginLoadingMode loadingMode) |
| Protected Member Functions inherited from KXMLGUIClient | |
| virtual void | setInstance (TDEInstance *instance) |
| virtual void | setXMLFile (const TQString &file, bool merge=false, bool setXMLDoc=true) |
| virtual void | setXML (const TQString &document, bool merge=false) |
| virtual void | setDOMDocument (const TQDomDocument &document, bool merge=false) |
| virtual void | conserveMemory () |
| virtual void | stateChanged (const TQString &newstate, ReverseStateChange reverse=StateNoReverse) |
| Protected Attributes inherited from KParts::ReadOnlyPart | |
| KURL | m_url |
| TQString | m_file |
| bool | m_bTemp |
| Protected Attributes inherited from KParts::PartBase | |
| DoNotLoadPlugins | |
| LoadPlugins | |
| LoadPluginsIfEnabled | |
Detailed Description
The main class representing a text document.
This class provides access to the document's views.
Definition at line 31 of file document.h.
Constructor & Destructor Documentation
◆ Document()
| Document::Document | ( | TQObject * | parent = 0, |
| const char * | name = 0 |
||
| ) |
Definition at line 109 of file tdetexteditor.cpp.
◆ ~Document()
|
virtual |
Definition at line 116 of file tdetexteditor.cpp.
Member Function Documentation
◆ createView()
|
pure virtual |
Create a view that will display the document data.
You can create as many views as you like. When the user modifies data in one view then all other views will be updated as well.
◆ documentDCOPSuffix()
| TQCString Document::documentDCOPSuffix | ( | ) | const |
Returns this document's DCOP suffix for identifiying its DCOP interface.
Definition at line 135 of file tdetexteditor.cpp.
◆ documentListPosition()
| long Document::documentListPosition | ( | ) | const |
Returns the list position of this document in your app, if applicable.
Definition at line 125 of file tdetexteditor.cpp.
◆ documentNumber()
| unsigned int Document::documentNumber | ( | ) | const |
Returns the global number of this document in your app.
Definition at line 120 of file tdetexteditor.cpp.
◆ setDocumentListPosition()
| void Document::setDocumentListPosition | ( | long | pos | ) |
Sets the list position of this document in your app, if applicable.
Definition at line 130 of file tdetexteditor.cpp.
Friends And Related Function Documentation
◆ PrivateDocument
|
friend |
Definition at line 33 of file document.h.
The documentation for this class was generated from the following files: