<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kparts: KParts::StatusBarExtension Class Reference (kparts)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kparts</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KParts</b> </li>
<li class="navelem"><a class="el" href="classKParts_1_1StatusBarExtension.html">StatusBarExtension</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">KParts::StatusBarExtension Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KParts::StatusBarExtension" --><!-- doxytag: inherits="QObject" -->
<p>An extension for KParts that allows more sophisticated statusbar handling.
<a href="classKParts_1_1StatusBarExtension.html#details">More...</a></p>
<p><code>#include <<a class="el" href="statusbarextension_8h_source.html">statusbarextension.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KParts::StatusBarExtension:</div>
<div class="dyncontent">
<div class="center">
<img src="classKParts_1_1StatusBarExtension.png" usemap="#KParts::StatusBarExtension_map" alt=""/>
<map id="KParts::StatusBarExtension_map" name="KParts::StatusBarExtension_map">
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,163,24"/>
</map>
</div></div>
<p><a href="classKParts_1_1StatusBarExtension-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56aafc6bfb5890074f5d656c2cbec596"></a><!-- doxytag: member="KParts::StatusBarExtension::StatusBarExtension" ref="a56aafc6bfb5890074f5d656c2cbec596" args="(KParts::ReadOnlyPart *parent, const char *name=0L)" -->
 </td><td class="memItemRight" valign="bottom"><b>StatusBarExtension</b> (<a class="el" href="classKParts_1_1ReadOnlyPart.html">KParts::ReadOnlyPart</a> *<a class="elRef" href="qobject.html#parent">parent</a>, const char *<a class="elRef" href="qobject.html#name">name</a>=0L)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1StatusBarExtension.html#aff7f43b3ad6d835b95440fb849aec498">addStatusBarItem</a> (<a class="elRef" href="qwidget.html">QWidget</a> *widget, int stretch, bool permanent)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1StatusBarExtension.html#a7ca2fab9855765fa917b373d7b828922">removeStatusBarItem</a> (<a class="elRef" href="qwidget.html">QWidget</a> *widget)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBar.html">KStatusBar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1StatusBarExtension.html#afc65290c1f9d6ab7b8e99e24543a2c91">statusBar</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1StatusBarExtension.html#a817dc68cd8c36c77196af9d1a68c7ee2">setStatusBar</a> (<a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBar.html">KStatusBar</a> *status)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2491ec79d25c128d9dddba82f6021eb6"></a><!-- doxytag: member="KParts::StatusBarExtension::eventFilter" ref="a2491ec79d25c128d9dddba82f6021eb6" args="(QObject *watched, QEvent *ev)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>eventFilter</b> (<a class="elRef" href="qobject.html">QObject</a> *watched, <a class="elRef" href="qevent.html">QEvent</a> *ev)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKParts_1_1StatusBarExtension.html">StatusBarExtension</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1StatusBarExtension.html#ab3b379fbe78a969493bf464aa5fd16c5">childObject</a> (<a class="elRef" href="qobject.html">QObject</a> *obj)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An extension for KParts that allows more sophisticated statusbar handling. </p>
