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
|
<!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: FrontEnd</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><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<h1>FrontEnd</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html">scim::FrontEndError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An exception class to hold FrontEnd related errors. <a href="a00032.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html">scim::FrontEndBase</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The base class to implement the FrontEnd objects. <a href="a00031.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html">scim::FrontEndModule</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The class to manipulate the frontend modules. <a href="a00034.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Pointer< FrontEndBase > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#g0c6a34624ff51f12378c46f27a6d0801">scim::FrontEndPointer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#gb2a9aff58795913f5c415f55e60fffbd">scim::FrontEndModuleInitFunc</a> (const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a FrontEnd <a class="el" href="a00063.html">Module</a>. <a href="#gb2a9aff58795913f5c415f55e60fffbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#g672e57919352c28021d664a984850c52">scim::FrontEndModuleRunFunc</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Run a FrontEnd <a class="el" href="a00063.html">Module</a>. <a href="#g672e57919352c28021d664a984850c52"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#gf2e20b33321ec57afcc20bca767d13b2">scim::scim_get_frontend_module_list</a> (std::vector< String > &mod_list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a name list of currently available frontend modules. <a href="#gf2e20b33321ec57afcc20bca767d13b2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base classes for FrontEnd modules. <hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g0c6a34624ff51f12378c46f27a6d0801"></a><!-- doxytag: member="scim::FrontEndPointer" ref="g0c6a34624ff51f12378c46f27a6d0801" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Pointer< FrontEndBase > <a class="el" href="a00070.html">scim::FrontEndPointer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A smart pointer for <a class="el" href="a00031.html">scim::FrontEndBase</a> and its derived classes.
</div>
</div><p>
<a class="anchor" name="gb2a9aff58795913f5c415f55e60fffbd"></a><!-- doxytag: member="scim::FrontEndModuleInitFunc" ref="gb2a9aff58795913f5c415f55e60fffbd" args="(const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(*) <a class="el" href="a00162.html#gb2a9aff58795913f5c415f55e60fffbd">scim::FrontEndModuleInitFunc</a>(const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize a FrontEnd <a class="el" href="a00063.html">Module</a>.
<p>
There must be a function called "scim_frontend_module_init" in each frontend module which complies with this prototype. This function name can have a prefix like x11_LTX_, in which "x11" is the module's name.<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>backend</em> </td><td>- a BackEnd instance which hold all IMEngineFactory instances. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>- a <a class="el" href="a00014.html">ConfigBase</a> instance to maintain the configuration. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g672e57919352c28021d664a984850c52"></a><!-- doxytag: member="scim::FrontEndModuleRunFunc" ref="g672e57919352c28021d664a984850c52" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(*) <a class="el" href="a00162.html#g672e57919352c28021d664a984850c52">scim::FrontEndModuleRunFunc</a>(void) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Run a FrontEnd <a class="el" href="a00063.html">Module</a>.
<p>
There must be a function called "scim_frontend_module_run" in each frontend module which complies with this prototype. This function name can have a prefix like x11_LTX_, in which "x11" is the module's name.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gf2e20b33321ec57afcc20bca767d13b2"></a><!-- doxytag: member="scim::scim_get_frontend_module_list" ref="gf2e20b33321ec57afcc20bca767d13b2" args="(std::vector< String > &mod_list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::scim_get_frontend_module_list </td>
<td>(</td>
<td class="paramtype">std::vector< String > & </td>
<td class="paramname"> <em>mod_list</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a name list of currently available frontend modules.
<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>mod_list</em> </td><td>- the result list will be stored here. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of the modules, equal to mod_list.size (). </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:30 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>
|
