Merge branch 'master' of http://scm.trinitydesktop.org/scm/git/tdelibs

1 files changed, 83 insertions, 0 deletions

diff --git a/interfaces/tdetexteditor/markinterfaceextension.h b/interfaces/tdetexteditor/markinterfaceextension.h
new file mode 100644
index 000000000..7aef736db
--- /dev/null
+++ b/interfaces/tdetexteditor/markinterfaceextension.h
@@ -0,0 +1,83 @@
+/* This file is part of the KDE project
+   Copyright (C) 2002 Joseph Wenninger <jowenn@kde.org>
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public
+   License as published by the Free Software Foundation; either
+   version 2 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU Library General Public License
+   along with this library; see the file COPYING.LIB.  If not, write to
+   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.
+*/
+
+#ifndef __tdetexteditor_markinterface_extension_h__
+#define __tdetexteditor_markinterface_extension_h__
+
+#include <tqptrlist.h>
+#include <tqpixmap.h>
+#include <tqstring.h>
+#include "markinterface.h"
+
+class TQCString;
+
+namespace KTextEditor
+{
+
+
+/**
+*  This is an interface for custom extensions of the MarkInterface.
+*  It allows the developer to set pixmaps for custom marks and to indicate which
+*  marks are settable by the user, for example (in kate), as actions in the iconborder's popup menu.
+*/
+class KTEXTEDITOR_EXPORT MarkInterfaceExtension
+{
+  friend class PrivateMarkInterfaceExtension;
+  
+  public:
+    MarkInterfaceExtension ();
+    virtual ~MarkInterfaceExtension ();
+
+    unsigned int markInterfaceExtensionNumber () const;
+  
+  protected:  
+    void setMarkInterfaceExtensionDCOPSuffix (const TQCString &suffix);    
+    
+  public:
+    virtual void setPixmap(MarkInterface::MarkTypes, const TQPixmap &)=0;
+    virtual void setDescription(MarkInterface::MarkTypes, const TQString &)=0;
+    virtual void setMarksUserChangable(uint markMask)=0;
+
+    enum MarkChangeAction {
+		MarkAdded=0,
+		MarkRemoved=1
+	};
+  //
+  // slots !!!
+  //
+  public:
+
+  //
+  // signals !!!
+  //
+  public:
+    virtual void markChanged (KTextEditor::Mark mark, 
+                              KTextEditor::MarkInterfaceExtension::MarkChangeAction action) = 0;
+  
+  private:
+    class PrivateMarkInterfaceExtension *d;
+    static unsigned int globalMarkInterfaceExtensionNumber;
+    unsigned int myMarkInterfaceExtensionNumber;
+};
+
+KTEXTEDITOR_EXPORT MarkInterfaceExtension *markInterfaceExtension (class Document *doc);
+
+}
+
+#endif