• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • interfaces/ktexteditor
 

interfaces/ktexteditor

  • KTextEditor
  • VariableInterface
Public Member Functions | List of all members
KTextEditor::VariableInterface Class Reference

#include <variableinterface.h>

Public Member Functions

unsigned int variableInterfaceNumber ()
virtual TQString variable (const TQString &name) const =0
virtual void variableChanged (const TQString &variable, const TQString &value)=0

Detailed Description

This interface is designed to provide access to "document variables", for example variables defined in files like "kate: variable value;" or the emacs style "-*- variable: value -*-".

The purpose is to allow KTE plugins to use variables. A document implementing this interface should return values for variable that it does not otherwise know how to use, since they could be of interrest to plugins. A document implementing this interface must emit the variableChanged() signal whenever a variable is set that it will return a value for.

KTextEditor interface to Document Variables

Definition at line 41 of file variableinterface.h.

Member Function Documentation

virtual TQString KTextEditor::VariableInterface::variable ( const TQString &  name) const
pure virtual
Returns
the value of the variable name, or an empty string if the variable is not set or has no value.
virtual void KTextEditor::VariableInterface::variableChanged ( const TQString &  variable,
const TQString &  value 
)
pure virtual

Signal: emitted when a variable is set.


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

interfaces/ktexteditor

Skip menu "interfaces/ktexteditor"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

interfaces/ktexteditor

Skip menu "interfaces/ktexteditor"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for interfaces/ktexteditor by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |