.TH "KTextEditor::VariableInterface" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEditor::VariableInterface \- 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 -*-'. \fBKTextEditor\fP interface to \fBDocument\fP Variables.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <variableinterface.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "unsigned int \fBvariableInterfaceNumber\fP ()"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBvariable\fP (const \fBQString\fP &name) const =0"
.br
.ti -1c
.RI "virtual void \fBvariableChanged\fP (const \fBQString\fP &variable, const \fBQString\fP &value)=0"
.br
.in -1c
.SH "Detailed Description"
.PP 
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 -*-'. \fBKTextEditor\fP interface to \fBDocument\fP Variables. 

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 \fBvariableChanged()\fP signal whenever a variable is set that it will return a value for.
.PP
Definition at line 41 of file variableinterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBQString\fP KTextEditor::VariableInterface::variable (const \fBQString\fP & name) const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the value of the variable \fCname\fP, or an empty string if the variable is not set or has no value. 
.RE
.PP

.SS "virtual void KTextEditor::VariableInterface::variableChanged (const \fBQString\fP & variable, const \fBQString\fP & value)\fC [pure virtual]\fP"
.PP
Signal: emitted when a variable is set. 
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
