# interfaces Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# templateinterface.h

    00001 /* This file is part of the KDE libraries
    00002    Copyright (C) 2004 Joseph Wenninger <jowenn@kde.org>
    00003
    00004    This library is free software; you can redistribute it and/or
    00005    modify it under the terms of the GNU Library General Public
    00006    License version 2 as published by the Free Software Foundation.
    00007
    00008    This library is distributed in the hope that it will be useful,
    00009    but WITHOUT ANY WARRANTY; without even the implied warranty of
    00010    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00011    Library General Public License for more details.
    00012
    00013    You should have received a copy of the GNU Library General Public License
    00014    along with this library; see the file COPYING.LIB.  If not, write to
    00015    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    00016    Boston, MA 02111-1307, USA.
    00017 */
    00018
    00019 #ifndef __ktexteditor_templateinterface_h__
    00020 #define __ktexteditor_templateinterface_h__
    00021
    00022 #include <qstring.h>
    00023 #include <qmap.h>
    00024 #include <qwidget.h>
    00025
    00026 #include <kdelibs_export.h>
    00027
    00028 namespace KTextEditor
    00029 {
    00030
    00031 class Document;
    00032
    00037 class KTEXTEDITOR_EXPORT TemplateInterface //should be named AbstractTemplateInterface, but for consistency with the other classes it is not (for the 3.x release series)
    00038 {
    00039   friend class PrivateTemplateInterface;
    00040
    00041   public:
    00042     TemplateInterface();
    00043     virtual ~TemplateInterface();
    00044
    00055     static bool expandMacros( QMap<QString, QString> &initialValues, QWidget *parentWindow );
    00056
    00057     uint templateInterfaceNumber () const;
    00058
    00059   protected:
    00060     void setTemplateInterfaceDCOPSuffix (const QCString &suffix);
    00061
    00062   public:
    00063
    00106     bool insertTemplateText ( uint line, uint column, const QString &templateString, const QMap<QString,QString> &initialValues, QWidget *parentWindow=0);
    00107
    00108 protected:
    00116     virtual bool insertTemplateTextImplementation ( uint line, uint column, const QString &templateString, const QMap<QString,QString> &initialValues, QWidget *parentWindow=0 )=0;
    00117
    00121   private:
    00122     class PrivateTemplateInterface *d;
    00123     static uint globalTemplateInterfaceNumber;
    00124     uint myTemplateInterfaceNumber;
    00125 };
    00126
    00127 KTEXTEDITOR_EXPORT TemplateInterface *templateInterface (Document *doc);
    00128
    00129 }
    00130
    00131 #endif

This file is part of the documentation for interfaces Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:34:57 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003