dox/Rendering/Context2D/vtkTooltipItem.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkTooltipItem.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 notice for more information.

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

#ifndef __vtkTooltipItem_h
#define __vtkTooltipItem_h

#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkContextItem.h"
#include "vtkVector.h"     // Needed for vtkVector2f
#include "vtkStdString.h"  // For vtkStdString ivars

class vtkPen;
class vtkBrush;
class vtkTextProperty;

class VTKRENDERINGCONTEXT2D_EXPORT vtkTooltipItem : public vtkContextItem
{
public:
  vtkTypeMacro(vtkTooltipItem, vtkContextItem);
  virtual void PrintSelf(ostream &os, vtkIndent indent);

  static vtkTooltipItem *New();


  vtkSetVector2Macro(Position, float);
  void SetPosition(const vtkVector2f &pos);


  vtkGetVector2Macro(Position, float);
  vtkVector2f GetPositionVector();


  virtual void SetText(const vtkStdString &title);
  virtual vtkStdString GetText();


  vtkGetObjectMacro(Pen, vtkPen);


  vtkGetObjectMacro(Brush, vtkBrush);


  vtkGetObjectMacro(TextProperties, vtkTextProperty);

  virtual void Update();

  virtual bool Paint(vtkContext2D *painter);

//BTX
protected:
  vtkTooltipItem();
  ~vtkTooltipItem();

  vtkVector2f PositionVector;
  float* Position;
  vtkStdString Text;
  vtkTextProperty* TextProperties;
  vtkPen* Pen;
  vtkBrush* Brush;

private:
  vtkTooltipItem(const vtkTooltipItem &); // Not implemented.
  void operator=(const vtkTooltipItem &);   // Not implemented.
//ETX
};

#endif //__vtkTooltipItem_h