• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kate
 

kate

  • Kate
  • Document
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Static Protected Attributes
Kate::Document Class Reference

#include <document.h>

Inherits Document, EditInterface, UndoInterface, CursorInterface, SelectionInterface, SearchInterface, HighlightingInterface, BlockSelectionInterface, ConfigInterface, MarkInterface, PrintInterface, WordWrapInterface, MarkInterfaceExtension, and SelectionInterfaceExt.

Inherited by KateDocument.

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 TQString &)=0
virtual void applyWordWrap ()=0

Signals

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

Public Member Functions

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

Static Public Member Functions

static bool registerCommand (Command *cmd)
static bool unregisterCommand (Command *cmd)
static Command * queryCommand (const TQString &cmd)
static void setOpenErrorDialogsActivated (bool on)
static void setFileChangedDialogsActivated (bool on)
static const TQString & defaultEncoding ()

Static Protected Attributes

static bool s_openErrorDialogsActivated = true
static bool s_fileChangedDialogsActivated = false
static TQString s_defaultEncoding

Detailed Description

This interface provides access to the Kate Document class.

Definition at line 182 of file document.h.


Member Function Documentation

virtual ConfigPage* Kate::Document::colorConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
Deprecated:
virtual TQString Kate::Document::docName ( ) [inline, virtual]

Returns the document name.

Definition at line 217 of file document.h.

virtual ConfigPage* Kate::Document::editConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
virtual ConfigPage* Kate::Document::fontConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
virtual ConfigPage* Kate::Document::hlConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
virtual ConfigPage* Kate::Document::indentConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
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

Deprecated:

Definition at line 212 of file document.h.

virtual ConfigPage* Kate::Document::keysConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
virtual ConfigPage* Kate::Document::kSpellConfigPage ( TQWidget *  ) [inline, virtual]
Deprecated:

Definition at line 276 of file document.h.

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

Indicate this file is modified on disk.

Parameters:
docthe Kate::Document object that represents the file on disk
isModifiedindicates the file was modified rather than created or deleted
reasonthe reason we are emitting the signal.
  • 0 - nothing
  • 1 - dirty
  • 2 - created
  • 3 - deleted
bool Kate::Document::registerCommand ( Command *  cmd) [static]

Commands handling.

Definition at line 62 of file interfaces.cpp.

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

Reloads the current document from disk if possible.

virtual ConfigPage* Kate::Document::selectConfigPage ( TQWidget *  ) [pure virtual]
Deprecated:
virtual void Kate::Document::setDocName ( TQString  ) [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

Deprecated:

Definition at line 225 of file document.h.

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

Spellchecking.

Definition at line 242 of file document.h.


The documentation for this class was generated from the following files:
  • document.h
  • interfaces.cpp

kate

Skip menu "kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kate

Skip menu "kate"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for kate by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.