<?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>KTextEditor.Attribute</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.9 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>Attribute Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Inherits: QTextCharFormat → QTextFormat<br />
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>A class which provides customized text decorations.
</p>
<p>
The Attribute class extends QTextCharFormat, the class which Qt
uses internally to provide formatting information to characters
in a text document.
</p>
<p>
In addition to its inherited properties, it provides support for:
<li> several customized text formatting properties </li>
<li> dynamic highlighting of associated ranges of text </li>
<li> binding of actions with associated ranges of text (note: not currently implemented) </li>
</p>
<p>
Implementations are not required to support all properties.
In particular, several properties are not supported for dynamic
highlighting (notably: font() and fontBold()).
</p>
<p>
Unfortunately, as QTextFormat's setProperty() is not virtual,
changes that are made to this attribute cannot automatically be
redrawn. Once you have finished changing properties, you should
call changed() to force redrawing of affected ranges of text.
</p>
<p>
\sa SmartInterface
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Hamish Rodda <rodda@kde.org> </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="#ActivationType">ActivationType</a> </td><td class="memItemRight" valign="bottom">{ ActivateMouseIn, ActivateCaretIn }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#CustomProperties">CustomProperties</a> </td><td class="memItemRight" valign="bottom">{ Outline, SelectedForeground, SelectedBackground, BackgroundFillWhitespace, AttributeDynamicEffect, AttributeInternalProperty, AttributeUserProperty }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Effect">Effect</a> </td><td class="memItemRight" valign="bottom">{ EffectNone, EffectFadeIn, EffectFadeOut, EffectPulse, EffectCycleGradient }</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="#Attribute">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Attribute">__init__</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> a)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdeui/KAction.html">KAction</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#associatedActions">associatedActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#backgroundFillWhitespace">backgroundFillWhitespace</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clear">clear</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearAssociatedActions">clearAssociatedActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KTextEditor::Attribute> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dynamicAttribute">dynamicAttribute</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#effects">effects</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#fontBold">fontBold</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasAnyProperty">hasAnyProperty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator +=">operator +=</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> a)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QBrush </td><td class="memItemRight" valign="bottom"><a class="el" href="#outline">outline</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QBrush </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedBackground">selectedBackground</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QBrush </td><td class="memItemRight" valign="bottom"><a class="el" href="#selectedForeground">selectedForeground</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setBackgroundFillWhitespace">setBackgroundFillWhitespace</a> (self, bool fillWhitespace)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDynamicAttribute">setDynamicAttribute</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> type, KSharedPtr<KTextEditor::Attribute> attribute)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEffects">setEffects</a> (self, <a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> effects)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFontBold">setFontBold</a> (self, bool bold=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setOutline">setOutline</a> (self, QBrush brush)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSelectedBackground">setSelectedBackground</a> (self, QBrush brush)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSelectedForeground">setSelectedForeground</a> (self, QBrush foreground)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Attribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</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>Default constructor. The resulting Attribute has no properties set to begin with.
</p></div></div><a class="anchor" name="Attribute"></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="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> </td>
<td class="paramname"><em>a</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Copy constructor.
</p></div></div><a class="anchor" name="associatedActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdeui/KAction.html">KAction</a>] associatedActions</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 a list of currently associated KAction%s.
</p></div></div><a class="anchor" name="backgroundFillWhitespace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool backgroundFillWhitespace</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>Determine whether background color is drawn over whitespace. Defaults to true if not set.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> whether the background color should be drawn over whitespace
</dd></dl>
</p></div></div><a class="anchor" name="clear"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clear</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>Clear all set properties.
</p></div></div><a class="anchor" name="clearAssociatedActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearAssociatedActions</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>Clears all associations between KAction%s and this attribute.
</p></div></div><a class="anchor" name="dynamicAttribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<KTextEditor::Attribute> dynamicAttribute</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="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> </td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Return the attribute to use when the event referred to by <b>type</b> occurs.
</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>type</em> </td><td> the activation type for which to return the Attribute.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the attribute to be used for events specified by <b>type,</b> or null if none is set.
</dd></dl>
</p></div></div><a class="anchor" name="effects"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> effects</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="fontBold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool fontBold</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>Find out if the font weight is set to QFont.Bold.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the font weight is exactly QFont.Bold, otherwise false
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QTextCharFormat.fontWeight()
</dd></dl>
</p></div></div><a class="anchor" name="hasAnyProperty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasAnyProperty</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>Determine if any properties are set.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if any properties are set, otherwise false
</dd></dl>
</p></div></div><a class="anchor" name="operator +="></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> operator +=</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="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute</a> </td>
<td class="paramname"><em>a</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Addition assignment operator. Use this to merge another Attribute with this Attribute.
Where both attributes have a particular property set, the property in <b>a</b> will
be used.
</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>a</em> </td><td> attribute to merge into this attribute.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="outline"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QBrush outline</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>Get the brush used to draw an outline around text, if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> brush to be used to draw an outline, or Qt.NoBrush if no outline is set.
</dd></dl>
</p></div></div><a class="anchor" name="selectedBackground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QBrush selectedBackground</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>Get the brush used to draw the background of selected text, if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> brush to be used to draw the background of selected text, or Qt.NoBrush if not set
</dd></dl>
</p></div></div><a class="anchor" name="selectedForeground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QBrush selectedForeground</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>Get the brush used to draw text when it is selected, if any.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> brush to be used to draw selected text, or Qt.NoBrush if not set
</dd></dl>
</p></div></div><a class="anchor" name="setBackgroundFillWhitespace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setBackgroundFillWhitespace</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>fillWhitespace</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set whether background color is drawn over whitespace. Defaults to true if not set.
</p>
<p>
Use <b>clearProperty(BackgroundFillWhitespace)</b> to clear.
</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>fillWhitespace</em> </td><td> whether the background should be drawn over whitespace.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setDynamicAttribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDynamicAttribute</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="../ktexteditor/KTextEditor.Attribute.html#ActivationType">KTextEditor.Attribute.ActivationType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">KSharedPtr<KTextEditor::Attribute> </td>
<td class="paramname"><em>attribute</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the attribute to use when the event referred to by <b>type</b> occurs.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> Nested dynamic attributes are ignored.
</dd></dl> </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>type</em> </td><td> the activation type to set the attribute for
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>attribute</em> </td><td> the attribute to assign. As attribute is refcounted, ownership is not an issue.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setEffects"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setEffects</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="../ktexteditor/KTextEditor.Attribute.html">KTextEditor.Attribute.Effects</a> </td>
<td class="paramname"><em>effects</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setFontBold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setFontBold</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>bold=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the font weight to QFont.Bold. If <b>bold</b> is <b>false,</b> the weight will be set to 0 (normal).
</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>bold</em> </td><td> whether the font weight should be bold or not.
</td></tr>
</table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> QTextCharFormat.setFontWeight()
</dd></dl>
</p></div></div><a class="anchor" name="setOutline"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setOutline</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">QBrush </td>
<td class="paramname"><em>brush</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a brush to be used to draw an outline around text.
</p>
<p>
Use <b>clearProperty(Outline)</b> to clear.
</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>brush</em> </td><td> brush to be used to draw an outline.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setSelectedBackground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSelectedBackground</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">QBrush </td>
<td class="paramname"><em>brush</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a brush to be used to draw the background of selected text, if any.
</p>
<p>
Use <b>clearProperty(SelectedBackground)</b> to clear.
</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>brush</em> </td><td> brush to be used to draw the background of selected text
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setSelectedForeground"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSelectedForeground</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">QBrush </td>
<td class="paramname"><em>foreground</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a brush to be used to draw selected text.
</p>
<p>
Use <b>clearProperty(SelectedForeground)</b> to clear.
</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>foreground</em> </td><td> brush to be used to draw selected text.
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ActivationType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ActivationType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Several automatic activation mechanisms exist for associated attributes.
Using this you can conveniently have your ranges highlighted when either
the mouse or cursor enter the range.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ActivateMouseIn</em> = 0</td><td><tr><td valign="top"><em>ActivateCaretIn</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="CustomProperties"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">CustomProperties</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Custom property types, which may or may not be supported by implementations.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Outline</em> = QTextFormat::UserProperty</td><td><tr><td valign="top"><em>SelectedForeground</em> </td><td><tr><td valign="top"><em>SelectedBackground</em> </td><td><tr><td valign="top"><em>BackgroundFillWhitespace</em> </td><td><tr><td valign="top"><em>AttributeDynamicEffect</em> = 0x10A00</td><td><tr><td valign="top"><em>AttributeInternalProperty</em> = 0x10E00</td><td><tr><td valign="top"><em>AttributeUserProperty</em> = 0x110000</td><td></table>
</dl>
</div></div><p><a class="anchor" name="Effect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Effect</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Dynamic effects for display.
To do: Pulse and CycleGradient are unclear.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>EffectNone</em> = 0x0</td><td><tr><td valign="top"><em>EffectFadeIn</em> = 0x1</td><td><tr><td valign="top"><em>EffectFadeOut</em> = 0x2</td><td><tr><td valign="top"><em>EffectPulse</em> = 0x4</td><td><tr><td valign="top"><em>EffectCycleGradient</em> = 0x8</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>