<p>Every part can use this class to customize the statusbar as long as it is active. Add items via <a class="el" href="classKParts_1_1StatusBarExtension.html#aff7f43b3ad6d835b95440fb849aec498" title="This adds a widget to the statusbar for this part.">addStatusBarItem()</a> and remove an item with <a class="el" href="classKParts_1_1StatusBarExtension.html#a7ca2fab9855765fa917b373d7b828922" title="Remove a widget from the statusbar for this part.">removeStatusBarItem()</a>.</p>
<p>IMPORTANT: do NOT add any items immediately after constructing the extension. Give the application time to set the statusbar in the extension if necessary.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>
<p>Definition at line <a class="el" href="statusbarextension_8h_source.html#l00053">53</a> of file <a class="el" href="statusbarextension_8h_source.html">statusbarextension.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aff7f43b3ad6d835b95440fb849aec498"></a><!-- doxytag: member="KParts::StatusBarExtension::addStatusBarItem" ref="aff7f43b3ad6d835b95440fb849aec498" args="(QWidget *widget, int stretch, bool permanent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StatusBarExtension::addStatusBarItem </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stretch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>permanent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This adds a widget to the statusbar for this part. </p>
<p>If you use this method instead of using <a class="el" href="classKParts_1_1StatusBarExtension.html#afc65290c1f9d6ab7b8e99e24543a2c91">statusBar()</a> directly, this extension will take care of removing the items when the parts GUI is deactivated and will re-add them when it is reactivated. The parameters are the same as <a class="elRef" href="qstatusbar.html#addWidget">QStatusBar::addWidget()</a>.</p>
<p>Note that you can't use <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBar.html">KStatusBar</a> methods (inserting text items by id) but you can create a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBarLabel.html">KStatusBarLabel</a> with a dummy id instead, and use it directly in order to get the same look and feel.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">widget</td><td>the widget to add </td></tr>
<tr><td class="paramname">stretch</td><td>the stretch factor. 0 for a minimum size. </td></tr>
<tr><td class="paramname">permanent</td><td>passed to <a class="elRef" href="qstatusbar.html#addWidget">QStatusBar::addWidget</a> as the "permanent" bool. Note that the item isn't really permanent though, it goes away when the part is unactivated. This simply controls where temporary messages hide the <code>widget</code>, and whether it's added to the left or to the right side.</td></tr>
</table>
</dd>
</dl>
<p>IMPORTANT: do NOT add any items immediately after constructing the extension. Give the application time to set the statusbar in the extension if necessary. </p>
<p>Definition at line <a class="el" href="statusbarextension_8cpp_source.html#l00150">150</a> of file <a class="el" href="statusbarextension_8cpp_source.html">statusbarextension.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab3b379fbe78a969493bf464aa5fd16c5"></a><!-- doxytag: member="KParts::StatusBarExtension::childObject" ref="ab3b379fbe78a969493bf464aa5fd16c5" args="(QObject *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKParts_1_1StatusBarExtension.html">StatusBarExtension</a> * StatusBarExtension::childObject </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Queries <code>obj</code> for a child object which inherits from this <a class="el" href="classKParts_1_1BrowserExtension.html" title="The Browser Extension is an extension (yes, no kidding) to KParts::ReadOnlyPart, which allows a bette...">BrowserExtension</a> class. </p>
<p>Convenience method. </p>
<p>Definition at line <a class="el" href="statusbarextension_8cpp_source.html#l00089">89</a> of file <a class="el" href="statusbarextension_8cpp_source.html">statusbarextension.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7ca2fab9855765fa917b373d7b828922"></a><!-- doxytag: member="KParts::StatusBarExtension::removeStatusBarItem" ref="a7ca2fab9855765fa917b373d7b828922" args="(QWidget *widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StatusBarExtension::removeStatusBarItem </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>widget</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a <code>widget</code> from the statusbar for this part. </p>
<p>Definition at line <a class="el" href="statusbarextension_8cpp_source.html#l00160">160</a> of file <a class="el" href="statusbarextension_8cpp_source.html">statusbarextension.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a817dc68cd8c36c77196af9d1a68c7ee2"></a><!-- doxytag: member="KParts::StatusBarExtension::setStatusBar" ref="a817dc68cd8c36c77196af9d1a68c7ee2" args="(KStatusBar *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StatusBarExtension::setStatusBar </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBar.html">KStatusBar</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This allows the hosting application to set a particular <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBar.html">KStatusBar</a> for this part. </p>
<p>If it doesn't do this, the statusbar used will be the one of the <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKMainWindow.html">KMainWindow</a> in which the part is embedded. Konqueror uses this to assign a view-statusbar to the part. The part should never call this method! </p>
<p>Definition at line <a class="el" href="statusbarextension_8cpp_source.html#l00145">145</a> of file <a class="el" href="statusbarextension_8cpp_source.html">statusbarextension.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afc65290c1f9d6ab7b8e99e24543a2c91"></a><!-- doxytag: member="KParts::StatusBarExtension::statusBar" ref="afc65290c1f9d6ab7b8e99e24543a2c91" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKStatusBar.html">KStatusBar</a> * StatusBarExtension::statusBar </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the statusbar of the <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKMainWindow.html">KMainWindow</a> in which this part is currently embedded. WARNING: this could return 0L </dd></dl>
<p>Definition at line <a class="el" href="statusbarextension_8cpp_source.html#l00134">134</a> of file <a class="el" href="statusbarextension_8cpp_source.html">statusbarextension.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="statusbarextension_8h_source.html">statusbarextension.h</a></li>
<li><a class="el" href="statusbarextension_8cpp_source.html">statusbarextension.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kparts</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKParts_1_1BrowserExtension.html">kparts::browserextension</option>, <option value="classKParts_1_1BrowserHostExtension.html">kparts::browserhostextension</option>, <option value="classKParts_1_1BrowserInterface.html">kparts::browserinterface</option>, <option value="classKParts_1_1BrowserRun.html">kparts::browserrun</option>, <option value="classKParts_1_1DockMainWindow.html">kparts::dockmainwindow</option>, <option value="classKParts_1_1Event.html">kparts::event</option>, <option value="classKParts_1_1Factory.html">kparts::factory</option>, <option value="classKParts_1_1GenericFactory.html">kparts::genericfactory</option>, <option value="classKParts_1_1GUIActivateEvent.html">kparts::guiactivateevent</option>, <option value="classKParts_1_1HistoryProvider.html">kparts::historyprovider</option>, <option value="classKParts_1_1LiveConnectExtension.html">kparts::liveconnectextension</option>, <option value="classKParts_1_1MainWindow.html">kparts::mainwindow</option>, <option value="classKParts_1_1OpenURLEvent.html">kparts::openurlevent</option>, <option value="classKParts_1_1Part.html">kparts::part</option>, <option value="classKParts_1_1PartActivateEvent.html">kparts::partactivateevent</option>, <option value="classKParts_1_1PartBase.html">kparts::partbase</option>, <option value="classKParts_1_1PartManager.html">kparts::partmanager</option>, <option value="classKParts_1_1PartSelectEvent.html">kparts::partselectevent</option>, <option value="classKParts_1_1Plugin.html">kparts::plugin</option>, <option value="classKParts_1_1ReadOnlyPart.html">kparts::readonlypart</option>, <option value="classKParts_1_1ReadWritePart.html">kparts::readwritepart</option>, <option value="classKParts_1_1StatusBarExtension.html">kparts::statusbarextension</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
