cinelerra-5.1/cinelerra/undostackitem.h

   1
   2 /*
   3  * CINELERRA
   4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef UNDOSTACKITEM_H
  23 #define UNDOSTACKITEM_H
  24
  25 #include "linklist.h"
  26
  27
  28 class UndoStackItem : public ListItem<UndoStackItem>
  29 {
  30 public:
  31         UndoStackItem();
  32         virtual ~UndoStackItem();
  33
  34         void set_description(const char *description);
  35         void set_creator(void *creator);
  36
  37 // This function must be overridden in derived objects.
  38 // It is called both to undo and to redo an operation.
  39 // The override must do the following:
  40 // - change the EDL to undo an operation;
  41 // - change the internal information of the item so that the next invocation
  42 //   of undo() does a redo (i.e. undoes the undone operation).
  43         virtual void undo();
  44
  45 // Return the amount of memory used for the data associated with this
  46 // object in order to enable limiting the amount of memory used by the
  47 // undo stack.
  48 // Ignore overhead and just report the specific data values that the
  49 // derived object adds.
  50         virtual int get_size();
  51
  52
  53 // command description for the menu item
  54         char *description;
  55 // who created this item
  56         void* creator;
  57 };
  58
  59 #endif