blob: a4fcb414cdcb86fdd8ec87679e539a9031da2fc9 (
plain)
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
|
/* This file is part of the KDE libraries
Copyright (C) 2003 Hamish Rodda <[email protected]>
Copyright (C) 2001 Christoph Cullmann <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
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_editinterfaceext_h__
#define __ktexteditor_editinterfaceext_h__
#include <tqstring.h>
#include <tdelibs_export.h>
namespace KTextEditor
{
/**
* This is the main interface for accessing and modifying
* text of the Document class.
*/
class KTEXTEDITOR_EXPORT EditInterfaceExt
{
friend class PrivateEditInterfaceExt;
public:
EditInterfaceExt();
virtual ~EditInterfaceExt();
uint editInterfaceExtNumber() const;
/**
* Begin an editing sequence. Edit commands during this sequence will be
* bunched together such that they represent a single undo command in the
* editor, and so that repaint events do not occur inbetween.
*
* Your application should not return control to the event loop while it
* has an unterminated (no matching editEnd() call) editing sequence
* (result undefined) - so do all of your work in one go...
*/
virtual void editBegin() = 0;
/**
* End and editing sequence.
*/
virtual void editEnd() = 0;
public:
/**
* only for the interface itself - REAL PRIVATE
*/
private:
class PrivateEditInterfaceExt *d;
static uint globalEditInterfaceExtNumber;
uint myEditInterfaceExtNumber;
};
KTEXTEDITOR_EXPORT EditInterfaceExt *editInterfaceExt (class Document *doc);
}
#endif
|
