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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/* This file is part of the KDE project
Copyright (C) 2008 Thorsten Zachmann <zachmann@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 KOEVENTACTION_H
#define KOEVENTACTION_H
#include "flake_export.h"
#include "KoXmlReaderForward.h"
class KoShapeLoadingContext;
class KoShapeSavingContext;
class KoToolBase;
/**
* This is the base class for actions that are executed on events.
*
* See ODF:
* 9.9 Presentation Events
* Many objects inside a presentation document support special presentation events. For example, a
* user can advance the presentation one frame when he clicks on an object with a corresponding
* event. Presentation events are contained with a graphic object's event listener table. See section
* 9.2.21 for details.
*
* 12.4 Event Listener Tables
* Many objects such as controls, images, text boxes, or an entire document support events. An
* event binds the occurrence of a particular condition to an action that is executed if the condition
* arises. For example, if a user places the cursor over a graphic, this condition triggers an action
* that is supported by the office application. This event, called "on-mouse-over", can be associated
* with a macro that is executed whenever the condition occurs, that is, whenever a user places the
* cursor over a graphic.
*/
class FLAKE_EXPORT KoEventAction
{
public:
/**
* Constructor
*/
KoEventAction();
virtual ~KoEventAction();
/**
* Set The id of the action
*
* @param id this is the value that is used for storing the event action in odf.
*/
void setId(const QString &id);
/**
* The id of the action
*
* The id is the value that is used for storing the event action in odf.
*/
QString id() const;
/**
* Load action from ODF.
*
* @param context the KoShapeLoadingContext used for loading
* @param element element which represents the shape in odf
*
* @return false if loading failed
*/
virtual bool loadOdf(const KoXmlElement &element, KoShapeLoadingContext &context) = 0;
/**
* Store the action as ODF.
*
* @param context The KoShapeSavingContext used for saving
*/
virtual void saveOdf(KoShapeSavingContext &context) const = 0;
/**
* Start the action.
*/
virtual void start() = 0;
/**
* Finish the action
*
* If the action takes some time to finish it can bs stoped with
* this method before its end.
*/
virtual void finish() {}
private:
class Private;
Private * const d;
};
#endif /* KOEVENTACTION_H */
|
