home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / inode_selection.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-07-24  |  2.4 KB  |  81 lines

  1. #ifndef K3DSDK_INODE_SELECTION_H
  2. #define K3DSDK_INODE_SELECTION_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.         \brief Declares inode_selection, an abstract interface for objects storing a list of selected nodes with their selection weight
  25.         \author Bart Janssens (bart.janssens@lid.kviv.be)
  26. */
  27.  
  28. #include <list>
  29.  
  30. #include "iunknown.h"
  31. #include "signal_system.h"
  32. #include "types.h"
  33.  
  34. namespace k3d
  35. {
  36.  
  37. class inode;
  38. class ihint;
  39.  
  40. /// Abstract interface for objects that store document node selections and their weights
  41. class inode_selection :
  42.     public virtual iunknown
  43. {
  44. public:
  45.     /// Storage for a list of selected nodes
  46.     /**
  47.      * Note: we use a list for fast removal at any position. Fast random access is not needed
  48.      */
  49.     typedef std::list<inode*> selected_nodes_t;
  50.  
  51.     /// Selects a node
  52.     /**
  53.      * \param Node the node to select
  54.      * \param Weight The selection weight. Setting this to 0 removes the node from the selection
  55.      */
  56.     virtual void select(inode& Node, const double_t Weight) = 0;
  57.  
  58.     /// Return the selection weight of the given node
  59.     virtual double_t selection_weight(inode& Node) = 0;
  60.  
  61.     /// List of selected nodes, in the order they were selected
  62.     virtual const selected_nodes_t selected_nodes() = 0;
  63.     
  64.     /// Deselect all nodes
  65.     virtual void deselect_all() = 0;
  66.     
  67.     /// Changed signal emitted when the selection changed
  68.     typedef sigc::signal<void, ihint*> changed_signal_t;
  69.     virtual changed_signal_t& selection_changed_signal() = 0;
  70.  
  71. protected:
  72.     inode_selection() {}
  73.     inode_selection(const inode_selection&) {}
  74.     inode_selection& operator=(const inode_selection&) { return *this; }
  75.     virtual ~inode_selection() {}
  76. };
  77.  
  78. } // namespace k3d
  79.  
  80. #endif // !K3DSDK_INODE_SELECTION_H
  81.