dox/Widgets/vtkKWEWidgetGroup.h

Go to the documentation of this file.

//=============================================================================
//   This file is part of VTKEdge. See vtkedge.org for more information.
//
//   Copyright (c) 2010 Kitware, Inc.
//
//   VTKEdge may be used under the terms of the BSD License
//   Please see the file Copyright.txt in the root directory of
//   VTKEdge for further information.
//
//   Alternatively, you may see: 
//
//   http://www.vtkedge.org/vtkedge/project/license.html
//
//
//   For custom extensions, consulting services, or training for
//   this or any other Kitware supported open source project, please
//   contact Kitware at sales@kitware.com.
//
//
//=============================================================================
#ifndef __vtkKWEWidgetGroup_h
#define __vtkKWEWidgetGroup_h

#include "VTKEdgeConfigure.h" // needed for export symbols directives
#include "vtkObject.h"
#include <vtkstd/vector>

class vtkAbstractWidget;

class VTKEdge_WIDGETS_EXPORT vtkKWEWidgetGroup : public vtkObject
{
public:
  static vtkKWEWidgetGroup *New();


  vtkTypeRevisionMacro(vtkKWEWidgetGroup,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual void SetEnabled(int);
  vtkBooleanMacro(Enabled, int);

  void AddWidget(vtkAbstractWidget *);

  void RemoveWidget(vtkAbstractWidget *);

  unsigned int GetNumberOfWidgets();

  vtkAbstractWidget *GetNthWidget( unsigned int );

  //BTX
  // TODO: Move this to the protected section. The class vtkAbstractWidget
  //       should be a friend of this class.
  typedef vtkstd::vector< vtkAbstractWidget * >   WidgetContainerType;
  typedef WidgetContainerType::iterator           WidgetIteratorType;
  typedef WidgetContainerType::const_iterator     WidgetConstIteratorType;
  WidgetContainerType                             Widget;


  template< class TWidget > struct ActionFunction
    {
    typedef int (TWidget::*TActionFunctionPointer)(TWidget *dispatcher);
    };


  template < class TWidget >
  void DispatchAction(TWidget *caller,
                      typename ActionFunction< TWidget >::TActionFunctionPointer action)
    {
    // Dispatch action to the caller first.
    for (WidgetIteratorType it  = this->Widget.begin();
                            it != this->Widget.end()  ; ++it)
      {
      TWidget *w = static_cast<TWidget *>(*it);
      if (caller == w)
        {
        if (((*w).*(action))(caller) == 0) return;
        break;
        }
      }

    // Dispatch action to all other widgets
    for (WidgetIteratorType it  = this->Widget.begin();
                            it != this->Widget.end()  ; ++it)
      {
      TWidget *w = static_cast<TWidget *>(*it);
      if (caller != w) ((*w).*(action))(caller);
      }
    }
  //ETX


  virtual void Register(vtkObjectBase* o);
  virtual void UnRegister(vtkObjectBase* o);

  int HasWidget( vtkAbstractWidget * );

  void Render();

protected:
  vtkKWEWidgetGroup();
  ~vtkKWEWidgetGroup();

  // We need to break reference count loops. The widgets held by us refcount us
  // too
  virtual void ReportReferences(vtkGarbageCollector* collector);

private:
  vtkKWEWidgetGroup(const vtkKWEWidgetGroup&);  //Not implemented
  void operator=(const vtkKWEWidgetGroup&);  //Not implemented
};

#endif