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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>scim: scim::Attribute Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00001.html">Attribute</a></div>
<h1>scim::Attribute Class Reference<br>
<small>
[<a class="el" href="a00158.html">Accessories</a>]</small>
</h1><!-- doxytag: class="scim::Attribute" -->Class to store the string attributes.
<a href="#_details">More...</a>
<p>
<code>#include <scim_attribute.h></code>
<p>
<a href="a00236.html">List of all members.</a><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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#789c1fb1455734a4868a77a849adee90">Attribute</a> (unsigned int start=0, unsigned int length=0, <a class="el" href="a00158.html#gc9561a01d6d8ccee2697d02c223090cb">AttributeType</a> type=SCIM_ATTR_NONE, unsigned int value=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#789c1fb1455734a4868a77a849adee90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00158.html#gc9561a01d6d8ccee2697d02c223090cb">AttributeType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#e340bc1160a461d7d6b469ae5805db03">get_type</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of this attribute. <a href="#e340bc1160a461d7d6b469ae5805db03"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#3709d8f6250b5904c8d7acd3d7e82434">get_value</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of this attribute. <a href="#3709d8f6250b5904c8d7acd3d7e82434"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#fdd2557803ed8a4cae90a93a682e1050">get_start</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the start position of this attribute. <a href="#fdd2557803ed8a4cae90a93a682e1050"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#f6b9de9f753655d5b4a21743a0d32985">get_length</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the length of this attribute. <a href="#f6b9de9f753655d5b4a21743a0d32985"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#5e5eadb1906ff8fc8e8c2e2288d32ad7">get_end</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the end position of this attribute. <a href="#5e5eadb1906ff8fc8e8c2e2288d32ad7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#9d22b60c5a638c7c7645c19b1297ba81">set_type</a> (<a class="el" href="a00158.html#gc9561a01d6d8ccee2697d02c223090cb">AttributeType</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the type of this attribute. <a href="#9d22b60c5a638c7c7645c19b1297ba81"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#843db3883c46b1cbc1c7d823b401f856">set_value</a> (unsigned int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of this attribute. <a href="#843db3883c46b1cbc1c7d823b401f856"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#d3a5b3646cdd88559eca02fa5c0906c1">set_start</a> (unsigned int start)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the start position of this attribute. <a href="#d3a5b3646cdd88559eca02fa5c0906c1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#4c45eac92d7aca5d5d0e7ae71d6dfa82">set_length</a> (unsigned int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the length of this attribute. <a href="#4c45eac92d7aca5d5d0e7ae71d6dfa82"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to store the string attributes.
<p>
The string attributes control the effect of the string drawn by FrontEnds. There are currently four valid types.<p>
A attribute could be one of the following types:<ul>
<li>SCIM_ATTR_NONE No attribute</li><li>SCIM_ATTR_DECORATE Decorate attribute, eg. underline, highlight etc.</li><li>SCIM_ATTR_FOREGROUND Foreground color attribute, in RGB format.</li><li>SCIM_ATTR_BACKGROUND Background color attribute, in RGB format.</li></ul>
<p>
For a DECORATE attribute, it can be one of the following values:<ul>
<li>SCIM_ATTR_DECORATE_NONE No decorate</li><li>SCIM_ATTR_DECORATE_UNDERLINE Underline</li><li>SCIM_ATTR_DECORATE_HIGHLIGHT Highlight</li><li>SCIM_ATTR_DECORATE_REVERSE Reverse</li></ul>
<p>
For a FOREGROUND or BACKGROUND attribute, it's a RGB color value generated with SCIM_RGB_COLOR (red,green,blue) macro. You may use SCIM_RGB_COLOR_RED, SCIM_RGB_COLOR_GREEN and SCIM_RGB_COLOR_BLUE to extract the RGB color later.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="789c1fb1455734a4868a77a849adee90"></a><!-- doxytag: member="scim::Attribute::Attribute" ref="789c1fb1455734a4868a77a849adee90" args="(unsigned int start=0, unsigned int length=0, AttributeType type=SCIM_ATTR_NONE, unsigned int value=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::Attribute::Attribute </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>start</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>length</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00158.html#gc9561a01d6d8ccee2697d02c223090cb">AttributeType</a> </td>
<td class="paramname"> <em>type</em> = <code>SCIM_ATTR_NONE</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>value</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></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 valign="top"></td><td valign="top"><em>start</em> </td><td>- the start position in the string of this attribute. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>- the length of this attribute, the range is [start,start+length). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>- the type of this attribute. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the value of this attribute. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e340bc1160a461d7d6b469ae5805db03"></a><!-- doxytag: member="scim::Attribute::get_type" ref="e340bc1160a461d7d6b469ae5805db03" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00158.html#gc9561a01d6d8ccee2697d02c223090cb">AttributeType</a> scim::Attribute::get_type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of this attribute.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of this attribute. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3709d8f6250b5904c8d7acd3d7e82434"></a><!-- doxytag: member="scim::Attribute::get_value" ref="3709d8f6250b5904c8d7acd3d7e82434" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::Attribute::get_value </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of this attribute.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of this attribute. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdd2557803ed8a4cae90a93a682e1050"></a><!-- doxytag: member="scim::Attribute::get_start" ref="fdd2557803ed8a4cae90a93a682e1050" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::Attribute::get_start </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the start position of this attribute.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The start position of this attribute in the string. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f6b9de9f753655d5b4a21743a0d32985"></a><!-- doxytag: member="scim::Attribute::get_length" ref="f6b9de9f753655d5b4a21743a0d32985" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::Attribute::get_length </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the length of this attribute.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of this attribute in the string. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5e5eadb1906ff8fc8e8c2e2288d32ad7"></a><!-- doxytag: member="scim::Attribute::get_end" ref="5e5eadb1906ff8fc8e8c2e2288d32ad7" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::Attribute::get_end </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the end position of this attribute.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The end position of this attribute. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9d22b60c5a638c7c7645c19b1297ba81"></a><!-- doxytag: member="scim::Attribute::set_type" ref="9d22b60c5a638c7c7645c19b1297ba81" args="(AttributeType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::Attribute::set_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00158.html#gc9561a01d6d8ccee2697d02c223090cb">AttributeType</a> </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the type of this attribute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>- the new attribute type to be set. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="843db3883c46b1cbc1c7d823b401f856"></a><!-- doxytag: member="scim::Attribute::set_value" ref="843db3883c46b1cbc1c7d823b401f856" args="(unsigned int value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::Attribute::set_value </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the value of this attribute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the new attribute value to be set. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d3a5b3646cdd88559eca02fa5c0906c1"></a><!-- doxytag: member="scim::Attribute::set_start" ref="d3a5b3646cdd88559eca02fa5c0906c1" args="(unsigned int start)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::Attribute::set_start </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>start</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the start position of this attribute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>- the new start position in the string. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4c45eac92d7aca5d5d0e7ae71d6dfa82"></a><!-- doxytag: member="scim::Attribute::set_length" ref="4c45eac92d7aca5d5d0e7ae71d6dfa82" args="(unsigned int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::Attribute::set_length </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>length</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the length of this attribute.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>- the new length of this attribute. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00113.html">scim_attribute.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:35 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
|
