home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / icommand_node.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  2.0 KB  |  73 lines
  1. #ifndef K3DSDK_ICOMMAND_NODE_H
  2. #define K3DSDK_ICOMMAND_NODE_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2008, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \author Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "iunknown.h"
  28. #include "types.h"
  29.  
  30. namespace k3d
  31. {
  32.  
  33. /// Abstract interface for objects that can accept commands from external entities
  34. class icommand_node :
  35.     public virtual iunknown
  36. {
  37. public:
  38.     /// Enumerates the types of commands that can be executed by a node
  39.     typedef enum
  40.     {
  41.         COMMAND_INTERACTIVE,
  42.         COMMAND_MACRO,
  43.     } type;
  44.  
  45.     /// Enumerates the possible return values from execute_command
  46.     typedef enum
  47.     {
  48.         /// The command was executed without error, further execution should be halted
  49.         RESULT_STOP,
  50.         /// The command was executed without error, continue executing normally
  51.         RESULT_CONTINUE,
  52.         /// The command failed to execute
  53.         RESULT_ERROR,
  54.         /// The command was not recognized
  55.         RESULT_UNKNOWN_COMMAND
  56.         
  57.     } result;
  58.     
  59.     /// Executes a command, returning the command result
  60.     virtual const result execute_command(const string_t& Command, const string_t& Arguments) = 0;
  61.  
  62. protected:
  63.     icommand_node() {}
  64.     icommand_node(const icommand_node&) {}
  65.     icommand_node& operator=(const icommand_node&) { return *this; }
  66.     virtual ~icommand_node() {}
  67. };
  68.  
  69. } // namespace k3d
  70.  
  71. #endif // !K3DSDK_ICOMMAND_NODE_H
  72.  
  73.