STYLE: Rename enabled to toolTipsTrapped

The tooltip trapper will have the option of either trapping tooltips (prevent
them from appearing) or word wrapping tooltips.

Libs/Widgets/Testing/Cpp/ctkToolTipTrapperTest1.cpp

@@ -37,17 +37,17 @@ int ctkToolTipTrapperTest1(int argc, char * argv [] )
 
   ctkToolTipTrapper trapper;
   
-  if (trapper.isEnabled() != true)
+  if (trapper.toolTipsTrapped() != true)
     {
-    std::cerr << "ctkToolTipTrapper::isEnabled default value" << std::endl;
+    std::cerr << "ctkToolTipTrapper::toolTipsTrapped default value" << std::endl;
     return EXIT_FAILURE;
     }
 
-  trapper.setEnabled(false);
+  trapper.setToolTipsTrapped(false);
 
-  if (trapper.isEnabled() != false)
+  if (trapper.toolTipsTrapped() != false)
     {
-    std::cerr << "ctkToolTipTrapper::setEnabled failed" << std::endl;
+    std::cerr << "ctkToolTipTrapper::setToolTipsTrapped failed" << std::endl;
     return EXIT_FAILURE;
     }
   
@@ -55,7 +55,7 @@ int ctkToolTipTrapperTest1(int argc, char * argv [] )
   button.setToolTip("Button tooltip text");
   button.setCheckable(true);
   QObject::connect(&button, SIGNAL(toggled(bool)),
-                   &trapper, SLOT(setEnabled(bool)));
+                   &trapper, SLOT(setToolTipsTrapped(bool)));
   button.show();
 
   if (argc < 2 || QString(argv[1]) != "-I" )

Libs/Widgets/ctkToolTipTrapper.cpp

@@ -63,14 +63,14 @@ protected:
 public:
   ctkToolTipTrapperPrivate(ctkToolTipTrapper& object);
 
-  bool Enabled;
+  bool ToolTipsTrapped;
 };
 
 // --------------------------------------------------------------------------
 ctkToolTipTrapperPrivate::ctkToolTipTrapperPrivate(ctkToolTipTrapper& object)
   : q_ptr(&object)
 {
-  this->Enabled = false;
+  this->ToolTipsTrapped = false;
 }
 
 //------------------------------------------------------------------------------
@@ -78,15 +78,15 @@ ctkToolTipTrapper::ctkToolTipTrapper(QObject * newParent)
   : Superclass(newParent)
   , d_ptr(new ctkToolTipTrapperPrivate(*this))
 {
-  this->setEnabled(true);
+  this->setToolTipsTrapped(true);
 }
 
 //------------------------------------------------------------------------------
-ctkToolTipTrapper::ctkToolTipTrapper(bool enable, QObject * newParent)
+ctkToolTipTrapper::ctkToolTipTrapper(bool toolTipsTrapped, QObject * newParent)
   : Superclass(newParent)
   , d_ptr(new ctkToolTipTrapperPrivate(*this))
 {
-  this->setEnabled(enable);
+  this->setToolTipsTrapped(toolTipsTrapped);
 }
 
 //------------------------------------------------------------------------------
@@ -95,22 +95,22 @@ ctkToolTipTrapper::~ctkToolTipTrapper()
 }
 
 //------------------------------------------------------------------------------
-bool ctkToolTipTrapper::isEnabled()const
+bool ctkToolTipTrapper::toolTipsTrapped()const
 {
   Q_D(const ctkToolTipTrapper);
-  return d->Enabled;
+  return d->ToolTipsTrapped;
 }
 
 //------------------------------------------------------------------------------
-void ctkToolTipTrapper::setEnabled(bool enable)
+void ctkToolTipTrapper::setToolTipsTrapped(bool toolTipsTrapped)
 {
   Q_D(ctkToolTipTrapper);
-  if (enable == d->Enabled)
+  if (toolTipsTrapped == d->ToolTipsTrapped)
     {
     return;
     }
-  d->Enabled = enable;
-  if (enable)
+  d->ToolTipsTrapped = toolTipsTrapped;
+  if (toolTipsTrapped)
     {
     QCoreApplication::instance()->installEventFilter(this);
     }

Libs/Widgets/ctkToolTipTrapper.h

@@ -60,26 +60,27 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 class ctkToolTipTrapperPrivate;
 
 /// \ingroup Widgets
-/// To prevent tooltips from appearing, create an instance of this object.
+/// Filters tooltips, to prevent tooltips from appearing or to word wrap
+/// tooltips.
+/// If toolTipsTrapped is true, installs an event filter to trap tooltips.
+/// If toolTipsTrapped is false, does not install the event filter.
+/// Tooltips are trapped by default.
 class CTK_WIDGETS_EXPORT ctkToolTipTrapper : public QObject
 {
   Q_OBJECT
-  Q_PROPERTY( bool enabled READ isEnabled WRITE setEnabled)
+  Q_PROPERTY( bool toolTipsTrapped READ toolTipsTrapped WRITE setToolTipsTrapped)
 public:
   typedef QObject Superclass;
   /// Constructs a ToolTip trapper which is a child of objectParent
-  /// The trapper is enabled by default 
   explicit ctkToolTipTrapper(QObject* objectParent = 0);
-  /// Constructs a ToolTip trapper which is a child of objectParent
-  /// If enable is false, the trapper doesn't install the event filter
-  explicit ctkToolTipTrapper(bool enable, QObject* objectParent = 0);
+  explicit ctkToolTipTrapper(bool toolTipsTrapped, QObject* objectParent = 0);
   virtual ~ctkToolTipTrapper();
 
-  /// Returns true if the eventFilter is installed and ToolTip events are
+  /// Returns true if the eventFilter is installed and tooltip events are
   /// filtered
-  bool isEnabled()const;
+  bool toolTipsTrapped()const;
 
-  /// Automatically called when the tooltip is enabled. It prevents the
+  /// Automatically called when the tooltips are trapped. It prevents the
   /// tooltips events from being processed. You shouldn't have to call
   /// it manually.
   bool eventFilter(QObject* watched, QEvent* event);
@@ -87,7 +88,7 @@ public:
 public Q_SLOTS:
   /// If true, it installs the eventFilter on the application. Otherwise
   /// it removes it.
-  void setEnabled(bool enable);
+  void setToolTipsTrapped(bool toolTipsTrapped);
 
 protected:
   QScopedPointer<ctkToolTipTrapperPrivate> d_ptr;