File indexing completed on 2024-04-28 04:20:11
0001 0002 /* 0003 Copyright (c) 2003-2007 Clarence Dang <dang@kde.org> 0004 All rights reserved. 0005 0006 Redistribution and use in source and binary forms, with or without 0007 modification, are permitted provided that the following conditions 0008 are met: 0009 0010 1. Redistributions of source code must retain the above copyright 0011 notice, this list of conditions and the following disclaimer. 0012 2. Redistributions in binary form must reproduce the above copyright 0013 notice, this list of conditions and the following disclaimer in the 0014 documentation and/or other materials provided with the distribution. 0015 0016 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 0017 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 0018 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 0019 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 0020 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 0021 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 0022 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 0023 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 0024 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 0025 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 0026 */ 0027 0028 0029 #ifndef kpCommand_H 0030 #define kpCommand_H 0031 0032 0033 #include "kpCommandSize.h" 0034 #undef environ // macro on win32 0035 0036 0037 class QString; 0038 0039 class kpAbstractImageSelection; 0040 class kpAbstractSelection; 0041 class kpCommandEnvironment; 0042 class kpDocument; 0043 class kpTextSelection; 0044 class kpViewManager; 0045 0046 0047 class kpCommand : public kpCommandSize 0048 { 0049 public: 0050 kpCommand (kpCommandEnvironment *environ); 0051 virtual ~kpCommand (); 0052 0053 public: 0054 virtual QString name () const = 0; 0055 0056 // Returns the estimated size in bytes. 0057 // 0058 // You only have to factor in the size of variables that change according 0059 // to the amount of input e.g. pixmap size, text size. There is no need 0060 // to include the size of O(1) variables unless they are huge. 0061 // 0062 // If in doubt, return the largest possible amount of memory that your 0063 // command will take. This is better than making the user unexpectedly 0064 // run out of memory. 0065 // 0066 // Implement this by measuring the size of all of your fields, using 0067 // kpCommandSize. 0068 virtual SizeType size () const = 0; 0069 0070 virtual void execute () = 0; 0071 virtual void unexecute () = 0; 0072 0073 protected: 0074 kpCommandEnvironment *environ () const; 0075 0076 // Commonly used accessors - simply forwards to environ(). 0077 kpDocument *document () const; 0078 0079 kpAbstractSelection *selection () const; 0080 kpAbstractImageSelection *imageSelection () const; 0081 kpTextSelection *textSelection () const; 0082 0083 kpViewManager *viewManager () const; 0084 0085 private: 0086 kpCommandEnvironment * const m_environ; 0087 }; 0088 0089 0090 #endif // kpCommand_H