CTK/Libs/Widgets/ctkToolTipTrapper.cpp

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

  Library:   CTK

  Copyright (c) Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0.txt

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

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

   Program: ParaView
   Module:  ctkToolTipTrapper.cxx

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2. 

   See http://www.paraview.org/paraview/project/license.html for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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

// Qt includes
#include <QCoreApplication>
#include <QTextDocument>
#include <QWidget>

// CTK includes
#include "ctkToolTipTrapper.h"

class ctkToolTipTrapperPrivate
{
  Q_DECLARE_PUBLIC(ctkToolTipTrapper);
protected:
  ctkToolTipTrapper* const q_ptr;
public:
  ctkToolTipTrapperPrivate(ctkToolTipTrapper& object);

  enum EventFilterToDo
    {
    EVENT_FILTER_DO_NOTHING,
    EVENT_FILTER_INSTALL,
    EVENT_FILTER_REMOVE
    };

  static EventFilterToDo getEventFilterToDo(bool beforeToolTipsTrapped,
                                            bool beforeToolTipsWordWrapped,
                                            bool afterToolTipsTrapped,
                                            bool afterToolTipsWordWrapped)
    {
    bool eventFilterWasInstalled = beforeToolTipsTrapped || beforeToolTipsWordWrapped;
    bool eventFilterShouldBeInstalled = afterToolTipsTrapped || afterToolTipsWordWrapped;
    if (eventFilterWasInstalled == eventFilterShouldBeInstalled)
      {
      return EVENT_FILTER_DO_NOTHING;
      }
    else if (eventFilterShouldBeInstalled)
      {
      return EVENT_FILTER_INSTALL;
      }
    else
      {
      return EVENT_FILTER_REMOVE;
      }
    };

  bool ToolTipsTrapped;
  bool ToolTipsWordWrapped;
};

// --------------------------------------------------------------------------
ctkToolTipTrapperPrivate::ctkToolTipTrapperPrivate(ctkToolTipTrapper& object)
  : q_ptr(&object)
{
  this->ToolTipsTrapped = false;
  this->ToolTipsWordWrapped = false;
}

//------------------------------------------------------------------------------
ctkToolTipTrapper::ctkToolTipTrapper(QObject * newParent)
  : Superclass(newParent)
  , d_ptr(new ctkToolTipTrapperPrivate(*this))
{
  this->setToolTipsTrapped(true);
  this->setToolTipsWordWrapped(false);
}

//------------------------------------------------------------------------------
ctkToolTipTrapper::ctkToolTipTrapper(bool toolTipsTrapped,
                                     bool toolTipsWordWrapped,
                                     QObject * newParent)
  : Superclass(newParent)
  , d_ptr(new ctkToolTipTrapperPrivate(*this))
{
  this->setToolTipsTrapped(toolTipsTrapped);
  this->setToolTipsWordWrapped(toolTipsWordWrapped);
}

//------------------------------------------------------------------------------
ctkToolTipTrapper::~ctkToolTipTrapper()
{
}

//------------------------------------------------------------------------------
bool ctkToolTipTrapper::toolTipsTrapped()const
{
  Q_D(const ctkToolTipTrapper);
  return d->ToolTipsTrapped;
}

//------------------------------------------------------------------------------
bool ctkToolTipTrapper::toolTipsWordWrapped()const
{
  Q_D(const ctkToolTipTrapper);
  return d->ToolTipsWordWrapped;
}
//------------------------------------------------------------------------------
void ctkToolTipTrapper::setToolTipsTrapped(bool toolTipsTrapped)
{
  Q_D(ctkToolTipTrapper);
  if (toolTipsTrapped == d->ToolTipsTrapped)
    {
    return;
    }
  ctkToolTipTrapperPrivate::EventFilterToDo todo =
      ctkToolTipTrapperPrivate::getEventFilterToDo(d->ToolTipsTrapped,
                                                   d->ToolTipsWordWrapped,
                                                   toolTipsTrapped,
                                                   d->ToolTipsWordWrapped);
  d->ToolTipsTrapped = toolTipsTrapped;
  if (todo == ctkToolTipTrapperPrivate::EVENT_FILTER_INSTALL)
    {
    QCoreApplication::instance()->installEventFilter(this);
    }
  else if (todo == ctkToolTipTrapperPrivate::EVENT_FILTER_REMOVE)
    {
    QCoreApplication::instance()->removeEventFilter(this);
    }
}

//------------------------------------------------------------------------------
void ctkToolTipTrapper::setToolTipsWordWrapped(bool toolTipsWordWrapped)
{
  Q_D(ctkToolTipTrapper);
  if (toolTipsWordWrapped == d->ToolTipsWordWrapped)
    {
    return;
    }
  ctkToolTipTrapperPrivate::EventFilterToDo todo =
      ctkToolTipTrapperPrivate::getEventFilterToDo(d->ToolTipsTrapped,
                                                   d->ToolTipsWordWrapped,
                                                   d->ToolTipsTrapped,
                                                   toolTipsWordWrapped);
  d->ToolTipsWordWrapped = toolTipsWordWrapped;
  if (todo == ctkToolTipTrapperPrivate::EVENT_FILTER_INSTALL)
    {
    QCoreApplication::instance()->installEventFilter(this);
    }
  else if (todo == ctkToolTipTrapperPrivate::EVENT_FILTER_REMOVE)
    {
    QCoreApplication::instance()->removeEventFilter(this);
    }
}

//------------------------------------------------------------------------------
bool ctkToolTipTrapper::eventFilter(QObject* watched, QEvent* input_event)
{
  Q_UNUSED(watched);
  if(input_event->type() == QEvent::ToolTip
     || input_event->type() == QEvent::ToolTipChange)
    {
    Q_D(ctkToolTipTrapper);
    // Trap tooltips so that they are not shown.
    if (d->ToolTipsTrapped)
      {
      return true;
      }
    // Convert plain text to rich text to word wrap tooltips, and trigger new
    // event to show the rich tooltip.
    // If tooltip is already rich text or empty, let the regular mechanism
    // handle it.
    if (d->ToolTipsWordWrapped)
      {
      QWidget* widget = qobject_cast<QWidget *>(watched);
      if (widget && !widget->toolTip().isEmpty()
          && !Qt::mightBeRichText(widget->toolTip()))
        {
        QString richToolTip = Qt::convertFromPlainText(widget->toolTip(), Qt::WhiteSpaceNormal);
        widget->setToolTip(richToolTip);
        return true;
        }
      }
    }
  return false;
}