Metadata-Version: 2.1
Name: qwebtip
Version: 0.1.0
Summary: A Qt package that lets you use web URLs as tooltips in Qt widgets
Home-page: https://github.com/ColinKennedy/qwebtip
Author: Colin Kennedy
Author-email: colinvfx@gmail.com
License: BSD 2-Clause License
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities

========
Overview
========



A Qt package that lets you use web URLs as tooltips in Qt widgets.

* Free software: BSD 2-Clause License


Requires
========

PySide or PyQt4 with QtWebKit


Installation
============

::

    pip install qwebtip


How To Use
==========


Simply import qwebtip's main model, `qweburltip` and set it to override one of
your widget's tooltips with some URL.

The next time you build your application and hover over that widget, a URL box
will be displayed, instead.


.. code:: python

   from qwebtip import qweburltip

   url = 'http://pyqt.sourceforge.net/Docs/PyQt4/qwebframe.html'
   qweburltip.override_tool_tip(QtWidgets.QLabel('Some label'), url)


How To Use - Customizing
========================


Setting a custom tooltip size

.. code:: python

   from qwebtip import qweburltip

   url = 'http://pyqt.sourceforge.net/Docs/PyQt4/qwebframe.html'
   qweburltip.override_tool_tip(
      QtWidgets.QLabel('Some label'),
      url,
      width=100,
      height=400,
   )

Opening the URL at a specific header section


.. code:: python

   url = 'http://pyqt.sourceforge.net/Docs/PyQt4/qwebframe.html'
   qweburltip.override_tool_tip(
      self.line_edit,
      element_selector.UnknownHeaderSelector(
          url,
          'Method Documentation',
      ),
   )


Disabling Caching
=================

Loaded webpages are cached so that successive loads can be kept fast.
To disable caching, simply set the following environment variable.


.. code:: bash

   export QWEBTIP_DISABLE_CACHING=1

This is useful for debugging but is not generally not recommended.


Changelog
=========

0.1.0 (2018-12-04)
------------------

* First release on PyPI.


