Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > by-pkgid > 6282078ae76a671f49c6af38c67b1a07 > files > 2181

kdelibs-devel-2.2.2-49.2mdk.i586.rpm

<HTML>
<HEAD>
<TITLE>class Part</TITLE>

<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
	<TABLE BORDER="0">
		<TR><TD valign="top" align="left" cellspacing="10">
		<h1>class Part</h1>
		</TD>
		<TD valign="top" align="right" colspan="1">
 Base class for parts. <small><A HREF="#longdesc">More...</A></small></TD></TR>
	</TABLE>
	<HR>
	<TABLE BORDER="0">
		<TR><TH>Full name</TH><TD><code><A HREF="KParts.html">KParts</A>::Part</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="part_h.html">part.h</A>&gt;</code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="KParts__PartBase.html">KParts::PartBase</A> <small>[public ]</small>, <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> <small>(qt)</small> <small>[public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><i><A HREF="KParts__ReadOnlyPart.html">ReadOnlyPart</A></i>, <i><A HREF="KParts__ReadWritePart.html">ReadWritePart</A></i></TD></TR>
<TR><TH><A HREF="full-list-KParts__Part.html">List of all Methods</A></TH></TR>
	</TABLE>
	</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI>&nbsp;<b><A HREF="#ref1">Part</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> *parent = 0, const char* name = 0 ) 
</LI>
<LI>virtual  &nbsp;<b><A HREF="#ref2">~Part</A></b> () 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref3">embed</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> * parentWidget ) 
</LI>
<LI>virtual  <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *&nbsp;<b><A HREF="#ref4">widget</A></b> () 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref5">setManager</A></b> ( PartManager * manager ) 
</LI>
<LI>PartManager * &nbsp;<b><A HREF="#ref6">manager</A></b> () 
</LI>
<LI>virtual  Part *&nbsp;<b><A HREF="#ref7">hitTest</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *widget, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpoint.html">QPoint</A> &globalPos ) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref8">setSelectable</A></b> ( bool selectable ) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref9">isSelectable</A></b> ()  const
</LI>
</ul><h4>Signals</h4><ul><LI>void &nbsp;<b><A HREF="#ref10">setWindowCaption</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> & caption ) 
</LI>
<LI>void &nbsp;<b><A HREF="#ref11">setStatusBarText</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> & text ) 
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual  void &nbsp;<b><A HREF="#ref12">setWidget</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> * widget ) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref13">event</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qevent.html">QEvent</A> *event ) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref14">partActivateEvent</A></b> ( PartActivateEvent *event ) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref15">partSelectEvent</A></b> ( PartSelectEvent *event ) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref16">guiActivateEvent</A></b> ( GUIActivateEvent *event ) 
</LI>
<LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *&nbsp;<b><A HREF="#ref17">hostContainer</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> &containerName ) 
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
 Base class for parts.
</p>
<p> A "part" is a GUI component, featuring:
</p>

<ul>
<li>A widget embeddedable in any application.
</li>
<li>GUI elements that will be merged in the "host" user interface
 (menubars, toolbars... ).
</li>
</ul>

<p>
</p>
<p></p>

<H3>About the widget
 Note that <A HREF="KParts__Part.html">KParts::Part</A> does not inherit <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>.
 This is due to the fact that the "visual representation"
 will probably not be a mere <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>, but an elaborate one.
 That's why when implementing your <A HREF="KParts__Part.html">KParts::Part</A> (or derived)
 you should call <A HREF="KParts__Part.html#setWidget">KParts::Part::setWidget</A>() in your constructor.
</H3>
<p>
</p>
<p></p>

<H3>About the GUI elements
 Those elements trigger actions, defined by the part (action()).
 The layout of the actions in the GUI is defined by an XML file (setXMLFile()).
</H3>
<p>
</p>
<p> See also <A HREF="KParts__ReadOnlyPart.html">ReadOnlyPart</A> and <A HREF="KParts__ReadWritePart.html">ReadWritePart</A>, which define the
 framework for a "viewer" part and for an "editor"-like part.
 Use Part directly only if your part doesn't fit into those.
 </p>
<A NAME="Part"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>Part</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> *parent = 0, const char* name = 0 )
<br></td><td align="right"><h3><strong>Part</strong></h3></td></tr></table><p></p><p>
  Constructor.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">Parent object of the part.
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">QT-internal name of the part.
     </TD></TR>
</TABLE></P>
<A NAME="~Part"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> &nbsp;<strong>~Part</strong> ()
<br></td><td align="right"><h3><strong>~Part</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
  Destructor.
     </p>
