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

interfaces

  • interfaces
  • tdetexteditor
markinterface.h
1 /* This file is part of the KDE project
2  Copyright (C) 2001 Christoph Cullmann (cullmann@kde.org)
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef __tdetexteditor_markinterface_h__
21 #define __tdetexteditor_markinterface_h__
22 
23 #include <tqptrlist.h>
24 
25 #include <tdelibs_export.h>
26 
27 class TQCString;
28 
29 namespace KTextEditor
30 {
31 
32 class Mark
33 {
34  public:
35  uint line;
36  uint type;
37 };
38 
42 class KTEXTEDITOR_EXPORT MarkInterface
43 {
44  friend class PrivateMarkInterface;
45 
46  public:
47  MarkInterface ();
48  virtual ~MarkInterface ();
49 
50  unsigned int markInterfaceNumber () const;
51 
52  protected:
53  void setMarkInterfaceDCOPSuffix (const TQCString &suffix);
54 
55  //
56  // slots !!!
57  //
58  public:
62  virtual uint mark (uint line) = 0;
63 
68  virtual void setMark (uint line, uint markType) = 0;
72  virtual void clearMark (uint line) = 0;
73 
74  virtual void addMark (uint line, uint markType) = 0;
78  virtual void removeMark (uint line, uint markType) = 0;
79 
83  virtual TQPtrList<KTextEditor::Mark> marks () = 0;
87  virtual void clearMarks () = 0;
88 
95  static int reservedMarkersCount();
96 
103  enum MarkTypes
104  {
106  markType01= 0x1,
108  markType02= 0x2,
110  markType03= 0x4,
112  markType04= 0x8,
114  markType05= 0x10,
116  markType06= 0x20,
118  markType07= 0x40,
119 
120  markType08= 0x80,
121  markType09= 0x100,
122  markType10= 0x200,
123  markType11= 0x400,
124  markType12= 0x800,
125  markType13= 0x1000,
126  markType14= 0x2000,
127  markType15= 0x4000,
128  markType16= 0x8000,
129  markType17= 0x10000,
130  markType18= 0x20000,
131  markType19= 0x40000,
132  markType20= 0x80000,
133  markType21= 0x100000,
134  markType22= 0x200000,
135  markType23= 0x400000,
136  markType24= 0x800000,
137  markType25= 0x1000000,
138  markType26= 0x2000000,
139  markType27= 0x4000000,
140  markType28= 0x8000000,
141  markType29= 0x10000000,
142  markType30= 0x20000000,
143  markType31= 0x40000000,
144  markType32= 0x80000000,
145  /* reserved marks */
146  Bookmark = markType01,
147  BreakpointActive = markType02,
148  BreakpointReached = markType03,
149  BreakpointDisabled = markType04,
150  Execution = markType05,
151  Warning = markType06,
152  Error = markType07
153  };
154 
155  //
156  // signals !!!
157  //
158  public:
159  virtual void marksChanged () = 0;
160 
161  private:
162  class PrivateMarkInterface *d;
163  static unsigned int globalMarkInterfaceNumber;
164  unsigned int myMarkInterfaceNumber;
165 };
166 
167 KTEXTEDITOR_EXPORT MarkInterface *markInterface (class Document *doc);
168 
169 }
170 
171 #endif
KTextEditor::MarkInterface
This is an interface to enable marks to be made in the iconborder of the Document class.
Definition: markinterface.h:43
KTextEditor::MarkInterface::clearMarks
virtual void clearMarks()=0
Clears all marks in the document.
KTextEditor::MarkInterface::MarkTypes
MarkTypes
Pre-defined mark types.
Definition: markinterface.h:104
KTextEditor::MarkInterface::clearMark
virtual void clearMark(uint line)=0
Clears all marks set in line.
KTextEditor::MarkInterface::mark
virtual uint mark(uint line)=0
KTextEditor::MarkInterface::setMark
virtual void setMark(uint line, uint markType)=0
Adds a mark of type markType to line.
KTextEditor::MarkInterface::removeMark
virtual void removeMark(uint line, uint markType)=0
Removes any mark of type markType from line.
KTextEditor::MarkInterface::marks
virtual TQPtrList< KTextEditor::Mark > marks()=0
KTextEditor
KTextEditor is KDE's standard text editing KPart interface.
Definition: blockselectiondcopinterface.h:10

interfaces

Skip menu "interfaces"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

interfaces

Skip menu "interfaces"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for interfaces by doxygen 1.9.1
This website is maintained by Timothy Pearson.