← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/kolourpaint/oneiric-proposed

« back to all changes in this revision

Viewing changes to commands/kpCommand.h

  • Committer: Bazaar Package Importer
  • Author(s): Harald Sitter
  • Date: 2011-07-10 12:20:39 UTC
  • Revision ID: james.westby@ubuntu.com-20110710122039-a7bokz6isao1ldt2
Tags: upstream-4.6.90+repack
Import upstream version 4.6.90+repack

Show diffs side-by-side

added added

removed removed

Lines of Context:
commands/kpCommand.h
 
1
 
 
2
/*
 
3
   Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
 
4
   All rights reserved.
 
5
 
 
6
   Redistribution and use in source and binary forms, with or without
 
7
   modification, are permitted provided that the following conditions
 
8
   are met:
 
9
 
 
10
   1. Redistributions of source code must retain the above copyright
 
11
      notice, this list of conditions and the following disclaimer.
 
12
   2. Redistributions in binary form must reproduce the above copyright
 
13
      notice, this list of conditions and the following disclaimer in the
 
14
      documentation and/or other materials provided with the distribution.
 
15
 
 
16
   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 
17
   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 
18
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 
19
   IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 
20
   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 
21
   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 
22
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 
23
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
24
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 
25
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
26
*/
 
27
 
 
28
 
 
29
#ifndef kpCommand_H
 
30
#define kpCommand_H
 
31
 
 
32
 
 
33
#include <kpCommandSize.h>
 
34
#undef environ  // macro on win32
 
35
 
 
36
 
 
37
class QString;
 
38
 
 
39
class kpAbstractImageSelection;
 
40
class kpAbstractSelection;
 
41
class kpCommandEnvironment;
 
42
class kpDocument;
 
43
class kpMainWindow;
 
44
class kpTextSelection;
 
45
class kpViewManager;
 
46
 
 
47
 
 
48
class kpCommand : public kpCommandSize
 
49
{
 
50
public:
 
51
    kpCommand (kpCommandEnvironment *environ);
 
52
    virtual ~kpCommand ();
 
53
 
 
54
public:
 
55
    virtual QString name () const = 0;
 
56
 
 
57
    // Returns the estimated size in bytes.
 
58
    //
 
59
    // You only have to factor in the size of variables that change according
 
60
    // to the amount of input e.g. pixmap size, text size.  There is no need
 
61
    // to include the size of O(1) variables unless they are huge.
 
62
    //
 
63
    // If in doubt, return the largest possible amount of memory that your
 
64
    // command will take.  This is better than making the user unexpectedly
 
65
    // run out of memory.
 
66
    //
 
67
    // Implement this by measuring the size of all of your fields, using
 
68
    // kpCommandSize.
 
69
    virtual SizeType size () const = 0;
 
70
 
 
71
    virtual void execute () = 0;
 
72
    virtual void unexecute () = 0;
 
73
 
 
74
protected:
 
75
    kpCommandEnvironment *environ () const;
 
76
 
 
77
    // Commonly used accessors - simply forwards to environ().
 
78
    kpDocument *document () const;
 
79
 
 
80
    kpAbstractSelection *selection () const;
 
81
    kpAbstractImageSelection *imageSelection () const;
 
82
    kpTextSelection *textSelection () const;
 
83
 
 
84
    kpViewManager *viewManager () const;
 
85
 
 
86
private:
 
87
    kpCommandEnvironment * const m_environ;
 
88
};
 
89
 
 
90
 
 
91
#endif  // kpCommand_H