File: qtextlength.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (144 lines) | stat: -rw-r--r-- 9,999 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtextformat.cpp -->
  <title>Qt 4.8: QTextLength Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QTextLength</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QTextLength Class Reference</h1>
<!-- $$$QTextLength-brief -->
<p>The QTextLength class encapsulates the different types of length used in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextLength -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QTextLength&gt;</span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qtextlength-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#Type-enum">Type</a></b> { VariableLength, FixedLength, PercentageLength }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#QTextLength">QTextLength</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#QTextLength-2">QTextLength</a></b> ( Type <i>type</i>, qreal <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#rawValue">rawValue</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Type </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#type">type</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#value">value</a></b> ( qreal <i>maximumLength</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#operator-QVariant">operator QVariant</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#operator-not-eq">operator!=</a></b> ( const QTextLength &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextlength.html#operator-eq-eq">operator==</a></b> ( const QTextLength &amp; <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QTextLength-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextLength class encapsulates the different types of length used in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>When we specify a value for the length of an element in a text document, we often need to provide some other information so that the length is used in the way we expect. For example, when we specify a table width, the value can represent a fixed number of pixels, or it can be a percentage value. This information changes both the meaning of the value and the way it is used.</p>
<p>Generally, this class is used to specify table widths. These can be specified either as a fixed amount of pixels, as a percentage of the containing frame's width, or by a variable width that allows it to take up just the space it requires.</p>
</div>
<p><b>See also </b><a href="qtexttable.html">QTextTable</a>.</p>
<!-- @@@QTextLength -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Type$$$VariableLength$$$FixedLength$$$PercentageLength -->
<h3 class="fn"><a name="Type-enum"></a>enum QTextLength::<span class="name">Type</span></h3>
<p>This enum describes the different types a length object can have.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QTextLength::VariableLength</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The width of the object is variable</td></tr>
<tr><td class="topAlign"><tt>QTextLength::FixedLength</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The width of the object is fixed</td></tr>
<tr><td class="topAlign"><tt>QTextLength::PercentageLength</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The width of the object is in percentage of the maximum width</td></tr>
</table>
<p><b>See also </b><a href="qtextlength.html#type">type</a>().</p>
<!-- @@@Type -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextLength[overload1]$$$QTextLength -->
<h3 class="fn"><a name="QTextLength"></a>QTextLength::<span class="name">QTextLength</span> ()</h3>
<p>Constructs a new length object which represents a variable size.</p>
<!-- @@@QTextLength -->
<!-- $$$QTextLength$$$QTextLengthTypeqreal -->
<h3 class="fn"><a name="QTextLength-2"></a>QTextLength::<span class="name">QTextLength</span> ( <span class="type"><a href="qtextlength.html#Type-enum">Type</a></span> <i>type</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>value</i> )</h3>
<p>Constructs a new length object of the given <i>type</i> and <i>value</i>.</p>
<!-- @@@QTextLength -->
<!-- $$$rawValue[overload1]$$$rawValue -->
<h3 class="fn"><a name="rawValue"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextLength::<span class="name">rawValue</span> () const</h3>
<p>Returns the constraint value that is specific for the type of the length. If the length is <a href="qtextlength.html#Type-enum">QTextLength::PercentageLength</a> then the raw value is in percent, in the range of 0 to 100. If the length is <a href="qtextlength.html#Type-enum">QTextLength::FixedLength</a> then that fixed amount is returned. For variable lengths, zero is returned.</p>
<!-- @@@rawValue -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qtextlength.html#Type-enum">Type</a></span> QTextLength::<span class="name">type</span> () const</h3>
<p>Returns the type of this length object.</p>
<p><b>See also </b><a href="qtextlength.html#Type-enum">QTextLength::Type</a>.</p>
<!-- @@@type -->
<!-- $$$value[overload1]$$$valueqreal -->
<h3 class="fn"><a name="value"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextLength::<span class="name">value</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>maximumLength</i> ) const</h3>
<p>Returns the effective length, constrained by the type of the length object and the specified <i>maximumLength</i>.</p>
<p><b>See also </b><a href="qtextlength.html#type">type</a>().</p>
<!-- @@@value -->
<!-- $$$operator QVariant[overload1]$$$operator QVariant -->
<h3 class="fn"><a name="operator-QVariant"></a>QTextLength::<span class="name">operator QVariant</span> () const</h3>
<p>Returns the text length as a <a href="qvariant.html">QVariant</a></p>
<!-- @@@operator QVariant -->
<!-- $$$operator!=[overload1]$$$operator!=constQTextLength& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QTextLength::<span class="name">operator!=</span> ( const <span class="type">QTextLength</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if this text length is different from the <i>other</i> text length.</p>
<!-- @@@operator!= -->
<!-- $$$operator==[overload1]$$$operator==constQTextLength& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QTextLength::<span class="name">operator==</span> ( const <span class="type">QTextLength</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if this text length is the same as the <i>other</i> text length.</p>
<!-- @@@operator== -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>