Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 3cd8ed2ba8c8318377f50d8a76dbe3c4 > files > 37

kdebase-devel-doc-3.5.9-36mdv2008.1.x86_64.rpm

<?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>kate: Kate::DockViewBase Class Reference (kate)</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=".">kate</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.5.5 -->
  <div class="navpath"><a class="el" href="namespaceKate.html">Kate</a>::<a class="el" href="classKate_1_1DockViewBase.html">DockViewBase</a>
  </div>
<div class="contents">
<h1>Kate::DockViewBase Class Reference</h1><!-- doxytag: class="Kate::DockViewBase" --><!-- doxytag: inherits="QVBox" --><code>#include &lt;<a class="el" href="dockviewbase_8h-source.html">dockviewbase.h</a>&gt;</code>
<p>
Inherits QVBox.
<p>
Inherited by Kate::ListboxView, and Kate::MessageView.
<p>

<p>
<a href="classKate_1_1DockViewBase-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for dockwidget views This class creates a widget meant to be set as the main widget for a KDockWidget. 
<p>
This class provides a title in two parts, titlePrefix and title. The size policies are set so that neither will prevent resizing the view to a width smaller than the texts, the titlePrefix (on the left) will remain fully visible for as long as possible.<p>
Use the titlePrefix to describe the nature of the view contents, for example "Messages".<p>
Use the title to inform the user what is currently in the view, for example the name of a related file, a command or similar.<p>
To add widgets, just create them with this as the parent.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Anders Lund &lt;<a href="mailto:anders@alweb.dk">anders@alweb.dk</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="dockviewbase_8h-source.html#l00053">53</a> of file <a class="el" href="dockviewbase_8h-source.html">dockviewbase.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#b3a4bd4c39cdf2b78b222d59c645da1e">DockViewBase</a> (QWidget *parent=0, const char *name=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#9098d6769f9bfdfdf4827db3fee41f02">DockViewBase</a> (const QString &amp;prefix, const QString &amp;title, QWidget *parent=0, const char *name=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#8e33df103cf405ff96c0c9eab93f76bc">setTitlePrefix</a> (const QString &amp;prefix)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#043982a677d839bcef8b7bbc753051fc">titlePrefix</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#0804d4313f3955732d1010898c70e61a">setTitle</a> (const QString &amp;title)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#a66ccfe91112e68e4bd1f0a514dfe5ae">setTitle</a> (const QString &amp;prefix, const QString &amp;title)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1DockViewBase.html#97d5d3f5ae3a454b1a5265adcb08b77b">title</a> () const </td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b3a4bd4c39cdf2b78b222d59c645da1e"></a><!-- doxytag: member="Kate::DockViewBase::DockViewBase" ref="b3a4bd4c39cdf2b78b222d59c645da1e" args="(QWidget *parent=0, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Kate::DockViewBase::DockViewBase           </td>
          <td>(</td>
          <td class="paramtype">QWidget *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a KateDockViewBase. 
<p>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00039">39</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="9098d6769f9bfdfdf4827db3fee41f02"></a><!-- doxytag: member="Kate::DockViewBase::DockViewBase" ref="9098d6769f9bfdfdf4827db3fee41f02" args="(const QString &amp;prefix, const QString &amp;title, QWidget *parent=0, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Kate::DockViewBase::DockViewBase           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>prefix</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>title</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QWidget *&nbsp;</td>
          <td class="paramname"> <em>parent</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a KateDockViewBase with the title prefix <code>prefix</code> and the title <code>title</code>. 
<p>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00046">46</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8e33df103cf405ff96c0c9eab93f76bc"></a><!-- doxytag: member="Kate::DockViewBase::setTitlePrefix" ref="8e33df103cf405ff96c0c9eab93f76bc" args="(const QString &amp;prefix)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Kate::DockViewBase::setTitlePrefix           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>prefix</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the title prefix to <code>prefix</code>. 
<p>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00058">58</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="043982a677d839bcef8b7bbc753051fc"></a><!-- doxytag: member="Kate::DockViewBase::titlePrefix" ref="043982a677d839bcef8b7bbc753051fc" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Kate::DockViewBase::titlePrefix           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The title prefix. </dd></dl>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00064">64</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="0804d4313f3955732d1010898c70e61a"></a><!-- doxytag: member="Kate::DockViewBase::setTitle" ref="0804d4313f3955732d1010898c70e61a" args="(const QString &amp;title)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Kate::DockViewBase::setTitle           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>title</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the title to <code>title</code>. 
<p>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00069">69</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="a66ccfe91112e68e4bd1f0a514dfe5ae"></a><!-- doxytag: member="Kate::DockViewBase::setTitle" ref="a66ccfe91112e68e4bd1f0a514dfe5ae" args="(const QString &amp;prefix, const QString &amp;title)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Kate::DockViewBase::setTitle           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>prefix</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>title</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience method, sets both the prefix and title. 
<p>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00080">80</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="97d5d3f5ae3a454b1a5265adcb08b77b"></a><!-- doxytag: member="Kate::DockViewBase::title" ref="97d5d3f5ae3a454b1a5265adcb08b77b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Kate::DockViewBase::title           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the title of the KateDockViewBase </dd></dl>

<p>Definition at line <a class="el" href="dockviewbase_8cpp-source.html#l00075">75</a> of file <a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="dockviewbase_8h-source.html">dockviewbase.h</a><li><a class="el" href="dockviewbase_8cpp-source.html">dockviewbase.cpp</a></ul>
</div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kate</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="classKate_1_1Application.html">kate::application</option>,  <option value="classKate_1_1DockViewBase.html">kate::dockviewbase</option>,  <option value="classKate_1_1DocumentManager.html">kate::documentmanager</option>,  <option value="classKate_1_1PluginManager.html">kate::pluginmanager</option>,  <option value="classKate_1_1ToolViewManager.html">kate::toolviewmanager</option>,  <option value="classKate_1_1ViewManager.html">kate::viewmanager</option>,  <option value="classKateApp.html">kateapp</option>,  <option value="classKateConsole.html">kateconsole</option>,  <option value="classKateExternalTool.html">kateexternaltool</option>,  <option value="classKateExternalToolAction.html">kateexternaltoolaction</option>,  <option value="classKateExternalToolsCommand.html">kateexternaltoolscommand</option>,  <option value="classKateExternalToolsConfigWidget.html">kateexternaltoolsconfigwidget</option>,  <option value="classKateExternalToolServiceEditor.html">kateexternaltoolserviceeditor</option>,  <option value="classKateExternalToolsMenuAction.html">kateexternaltoolsmenuaction</option>,  <option value="classKateMailDialog.html">katemaildialog</option>,  <option value="classKateMDI_1_1Splitter.html">katemdi::splitter</option>,  <option value="classKateMwModOnHdDialog.html">katemwmodonhddialog</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kwin/html/index.html">kwin</a></li><li>&nbsp;&nbsp;<a href="../../kwin/lib/html/index.html">lib</a></li><li><a href="../../libkonq/html/index.html">libkonq</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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>