diff options
Diffstat (limited to 'old/doc/html/qtuitest-widget.html')
| -rw-r--r-- | old/doc/html/qtuitest-widget.html | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/old/doc/html/qtuitest-widget.html b/old/doc/html/qtuitest-widget.html new file mode 100644 index 0000000..7775380 --- /dev/null +++ b/old/doc/html/qtuitest-widget.html @@ -0,0 +1,200 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!-- ../../lib/qtuitestwidgetinterface.cpp --> +<head> + <title>Widget Class Reference</title> + <link href="classic.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr> +<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td> +<td width="1"> </td><td align="right" valign="top" width="230"></td></tr></table><h1 class="title">Widget Class Reference<br /><span class="small-subtitle">(QtUiTest::Widget)<br />[QtUiTestModule]</span> +</h1> +<p>The Widget class provides an abstract base class for all test widgets. <a href="#details">More...</a></p> +<pre> #include <<a href="qtuitest.html">QtUiTest</a>></pre><p><b>This class is under development and is subject to change.</b></p> +<p>Inherited by </p> +<ul> +<li><a href="qtuitest-widget-members.html">List of all members, including inherited members</a></li> +</ul> +<hr /> +<a name="public-functions"></a> +<h2>Public Functions</h2> +<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr><td class="memItemLeft" align="right" valign="top">virtual QPoint </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#center">center</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual const QObjectList & </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#children">children</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QRegion </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#childrenVisibleRegion">childrenVisibleRegion</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#ensureVisiblePoint">ensureVisiblePoint</a></b> ( const QPoint & <i>point</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#ensureVisibleRegion">ensureVisibleRegion</a></b> ( const QRegion & <i>region</i> ) = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#focusOutEvent">focusOutEvent</a></b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual Qt::FocusPolicy </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#focusPolicy">focusPolicy</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QObject * </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#focusProxy">focusProxy</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual const QRect & </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#geometry">geometry</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#grabPixmap">grabPixmap</a></b> ( QPixmap & <i>pixmap</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#hasEditFocus">hasEditFocus</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#hasFocus">hasFocus</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#height">height</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#ignoreBuddy">ignoreBuddy</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#ignoreScan">ignoreScan</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#inherits">inherits</a></b> ( QtUiTest::WidgetType <i>type</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#isVisible">isVisible</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QPoint </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#mapFromGlobal">mapFromGlobal</a></b> ( const QPoint & <i>pos</i> ) const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QPoint </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#mapToGlobal">mapToGlobal</a></b> ( const QPoint & <i>pos</i> ) const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QObject * </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#parent">parent</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QRect </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#rect">rect</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#setEditFocus">setEditFocus</a></b> ( bool <i>enable</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#setFocus">setFocus</a></b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QRegion </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#visibleRegion">visibleRegion</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#width">width</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual Qt::WindowFlags </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#windowFlags">windowFlags</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#windowTitle">windowTitle</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#x">x</a></b> () const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#y">y</a></b> () const</td></tr> +</table> +<hr /> +<a name="signals"></a> +<h2>Signals</h2> +<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qtuitest-widget.html#gotFocus">gotFocus</a></b> ()</td></tr> +</table> +<a name="details"></a> +<hr /> +<h2>Detailed Description</h2> +<p>The Widget class provides an abstract base class for all test widgets.</p> +<p>QtUiTest::Widget contains functionality which maps closely to QWidget. It encapsulates important information and functionality related to two-dimensional GUI elements.</p> +<p>All Qt Extended test widgets should implement the QtUiTest::Widget interface, using multiple inheritance to implement other <a href="qtuitest.html">QtUiTest</a> interfaces where suitable.</p> +<hr /> +<h2>Member Function Documentation</h2> +<h3 class="fn"><a name="center"></a>QPoint Widget::center () const <tt> [virtual]</tt></h3> +<p>Returns the center point of the widget. The base implementation returns <a href="qtuitest-widget.html#geometry">geometry</a>().center().</p> +<p>See also <a href="qtuitest-widget.html#geometry">QtUiTest::Widget::geometry</a>().</p> +<h3 class="fn"><a name="children"></a>const QObjectList & Widget::children () const <tt> [pure virtual]</tt></h3> +<p>Returns all children of this widget.</p> +<p>The returned objects may be actual QWidget instances, or may be wrapping test widgets. Therefore, the only safe way to use the returned objects are to cast them to the desired <a href="qtuitest.html">QtUiTest</a> interface using <a href="qtuitest.html">qtuitest_cast</a>.</p> +<p>Reimplementing this function allows widgets which are conceptually widgets but are not QObject subclasses to be wrapped. This can be achieved by returning a list of test widgets which do not necessarily have underlying QWidget instances.</p> +<p>See also QObject::children() and <a href="qtuitest-widget.html#parent">parent</a>().</p> +<h3 class="fn"><a name="childrenVisibleRegion"></a>QRegion Widget::childrenVisibleRegion () const <tt> [virtual]</tt></h3> +<p>Returns the currently on-screen, unobscured region of all child widgets of this widget, in widget coordinates. This does not include the visible region of this widget.</p> +<p>The base implementation calculates the visible region by calling <a href="qtuitest-widget.html#visibleRegion">visibleRegion</a>() and childrenVisibleRegion() on all <a href="qtuitest-widget.html#children">children</a>().</p> +<p>See also QWidget::visibleRegion(), <a href="qtuitest-widget.html#children">children</a>(), and <a href="qtuitest-widget.html#visibleRegion">visibleRegion</a>().</p> +<h3 class="fn"><a name="ensureVisiblePoint"></a>bool Widget::ensureVisiblePoint ( const QPoint & <i>point</i> )</h3> +<p>Simulate whatever user input is necessary to ensure that <i>point</i> (in local coordinates) is on-screen and unobscured.</p> +<p>This convenience function calls <a href="qtuitest-widget.html#ensureVisibleRegion">ensureVisibleRegion</a>() with a region containing only <i>point</i>.</p> +<p>Returns true if <i>point</i> was successfully made visible.</p> +<p>See also <a href="qtuitest-widget.html#visibleRegion">visibleRegion</a>() and <a href="qtuitest-widget.html#ensureVisibleRegion">ensureVisibleRegion</a>().</p> +<h3 class="fn"><a name="ensureVisibleRegion"></a>bool Widget::ensureVisibleRegion ( const QRegion & <i>region</i> ) <tt> [pure virtual]</tt></h3> +<p>Simulate whatever user input is necessary to ensure that <i>region</i> (in local coordinates) is on-screen and unobscured.</p> +<p>Returns true if <i>region</i> was successfully made visible.</p> +<p>See also <a href="qtuitest-widget.html#visibleRegion">visibleRegion</a>().</p> +<h3 class="fn"><a name="focusOutEvent"></a>void Widget::focusOutEvent () <tt> [virtual]</tt></h3> +<p>This function is called when this widget is about to lose keyboard focus. The base implementation does nothing.</p> +<p>This function should be reimplemented to put this widget in a state where subsequent up/down key clicks will result in non-destructive navigation between widgets.</p> +<p>For example, if this function is called on a combo box which currently has a list popped up, it should dismiss the list so that subsequent key clicks will navigate between widgets rather than navigating within the list.</p> +<pre> void MyComboBox::focusOutEvent() { + <span class="comment">// Assuming q is a QComboBox...</span> + <span class="comment">// If the list is currently popped up...</span> + if (q->view()->isVisible()) { + <span class="comment">// Press the Select key to commit the currently highlighted</span> + <span class="comment">// item and ensure we are ready to navigate by keys.</span> + QtUiTest::keyClick(Qt::Key_Select); + } + }</pre> +<p>See also QWidget::focusOutEvent(), <a href="qtuitest-widget.html#setFocus">setFocus</a>(), and <a href="qtuitest-widget.html#hasFocus">hasFocus</a>().</p> +<h3 class="fn"><a name="focusPolicy"></a>Qt::FocusPolicy Widget::focusPolicy () const <tt> [virtual]</tt></h3> +<p>Returns the focus policy of this widget.</p> +<p>The default implementation returns Qt::NoFocus, indicating that the widget does not accept focus.</p> +<p>See also QWidget::focusPolicy().</p> +<h3 class="fn"><a name="focusProxy"></a>QObject * Widget::focusProxy () const <tt> [virtual]</tt></h3> +<p>Returns the focus proxy of this widget, or 0 if this widget has no focus proxy. A widget may "have focus", but have a child widget that actually handles the focus.</p> +<p>The returned object may be an actual QWidget, or may be a wrapping test widget. Therefore, the only safe way to use the returned value of this function is to cast it to the desired <a href="qtuitest.html">QtUiTest</a> interface using <a href="qtuitest.html">qtuitest_cast</a>.</p> +<p>See also QWidget::focusProxy().</p> +<h3 class="fn"><a name="geometry"></a>const QRect & Widget::geometry () const <tt> [pure virtual]</tt></h3> +<p>Returns the geometry of this widget in parent coordinates.</p> +<p>See also QWidget::geometry().</p> +<h3 class="fn"><a name="gotFocus"></a>void Widget::gotFocus () <tt> [signal]</tt></h3> +<p>This signal is emitted when this widget gains focus by any means.</p> +<p>See also QApplication::focusChanged().</p> +<h3 class="fn"><a name="grabPixmap"></a>bool Widget::grabPixmap ( QPixmap & <i>pixmap</i> ) const <tt> [virtual]</tt></h3> +<p>Sets <i>pixmap</i> to image of the widget. Returns true on success.</p> +<p>The base implementation always returns false.</p> +<h3 class="fn"><a name="hasEditFocus"></a>bool Widget::hasEditFocus () const <tt> [virtual]</tt></h3> +<p>Returns true if this widget currently has edit focus.</p> +<p>The concept of edit focus only exists in Qt Embedded. This function must be implemented on Qt Embedded. On other platforms, the base implementation will return the same as <a href="qtuitest-widget.html#hasFocus">hasFocus</a>().</p> +<p>See also QWidget::hasEditFocus() and <a href="qtuitest-widget.html#setEditFocus">setEditFocus</a>().</p> +<h3 class="fn"><a name="hasFocus"></a>bool Widget::hasFocus () const <tt> [pure virtual]</tt></h3> +<p>Returns true if this widget currently has keyboard focus.</p> +<p>See also QWidget::hasFocus().</p> +<h3 class="fn"><a name="height"></a>int Widget::height () const <tt> [virtual]</tt></h3> +<p>Returns the height of the widget.</p> +<p>See also <a href="qtuitest-widget.html#geometry">geometry</a>().</p> +<h3 class="fn"><a name="ignoreBuddy"></a>bool Widget::ignoreBuddy () const <tt> [virtual]</tt></h3> +<p>Returns true if this widget should not considered a possible buddy for a label when resolving query paths.</p> +<p>Note that if the widget is returned as a buddy by QtUiTest::Label::buddy() then this value will be ignored.</p> +<p>The base implementation always returns false.</p> +<p>See also QtUiTest::Label::buddy(), <a href="qtuitest-manual.html#query-paths">Query Paths</a>, and <a href="qtuitest-manual.html#querying-objects">Querying Objects</a>.</p> +<h3 class="fn"><a name="ignoreScan"></a>bool Widget::ignoreScan () const <tt> [virtual]</tt></h3> +<p>Returns true if this widget should be ignored by <a href="qtuitest.html">QtUiTest</a>. If a widget is ignored, any child widgets will still be processed.</p> +<p>The base implementation always returns false.</p> +<p>See also <a href="qtuitest-manual.html#query-paths">Query Paths</a> and <a href="qtuitest-manual.html#querying-objects">Querying Objects</a>.</p> +<h3 class="fn"><a name="inherits"></a>bool Widget::inherits ( <a href="qtuitest.html#WidgetType-enum">QtUiTest::WidgetType</a> <i>type</i> ) const <tt> [virtual]</tt></h3> +<p>Returns true if this widget is of the given <i>type</i>.</p> +<p>The base implementation always returns false.</p> +<h3 class="fn"><a name="isVisible"></a>bool Widget::isVisible () const <tt> [pure virtual]</tt></h3> +<p>Returns true if this widget is currently visible.</p> +<p>In this context, "visible" has the same meaning as in QWidget::isVisible(). Therefore, this function returning <tt>true</tt> is not a guarantee that this widget is currently on screen and unobscured. To test this, <a href="qtuitest-widget.html#visibleRegion">visibleRegion</a>() can be used.</p> +<p>See also QWidget::isVisible() and <a href="qtuitest-widget.html#visibleRegion">visibleRegion</a>().</p> +<h3 class="fn"><a name="mapFromGlobal"></a>QPoint Widget::mapFromGlobal ( const QPoint & <i>pos</i> ) const <tt> [pure virtual]</tt></h3> +<p>Maps <i>pos</i> from global screen coordinates to widget coordinates and returns the result.</p> +<p>See also QWidget::mapFromGlobal().</p> +<h3 class="fn"><a name="mapToGlobal"></a>QPoint Widget::mapToGlobal ( const QPoint & <i>pos</i> ) const <tt> [pure virtual]</tt></h3> +<p>Maps <i>pos</i> from widget coordinates to global screen coordinates and returns the result.</p> +<p>See also QWidget::mapToGlobal().</p> +<h3 class="fn"><a name="parent"></a>QObject * Widget::parent () const <tt> [pure virtual]</tt></h3> +<p>Returns the parent of this widget, or 0 if this widget has no parent.</p> +<p>The returned object may be an actual QWidget, or may be a wrapping test widget. Therefore, the only safe way to use the returned value of this function is to cast it to the desired <a href="qtuitest.html">QtUiTest</a> interface using <a href="qtuitest.html">qtuitest_cast</a>.</p> +<p>See also QObject::parent(), QWidget::parentWidget(), and <a href="qtuitest-widget.html#children">children</a>().</p> +<h3 class="fn"><a name="rect"></a>QRect Widget::rect () const <tt> [virtual]</tt></h3> +<p>Returns the bounding rect of this widget in widget coordinates.</p> +<p>The base implementation returns <a href="qtuitest-widget.html#geometry">geometry</a>(), transformed to widget coordinates.</p> +<p>See also QWidget::rect().</p> +<h3 class="fn"><a name="setEditFocus"></a>bool Widget::setEditFocus ( bool <i>enable</i> ) <tt> [virtual]</tt></h3> +<p>Simulate the user input necessary to <i>enable</i> or disable edit focus for this widget. Enabling edit focus will implicitly call <a href="qtuitest-widget.html#setFocus">setFocus</a>() when necessary.</p> +<p>The concept of edit focus only exists in Qt Embedded. This function must be implemented when using Qt Embedded. On other platforms, this function will behave the same as <a href="qtuitest-widget.html#setFocus">setFocus</a>() when enable is true, and will have no effect when enable is false.</p> +<p>Returns true if edit focus was successfully enabled or disabled for this widget, false otherwise.</p> +<p>See also QWidget::setEditFocus() and <a href="qtuitest-widget.html#hasEditFocus">hasEditFocus</a>().</p> +<h3 class="fn"><a name="setFocus"></a>bool Widget::setFocus () <tt> [virtual]</tt></h3> +<p>Simulate the user input necessary to move keyboard focus to this widget.</p> +<p>The base implementation uses the result of <a href="qtuitest-widget.html#hasFocus">hasFocus</a>() to determine if the widget currently has focus. If in keypad mode, a sequence of Up or Down key presses will be used to move focus until this widget has focus. If in mouse mode, the center of this widget will be clicked once.</p> +<p>Due to the way this function works in keypad mode, it is very important that <a href="qtuitest-widget.html#focusOutEvent">focusOutEvent</a>() is correctly implemented for all widgets to dismiss any "grab" effects on keyboard focus.</p> +<p>When reimplementing this function, it is necessary to call <a href="qtuitest-widget.html#focusOutEvent">focusOutEvent</a>() on any widget before taking any action which could cause that widget to lose focus.</p> +<p>Returns true if focus was successfully given to this widget, false otherwise.</p> +<p>See also <a href="qtuitest-widget.html#hasFocus">hasFocus</a>(), QWidget::setFocus(), and <a href="qtuitest-widget.html#focusOutEvent">focusOutEvent</a>().</p> +<h3 class="fn"><a name="visibleRegion"></a>QRegion Widget::visibleRegion () const <tt> [pure virtual]</tt></h3> +<p>Returns the currently on-screen, unobscured region of this widget, in widget coordinates.</p> +<p>See also QWidget::visibleRegion().</p> +<h3 class="fn"><a name="width"></a>int Widget::width () const <tt> [virtual]</tt></h3> +<p>Returns the width of the widget.</p> +<p>See also <a href="qtuitest-widget.html#geometry">geometry</a>().</p> +<h3 class="fn"><a name="windowFlags"></a>Qt::WindowFlags Widget::windowFlags () const <tt> [virtual]</tt></h3> +<p>Returns the flags set on this widget.</p> +<p>The default implementation returns 0, which is equivalent to a plain Qt::Widget with no special flags set.</p> +<h3 class="fn"><a name="windowTitle"></a>QString Widget::windowTitle () const <tt> [virtual]</tt></h3> +<p>Returns the window title (caption).</p> +<p>The returned string will typically be empty for all widgets other than top-level widgets.</p> +<p>The default implementation returns an empty string.</p> +<p>See also QWidget::windowTitle().</p> +<h3 class="fn"><a name="x"></a>int Widget::x () const <tt> [virtual]</tt></h3> +<p>Returns the left of the widget, in global coordinates.</p> +<p>See also <a href="qtuitest-widget.html#mapToGlobal">mapToGlobal</a>().</p> +<h3 class="fn"><a name="y"></a>int Widget::y () const <tt> [virtual]</tt></h3> +<p>Returns the top of the widget, in global coordinates.</p> +<p>See also <a href="qtuitest-widget.html#mapToGlobal">mapToGlobal</a>().</p> +<p /><address><hr /><div align="center"> +<table width="100%" cellspacing="0" border="0"><tr class="address"> +<td width="30%" align="left">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies)</td> +<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td> +<td width="30%" align="right"><div align="right">QtUiTest</div></td> +</tr></table></div></address></body> +</html> |