1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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 __ktexteditor_markinterface_extension_h__
#define __ktexteditor_markinterface_extension_h__
#include <qptrlist.h>
#include <qpixmap.h>
#include <qstring.h>
#include "markinterface.h"
class QCString;
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 QCString &suffix);
public:
virtual void setPixmap(MarkInterface::MarkTypes, const QPixmap &)=0;
virtual void setDescription(MarkInterface::MarkTypes, const QString &)=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
|
