VTK  9.3.0
vtkHoverWidget.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
61#ifndef vtkHoverWidget_h
62#define vtkHoverWidget_h
63
64#include "vtkAbstractWidget.h"
65#include "vtkInteractionWidgetsModule.h" // For export macro
66
67VTK_ABI_NAMESPACE_BEGIN
68class VTKINTERACTIONWIDGETS_EXPORT vtkHoverWidget : public vtkAbstractWidget
69{
70public:
75
77
81 void PrintSelf(ostream& os, vtkIndent indent) override;
83
85
90 vtkSetClampMacro(TimerDuration, int, 1, 100000);
91 vtkGetMacro(TimerDuration, int);
93
98 void SetEnabled(int) override;
99
105 void CreateDefaultRepresentation() override { this->WidgetRep = nullptr; }
106
107protected:
109 ~vtkHoverWidget() override;
110
111 // The state of the widget
112
113 enum
114 {
115 Start = 0,
117 TimedOut
118 };
119
121
122 // Callback interface to execute events
126
127 // Subclasses of this class invoke these methods. If a non-zero
128 // value is returned, a subclass is handling the event.
129 virtual int SubclassHoverAction() { return 0; }
130 virtual int SubclassEndHoverAction() { return 0; }
131 virtual int SubclassSelectAction() { return 0; }
132
134
140
141private:
142 vtkHoverWidget(const vtkHoverWidget&) = delete;
143 void operator=(const vtkHoverWidget&) = delete;
144};
145
146VTK_ABI_NAMESPACE_END
147#endif
define the API for widget / widget representation
invoke a vtkTimerEvent when hovering
virtual int SubclassSelectAction()
int TimerId
Helper methods for creating and destroying timers.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
static vtkHoverWidget * New()
Instantiate this class.
void CreateDefaultRepresentation() override
A default representation, of which there is none, is created.
static void HoverAction(vtkAbstractWidget *)
int TimerDuration
Helper methods for creating and destroying timers.
~vtkHoverWidget() override
static void MoveAction(vtkAbstractWidget *)
static void SelectAction(vtkAbstractWidget *)
void SetEnabled(int) override
The method for activating and deactivating this widget.
virtual int SubclassEndHoverAction()
virtual int SubclassHoverAction()
a simple class to control print indentation
Definition vtkIndent.h:29