<?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" xml:lang="en">
<head>
<title>KRichTextWidget</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.4 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KRichTextWidget Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="../kdeui/KRichTextEdit.html">KRichTextEdit</a> → <a href="../kdeui/KTextEdit.html">KTextEdit</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qtextedit.html">QTextEdit</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qabstractscrollarea.html">QAbstractScrollArea</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qframe.html">QFrame</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />
<h2>Detailed Description</h2>
<p>A KRichTextEdit with common actions
</p>
<p>
This class implements common actions which are often used with KRichTextEdit.
All you need to do is to call createActions(), and the actions will be
added to your KXMLGUIWindow. Remember to also add the chosen actions to
your application ui.rc file.
</p>
<p>
See the KRichTextWidget.RichTextSupportValues enum for an overview of
supported actions.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Stephen Kelly <steveire@gmail.com> </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Thomas McGuire <thomas.mcguire@gmx.net> </dd></dl>
</p>
<p>
<div align="center"><img src="../images/krichtextedit.png" /><p><strong> "KDE Rich Text Widget" </strong></p></div>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#RichTextSupportValues">RichTextSupportValues</a> </td><td class="memItemRight" valign="bottom">{ DisableRichText, SupportBold, SupportItalic, SupportUnderline, SupportStrikeOut, SupportFontFamily, SupportFontSize, SupportTextForegroundColor, SupportTextBackgroundColor, FullTextFormattingSupport, SupportChangeListStyle, SupportIndentLists, SupportDedentLists, FullListSupport, SupportAlignment, SupportRuleLine, SupportHyperlinks, SupportFormatPainting, SupportToPlainText, SupportSuperScriptAndSubScript, FullSupport }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KRichTextWidget">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KRichTextWidget">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> text, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createActions">createActions</a> (self, <a href="../kdeui/KActionCollection.html">KActionCollection</a> actionCollection)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mouseReleaseEvent">mouseReleaseEvent</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qmouseevent.html">QMouseEvent</a> event)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KRichTextWidget.RichTextSupport.html">KRichTextWidget.RichTextSupport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#richTextSupport">richTextSupport</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setActionsEnabled">setActionsEnabled</a> (self, bool enabled)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRichTextSupport">setRichTextSupport</a> (self, <a href="../kdeui/KRichTextWidget.RichTextSupport.html">KRichTextWidget.RichTextSupport</a> support)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateActionStates">updateActionStates</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KRichTextWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> the parent widget
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KRichTextWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qwidget.html">QWidget</a> </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs a KRichTextWidget object
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> The initial text of the text edit, which is interpreted as
HTML.
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="createActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> createActions</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KActionCollection.html">KActionCollection</a> </td>
<td class="paramname"><em>actionCollection</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates the actions and adds them to the given action collection.
</p>
<p>
Call this before calling setupGUI() in your application, but after
calling setRichTextSupport().
</p>
<p>
The XML file of your KXmlGuiWindow needs to have the action names in
them, so that the actions actually appear in the menu and in the toolbars.
</p>
<p>
Below is a list of actions that are created,depending on the supported rich text
subset set by setRichTextSupport(). The list contains action names.
Those names need to be the same in your XML file.
</p>
<p>
See the KRichTextWidget.RichTextSupportValues enum documentation for a
detailed explaination of each action.
</p>
<p>
<table>
<tr><td><b>XML Name</b></td><td><b>RichTextSupportValues flag</b></td></tr>
<tr><td>format_text_foreground_color</td><td>SupportTextForegroundColor</td></tr>
<tr><td>format_text_background_color</td><td>SupportTextBackgroundColor</td></tr>
<tr><td>format_font_family</td><td>SupportFontFamily</td></tr>
<tr><td>format_font_size</td><td>SupportFontSize</td></tr>
<tr><td>format_text_bold</td><td>SupportBold</td></tr>
<tr><td>format_text_italic</td><td>SupportItalic</td></tr>
<tr><td>format_text_underline</td><td>SupportUnderline</td></tr>
<tr><td>format_text_strikeout</td><td>SupportStrikeOut</td></tr>
<tr><td>format_align_left</td><td>SupportAlignment</td></tr>
<tr><td>format_align_center</td><td>SupportAlignment</td></tr>
<tr><td>format_align_right</td><td>SupportAlignment</td></tr>
<tr><td>format_align_justify</td><td>SupportAlignment</td></tr>
<tr><td>format_list_style</td><td>SupportChangeListStyle</td></tr>
<tr><td>format_list_indent_more</td><td>SupportIndentLists</td></tr>
<tr><td>format_list_indent_less</td><td>SupportDedentLists</td></tr>
<tr><td>insert_horizontal_rule</td><td>SupportRuleLine</td></tr>
<tr><td>manage_link</td><td>SupportHyperlinks</td></tr>
<tr><td>format_painter</td><td>SupportFormatPainting</td></tr>
<tr><td>action_to_plain_text</td><td>SupportToPlainText</td></tr>
<tr><td>format_text_subscript & format_text_superscript</td><td>SupportSuperScriptAndSubScript</td></tr>
</table>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>actionCollection</em> </td><td> the actions will be added to this action collection
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="mouseReleaseEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mouseReleaseEvent</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qmouseevent.html">QMouseEvent</a> </td>
<td class="paramname"><em>event</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplemented.
Catches mouse release events. Used to know when a selection has been completed.
</p></div></div><a class="anchor" name="richTextSupport"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KRichTextWidget.RichTextSupport.html">KRichTextWidget.RichTextSupport</a> richTextSupport</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the supported rich text subset available.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The supported subset.
</dd></dl>
</p></div></div><a class="anchor" name="setActionsEnabled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setActionsEnabled</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enabled</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Disables or enables all of the actions created by
createActions().
This may be useful in cases where rich text mode may be set on or off.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>enabled</em> </td><td> Whether to enable or disable the actions.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setRichTextSupport"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRichTextSupport</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KRichTextWidget.RichTextSupport.html">KRichTextWidget.RichTextSupport</a> </td>
<td class="paramname"><em>support</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the supported rich text subset available.
</p>
<p>
The default is KRichTextWidget.FullSupport and will be set in the
constructor.
</p>
<p>
You need to call createActions() afterwards.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>support</em> </td><td> The supported subset.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="updateActionStates"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> updateActionStates</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Tells KRichTextWidget to update the state of the actions created by
createActions().
This is normally automatically done, but there might be a few cases where
you'll need to manually call this function.
</p>
<p>
Call this function only after calling createActions().
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="RichTextSupportValues"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">RichTextSupportValues</td>
</tr>
</table>
</div>
<div class="memdoc"><p>These flags describe what actions will be created by createActions() after
passing a combination of these flags to setRichTextSupport().
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>DisableRichText</em> = 0x00</td><td><tr><td valign="top"><em>SupportBold</em> = 0x01</td><td><tr><td valign="top"><em>SupportItalic</em> = 0x02</td><td><tr><td valign="top"><em>SupportUnderline</em> = 0x04</td><td><tr><td valign="top"><em>SupportStrikeOut</em> = 0x08</td><td><tr><td valign="top"><em>SupportFontFamily</em> = 0x10</td><td><tr><td valign="top"><em>SupportFontSize</em> = 0x20</td><td><tr><td valign="top"><em>SupportTextForegroundColor</em> = 0x40</td><td><tr><td valign="top"><em>SupportTextBackgroundColor</em> = 0x80</td><td><tr><td valign="top"><em>FullTextFormattingSupport</em> = 0xff</td><td><tr><td valign="top"><em>SupportChangeListStyle</em> = 0x100</td><td><tr><td valign="top"><em>SupportIndentLists</em> = 0x200</td><td><tr><td valign="top"><em>SupportDedentLists</em> = 0x400</td><td><tr><td valign="top"><em>FullListSupport</em> = 0xf00</td><td><tr><td valign="top"><em>SupportAlignment</em> = 0x100000</td><td><tr><td valign="top"><em>SupportRuleLine</em> = 0x400000</td><td><tr><td valign="top"><em>SupportHyperlinks</em> = 0x800000</td><td><tr><td valign="top"><em>SupportFormatPainting</em> = 0x1000000</td><td><tr><td valign="top"><em>SupportToPlainText</em> = 0x2000000</td><td><tr><td valign="top"><em>SupportSuperScriptAndSubScript</em> = 0x4000000</td><td><tr><td valign="top"><em>FullSupport</em> = 0xffffffff</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" 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>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
498
