mitkFocusManager.h

Go to the documentation of this file.

/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/


#ifndef MITKFOCUSMANAGER_H_HEADER_INCLUDED_C135A197
#define MITKFOCUSMANAGER_H_HEADER_INCLUDED_C135A197

#include "mitkCommon.h"
#include "mitkBaseRenderer.h"
#include <vector>
#include <itkEventObject.h>

namespace mitk {

//##Documentation
//## @brief manages a list of BaseRenderer.
//## 
//## A focuspointer can be set and read.
//## GoToNext can be used to switch through the list.
//## if the switch m_Loop is set to true, GetNext loops through the list; after
//## the last it goes to the first.
//## if it is not set, it returnes NULL if it steps behind the last Widget.
//## @ingroup Interaction
  class MITK_CORE_EXPORT FocusManager : public itk::Object
{
  public:
  mitkClassMacro(FocusManager, itk::Object);
  itkNewMacro(Self);

  //##Documentation
  //##@brief Element, that can be focused and held here.
  //##
  //## has to be an itk-Objekct in order to use itk-Smartpointer!
  typedef mitk::BaseRenderer FocusElement;

  typedef itk::WeakPointer<FocusElement> FocusElementWeakPointer;

  typedef std::vector<FocusElementWeakPointer> FocusElementList;
  
  typedef std::vector<FocusElementWeakPointer>::iterator FocusListIterator;
  
  //##Documentation
  //## Destructor
  ~FocusManager();

  //##Documentation
  //## Adds the widget into the set of managed Widgets after the focused
  //## widget and sets the focus to the added one if the list was empty before
  bool AddElement(FocusElement* element);

  //##Documentation
  //## removes the given widget from the list.
  //## true if found and removed, else false
  //## afterwards the focused widget is the one behind the deleted
  //## or if the deleted was the last, then the one before the deleted
  //## that way you can delete sequentialy from the back on or from front to back
  bool RemoveElement(FocusElement* element);

  //##Documentation
  //## returns the focused Widget
  FocusElement* GetFocused() const;

  //##Documentation
  //## searches the given Widget in List;
  //## if found, sets the focus to this widget and returns true
  bool SetFocused(FocusElement* element);

  //##Documentation
  //## returns, if this focused widget points behind the end of the List
  bool IsLast();

  //##Documentation
  //## returns true, if the focused widget is the first in the list
  bool IsFirst();

  //##Documentation
  //## returns the first widget in list
  const FocusElement* GetFirst() const;

  //##Documentation
  //## returns the last widget in list
  const FocusElement* GetLast() const;

  //##Documentation
  //## sets the focus to the next in list
  //## loops the list, if switch loop is true
  //## returns true if successful, else false
  bool GoToNext();
    
  //##Documentation
  //## returns an iterator, that points to the 
  //## beginning of the list
  //## no changes are made to the current focused element
  FocusListIterator GetIter();

  //##Documentation
  //## Sets the LoopMode.
  //## if set to true-> the one after the last is the first
  void SetLoop(bool loop);

  friend class GlobalInteraction;  
protected:
  //##Documentation
  //## Constructor
  FocusManager();

private:
  //##Documentation
  //## stores the Widgets
  FocusElementList m_FocusList;

  //##Documentation
  //## holds the focused Widget
  itk::WeakPointer<FocusElement> m_FocElement;

  //##Documentation
  //## switch which sets the LoopMode.
  //## if true, then the next after the last one is the first
  bool m_Loop;
};

//##Documentation
//## @brief connect to this Event to get noticed when the focus changes
itkEventMacro( FocusEvent , itk::AnyEvent ); 

} // namespace mitk



#endif /* MITKFOCUSMANAGER_H_HEADER_INCLUDED_C135A197 */