<commit_before>/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date: 2009-05-28 17:19:30 +0200 (Thu, 28 May 2009) $
Version:   $Revision: 17495 $

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or http://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 MITKOVERLAY_H_HEADER_INCLUDED_C10DC4EB
#define MITKOVERLAY_H_HEADER_INCLUDED_C10DC4EB

// MITK-Stuff
#include "mitkCommon.h"
#include "mitkPropertyList.h"

// QT-Stuff
#include <QWidget>

#include "OverlaysExports.h"


/** \class  QmitkOverlay
* \brief Abstract base class for all overlay-objects in MITK
*
* This class is the basis for all classes representing objects that can be visualized as overlays in MITK.
* It encapsulates an ID, as well as a display-position and a layer.
* 
* The ID is used to access mitkProperties in a PropertyList that holds information that is needed for the visualization,
* e.g. text for TextOverlays or scaleFactor for ScalarBarOverlays ...
*
* The display-position encodes where on the screen the overlay will be positioned at:
* \sa DisplayPosition
* 0 - 1 - 2
* |   |   |
* 3 -   - 4
* |   |   |
* 5 - 6 - 7
*
* The layer is needed if several overlays shall be put in the same position.
* In this case the layer defines the order in which the objects are layouted.
*
* \ingroup Qmitk
*/

class Overlays_EXPORT QmitkOverlay : public QObject
{
  Q_OBJECT 

public:

  /** \brief enumeration of all possible display positions  */
  enum DisplayPosition
  {
    top_Left = 0,
    top_Center = 1,
    top_Right = 2,
    middle_Left = 3,
    middle_Right = 4,
    bottom_Left = 5,
    bottom_Center = 6,
    bottom_Right = 7
  };
<commit_msg>DOC: reformat Doxygen code to produce the intended image<commit_after>/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date: 2009-05-28 17:19:30 +0200 (Thu, 28 May 2009) $
Version:   $Revision: 17495 $

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or http://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 MITKOVERLAY_H_HEADER_INCLUDED_C10DC4EB
#define MITKOVERLAY_H_HEADER_INCLUDED_C10DC4EB

// MITK
#include "mitkCommon.h"
#include "mitkPropertyList.h"

// Qt
#include <QWidget>

#include "OverlaysExports.h"


/**
 \brief Abstract base class for all overlay-objects in MITK

 This class is the basis for all classes representing objects that can be visualized as overlays in MITK.
 It encapsulates an ID, as well as a display-position and a layer.
 
 The ID is used to access mitkProperties in a PropertyList that holds information that is needed for the visualization,
 e.g. text for TextOverlays or scaleFactor for ScalarBarOverlays ...

 The display-position encodes where on the screen the overlay will be positioned at 
 (see and USE the constants defined by DisplayPosition):
\verbatim
 0 - 1 - 2
 |   |   |
 3 -   - 4
 |   |   |
 5 - 6 - 7
\endverbatim

 The layer is needed if several overlays shall be put in the same position.
 In this case the layer defines the order in which the objects are layouted.

 \ingroup Qmitk
*/
class Overlays_EXPORT QmitkOverlay : public QObject
{
  Q_OBJECT 

public:

  /** \brief enumeration of all possible display positions  */
  enum DisplayPosition
  {
    top_Left = 0,
    top_Center = 1,
    top_Right = 2,
    middle_Left = 3,
    middle_Right = 4,
    bottom_Left = 5,
    bottom_Center = 6,
    bottom_Right = 7
  };

{'fraction_non_alphanumeric': 0.13554926921263555, 'fraction_numerical': 0.024045261669024046, 'mean_word_length': 3.933720930232558, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5807547', 'n_tokens_mistral': 1337, 'n_tokens_neox': 1191, 'n_words': 486}