<A NAME="embed"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>embed</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> * parentWidget )
<br></td><td align="right"><h3><strong>embed</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Embed this part into a host widget.
</p>
<p> You don't need to do this if you created the widget with the
 correct parent widget - this is just a <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html#0589b7">QWidget::reparent</A>().
 Note that the <A HREF="KParts__Part.html#Part">Part</A> is still the holder
 of the <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>, meaning that if you delete the <A HREF="KParts__Part.html#Part">Part</A>,
 then the widget gets destroyed as well, and vice-versa.
 This method is not recommended since creating the widget with the correct
 parent is simpler anyway.
     </p>
<A NAME="widget"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *&nbsp;<strong>widget</strong> ()
<br></td><td align="right"><h3><strong>widget</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
</p>
<p><b>Returns</b>: The widget defined by this part, set by <A HREF="KParts__Part.html#setWidget">setWidget</A>().
     </p>
<A NAME="setManager"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setManager</strong> ( PartManager * manager )
<br></td><td align="right"><h3><strong>setManager</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Used by the part manager.
     </p>
<A NAME="manager"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>PartManager * &nbsp;<strong>manager</strong> ()
<br></td><td align="right"><h3><strong>manager</strong></h3></td></tr></table><p></p><p>
 Returns the part manager handling this part, if any (0L otherwise).
     </p>
<A NAME="hitTest"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Part *&nbsp;<strong>hitTest</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *widget, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qpoint.html">QPoint</A> &globalPos )
<br></td><td align="right"><h3><strong>hitTest</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
     </p>
<A NAME="setSelectable"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setSelectable</strong> ( bool selectable )
<br></td><td align="right"><h3><strong>setSelectable</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>selectable</i></TD><TD align="left" valign="top">Indicates whether the part is selectable or not.
     </TD></TR>
</TABLE></P>
<A NAME="isSelectable"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>isSelectable</strong> ()
<br></td><td align="right"><h3><strong>isSelectable</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
  Returns whether the part is selectable or not.
     </p>
<A NAME="setWindowCaption"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>setWindowCaption</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> & caption )
<br></td><td align="right"><h3><strong>setWindowCaption</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
 Emitted by the part, to set the caption of the window(s)
 hosting this part
     </p>
<A NAME="setStatusBarText"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>setStatusBarText</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> & text )
<br></td><td align="right"><h3><strong>setStatusBarText</strong></h3></td></tr></table><p> <small>[signal]</small></p><p>
 Emited by the part, to set a text in the statusbar of the window(s)
 hosting this part
     </p>
<A NAME="setWidget"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>setWidget</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> * widget )
<br></td><td align="right"><h3><strong>setWidget</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Set the main widget.
</p>
<p> Call this in the Part-inherited class constructor.
     </p>
<A NAME="event"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>event</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qevent.html">QEvent</A> *event )
<br></td><td align="right"><h3><strong>event</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
     </p>
<p>Reimplemented from <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html#c8b023">QObject</A>.</p>
<A NAME="partActivateEvent"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>partActivateEvent</strong> ( PartActivateEvent *event )
<br></td><td align="right"><h3><strong>partActivateEvent</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Convenience method which is called when the Part received a <A HREF="KParts__PartActivateEvent.html">PartActivateEvent</A> .
 Reimplement this if you don't want to reimplement <A HREF="KParts__Part.html#event">event</A> and test for the event yourself
 or even install an event filter.
     </p>
<A NAME="partSelectEvent"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>partSelectEvent</strong> ( PartSelectEvent *event )
<br></td><td align="right"><h3><strong>partSelectEvent</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Convenience method which is called when the Part received a
 <A HREF="KParts__PartSelectEvent.html">PartSelectEvent</A> .
 Reimplement this if you don't want to reimplement <A HREF="KParts__Part.html#event">event</A> and
 test for the event yourself or even install an event filter.
     </p>
<A NAME="guiActivateEvent"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>guiActivateEvent</strong> ( GUIActivateEvent *event )
<br></td><td align="right"><h3><strong>guiActivateEvent</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Convenience method which is called when the Part received a
 <A HREF="KParts__GUIActivateEvent.html">GUIActivateEvent</A> .
 Reimplement this if you don't want to reimplement <A HREF="KParts__Part.html#event">event</A> and
 test for the event yourself or even install an event filter.
     </p>
<A NAME="hostContainer"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A> *&nbsp;<strong>hostContainer</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> &containerName )
<br></td><td align="right"><h3><strong>hostContainer</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Convenience method for <A HREF="../kdeui/KXMLGUIFactory.html#container">KXMLGUIFactory::container</A>.
</p>
<p><b>Returns</b>: a container widget owned by the Part's GUI.
     </p>
<HR>
	<table>
	<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:25 2002, using kdoc 2.0a53.</small></td></tr>
	</table>
</BODY>
</HTML>