kate Library API Documentation

Kate::Document Class Reference

This interface provides access to the Kate Document class. More...

#include <document.h>

List of all members.

Public Types

enum  ConfigFlags {
  cfAutoIndent = 0x1, cfBackspaceIndents = 0x2, cfWordWrap = 0x4, cfReplaceTabs = 0x8,
  cfRemoveSpaces = 0x10, cfWrapCursor = 0x20, cfAutoBrackets = 0x40, cfPersistent = 0x80,
  cfKeepSelection = 0x100, cfDelOnInput = 0x400, cfXorSelect = 0x800, cfOvr = 0x1000,
  cfMark = 0x2000, cfKeepIndentProfile = 0x8000, cfKeepExtraSpaces = 0x10000, cfTabIndents = 0x80000,
  cfShowTabs = 0x200000, cfSpaceIndent = 0x400000, cfSmartHome = 0x800000
}

Public Slots

virtual void flush ()
virtual void reloadFile ()=0
virtual void spellcheck ()
virtual void exportAs (const QString &)=0
virtual void applyWordWrap ()=0

Signals

void modifiedOnDisc (Kate::Document *doc, bool isModified, unsigned char reason)

Public Member Functions

 Document (QObject *parent, const char *name)
virtual void isModOnHD (bool=false)
virtual QString docName ()
virtual void setDocName (QString)
virtual ActionMenu * hlActionMenu (const QString &, QObject *=0, const char *=0)=0
virtual ActionMenu * exportActionMenu (const QString &, QObject *=0, const char *=0)=0
virtual void setWordWrap (bool)=0
virtual bool wordWrap ()=0
virtual void setWordWrapAt (uint)=0
virtual uint wordWrapAt ()=0
virtual void setEncoding (const QString &e)=0
virtual QString encoding () const =0
virtual ConfigPage * colorConfigPage (QWidget *)=0
virtual ConfigPage * fontConfigPage (QWidget *)=0
virtual ConfigPage * indentConfigPage (QWidget *)=0
virtual ConfigPage * selectConfigPage (QWidget *)=0
virtual ConfigPage * editConfigPage (QWidget *)=0
virtual ConfigPage * keysConfigPage (QWidget *)=0
virtual ConfigPage * kSpellConfigPage (QWidget *)
virtual ConfigPage * hlConfigPage (QWidget *)=0
virtual uint configFlags ()=0
virtual void setConfigFlags (uint flags)=0

Static Public Member Functions

bool registerCommand (Command *cmd)
bool unregisterCommand (Command *cmd)
CommandqueryCommand (const QString &cmd)
void setOpenErrorDialogsActivated (bool on)
void setFileChangedDialogsActivated (bool on)
const QStringdefaultEncoding ()

Static Protected Attributes

bool s_openErrorDialogsActivated = true
bool s_fileChangedDialogsActivated = false
QString s_defaultEncoding


Detailed Description

This interface provides access to the Kate Document class.

Definition at line 122 of file document.h.


Member Function Documentation

bool Kate::Document::registerCommand Command cmd  )  [static]
 

Commands handling.

Definition at line 62 of file interfaces.cpp.

virtual void Kate::Document::isModOnHD bool  = false  )  [inline, virtual]
 

deprecated for KDE 4.0, just does reloadFile, which will ask the normal "do you want it really" questions

Definition at line 151 of file document.h.

virtual QString Kate::Document::docName  )  [inline, virtual]
 

Returns the document name.

Definition at line 156 of file document.h.

virtual void Kate::Document::setDocName QString   )  [inline, virtual]
 

Sets the document name.

deprecated for KDE 4.0, is done internally, calling it won't hurt but changes nothing beside triggers signal

Definition at line 163 of file document.h.

virtual void Kate::Document::reloadFile  )  [pure virtual, slot]
 

Reloads the current document from disk if possible.

virtual void Kate::Document::spellcheck  )  [inline, virtual, slot]
 

Spellchecking.

Definition at line 180 of file document.h.

virtual ConfigPage* Kate::Document::colorConfigPage QWidget  )  [pure virtual]
 

Deprecated:


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Sep 23 17:13:33 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003