Widgets and other classes to interact with tested application
=============================================================

.. currentmodule:: funq.models

The Widget base class
---------------------

A Widget is often obtained with :meth:`funq.client.FunqClient.widget` .

Example::
  
  my_widget = self.funq.widget('my_widget')

.. autoclass:: Widget
  
  .. automethod:: Widget.properties
  
  .. automethod:: Widget.set_properties
  
  .. automethod:: Widget.set_property
  
  .. automethod:: Widget.wait_for_properties
  
  .. automethod:: Widget.click
  
  .. automethod:: Widget.dclick
  
  .. automethod:: Widget.keyclick
  
  .. automethod:: Widget.shortcut
  
  .. automethod:: Widget.drag_n_drop
  
  .. automethod:: Widget.close
  
  .. automethod:: Widget.call_slot

Interacting with the data of QT Model/View framework
----------------------------------------------------

To interact with items in QAbstractTableModel, it is needed to get the
associated view (QAbstractItemView). The returned instance will be of type
:class:`AbstractItemView` and the data will then be retrievable with
the :meth:`AbstractItemView.model_items` method.

Example::
  
  view = self.funq.widget('my_tableview')
  assert isinstance(view, AbstractItemView)
  
  model_items = view.model_items()
  item = model_items.item_by_named_path(['item1'])
  
  item.dclick()


.. inheritance-diagram:: AbstractItemView

.. autoclass:: AbstractItemView
  
  .. automethod:: AbstractItemView.model_items
  
  .. automethod:: AbstractItemView.current_editor


.. autoclass:: ModelItems
  
  .. automethod:: ModelItems.iter
  
  .. automethod:: ModelItems.item_by_named_path
  
  .. automethod:: ModelItems.row_by_named_path


.. autoclass:: ModelItem
  
  .. automethod:: ModelItem.select
  
  .. automethod:: ModelItem.edit
  
  .. automethod:: ModelItem.click
  
  .. automethod:: ModelItem.dclick
  
  .. automethod:: ModelItem.is_checkable
  
  .. automethod:: ModelItem.is_checked

Interacting with the data of QT Graphics View framework
-------------------------------------------------------

Handling QGraphicsItems data is quite similar to handling data of
the Models/Views framework.

It requires the associated view (an instance of QGraphicsView). In funq
the widget will be an instance of :class:`GraphicsView` and the data will
be available with the :meth:`GraphicsView.gitems` method.

Example::
  
  gview = self.funq.widget('my_gview')
  
  gitems = gview.gitems()
  
  for item in gitems.iter():
      # do something with item


.. inheritance-diagram:: GraphicsView

.. autoclass:: GraphicsView
  
  .. automethod:: GraphicsView.gitems
  
  .. automethod:: GraphicsView.dump_gitems


.. autoclass:: GItems
  
  .. automethod:: GItems.iter

.. autoclass:: GItem
  
  .. automethod:: GItem.is_qobject
  
  .. automethod:: GItem.properties
  
  .. automethod:: GItem.click
  
  .. automethod:: GItem.dclick

Other widgets
-------------

.. inheritance-diagram:: TabBar

.. autoclass:: TabBar
  
  .. automethod:: TabBar.tab_texts
  
  .. automethod:: TabBar.set_current_tab


.. inheritance-diagram:: ComboBox

.. autoclass:: ComboBox
  
  .. automethod:: ComboBox.model_items
  
  .. automethod:: ComboBox.set_current_text