vcs.maemo.org Git - mdictionary/blob - www/devhowto.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4         <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
   5         <meta http-equiv="content-language" content="EN" />
   6         <meta name="description" content="Home page for mDictionary project -
   7                     mobile multilingual dictionary for maemo.org platform
   8                     (previously known as a 'WhiteStork')" />
   9         <meta name="keywords" content="mdictionary whitestork maemo n770
  10                     n800 n810 dictionary xdxf stardict mobile linux comarch" />
  11         <meta name="language" content="English" />
  12         <meta name="owner" content="ComArch S.A." />
  13         <meta name="copyright" content="ComArch, 2006-2007. All rights Reserved."/>
  14
  15         <link rel="shortcut icon" href="images/favicon.png" type="image/x-icon"></link>
  16         <link rel="stylesheet" href="styles/main.css" type="text/css"></link>
  17         <!--[if IE 6]>
  18                 <link rel="stylesheet"
  19                       type="text/css"
  20                       href="styles/main_ie.css" />
  21
  22                 <script src="scripts/pngfix.js" type="text/javascript"></script>
  23         <![endif]-->
  24         <script language="JavaScript" src="scripts/javascripts.js" ></script>
  25
  26         <title>
  27                 mDictionary - multilingual dictionary for Maemo
  28         </title>
  29 </head>
  30 <body>
  31 <div id="webContainer">
  32         <div id="topBar">
  33                 <img src="images/mLogo_ie24.png" style="float:left;"></img>
  34         <div class="installs">
  35                 INSTALL:
  36                 <a href="files/mdictionary.install"
  37                    class="install" style="margin-top:4px;"
  38                    title="Click to install mDictionary on OS2006"><span>OS2006</span>
  39                 </a>
  40                 <a href="files/mdictionary.install"
  41                    class="install" style="clear:both; margin-top:4px;"
  42                    title="Click to install mDictionary on OS2007"><span style="letter-spacing:0px;">OS2007</span>
  43                 </a>
  44                 <a href="files/mdictionary2008.install"
  45                    class="install" style="clear:both; margin-top:4px;"
  46                    title="Click to install mDictionary on OS2008"><span style="letter-spacing:0px;">OS2008</span>
  47                 </a>
  48                 <span style="clear:both;text-align:center;display:block;font-size:9px;"><a href="howto.html" style="font-size:9px;text-decoration:none;">(read How To... first)</a></span>
  49         </div>
  50                 <div style="display:block;height:100px;">
  51                         <p class="title">
  52                                 mDictionary
  53                         </p>
  54                         <p class="description">
  55                                 multilingual dictionary for <a href="http://www.maemo.org" target="_blank"><img align="top" border="0" src="images/maemo_logo.png" ></a>(N770, N800 &amp; N810)
  56                         </p>
  57                         <p class="description">
  58                                 &nbsp; and <a href="http://www.meego.com" target="_blank"><img align="top" border="0" src="images/Meego.png" width="80" height="20" ></a> (N900 & netbook )
  59                         </p>
  60                 </div>
  61                 <div id="topBarLinks">
  62                         <a href="index.html" >Home</a>
  63                         <a href="download.html">Download</a>
  64                         <a href="qmlelements.html">QML Elements</a>
  65                         <a href="howto.html">How to..</a>
  66                         <a href="screen800.html">Screenshots</a>
  67                         <a href="userguide.html">User Guide</a>
  68                         <a href="faq.html">FAQ</a>
  69                         <a href="devhowto.html" class="current" >Development</a>
  70                         <a href="contact.html">Contact</a>
  71                 </div>
  72         </div>
  73         <div id="contentContainer">
  74
  75
  76                 <h1>Developer's HOWTO:<br />making Your own plugin</h1>
  77                         The manual is available <a href="files/doc-plugin.1.0.4.odt">here</a>
  78
  79                 <h1>Developer's HOWTO:<br />making Your own GUI (new version of mDictionary)</h1>
  80                         The manual isn't available yet
  81
  82                 <h1>Developer's HOWTO:<br />making Your own GUI for mDictionary (old versien of mDictionary)</h1>
  83
  84 <p><b>mDictionary</b> is intended to be as modifiable as possible. So apart from developing Your own dictionary engines, You can also create alternative user interface, should You find ours inattractive. For the intrepid ones, I have described how to do that. In this howto, I am going to explain how to communicate GUI with the engines's manager</p>
  85
  86 <p>The only header file You need to include in Your GUI is <span class="code">ws_dbus.h</span>. It contains all the functions necessary to communicate with the engines manager. The header file is available from our svn repository at <a href="https://garage.maemo.org">https://garage.maemo.org</a>.</p>
  87 <p>Firstly, You initialize our dbus wrapper library with <span class="code">ws_dbus_create</span> function. You have to specify the name and the version of Your app and store the function's return value as it is necessary for further dbus wrapper communication.</p>
  88
  89 <div class="code">dbus_data = ws_dbus_create ("mDictionaryGui", "v1.0");</div>
  90 <p>
  91 Then You configure the remote and local addresses, by using <span class="code">ws_dbus_config</span>. The settings should be the same as in the example, below:
  92
  93 </p>
  94 <div class="code">ws_dbus_config( dbus_data,
  95                 WS_DBUS_CONFIG_SERVICE,
  96                 "org.maemo.mDictionaryGui" );
  97 ws_dbus_config( dbus_data,
  98                 WS_DBUS_CONFIG_OBJECT,
  99                 "/org/maemo/mDictionaryGui" );
 100 ws_dbus_config( dbus_data,
 101                 WS_DBUS_CONFIG_IFACE,
 102                 "org.maemo.mDictionaryGui" );
 103 ws_dbus_config( dbus_data,
 104                 WS_DBUS_CONFIG_REMOTE_SERVICE,
 105                 "org.maemo.mDictionaryManager" );
 106 ws_dbus_config( dbus_data,
 107                 WS_DBUS_CONFIG_REMOTE_OBJECT,
 108                 "/org/maemo/mDictionaryManager" );
 109 ws_dbus_config( dbus_data,
 110                 WS_DBUS_CONFIG_REMOTE_IFACE,
 111                 "org.maemo.mDictionaryManager" );</div>
 112 <p>
 113 Now You have to call the <span class="code">ws_dbus_connect</span> function. It's an opaque function, which allows local methods to be run remotely.
 114 </p>
 115 <div class="code">ws_dbus_connect( dbus_data );</div>
 116 <p>
 117 The only thing that's left now is specifying callback functions (with <span class="code">ws_dbus_set_cb</span>), which are to be called
 118 whenever the manager calls a remote method.
 119 </p>
 120 <div class="code">ws_dbus_set_cb( dbus_data,
 121                 "return_words",
 122                 ws_gui_dbus_return_words,
 123                 ws_gui_app );</div>
 124
 125 <p>Callbacks definition:</p>
 126
 127 <div class="code">void ws_gui_dbus_return_words( GError *error,
 128                                GArray *words,
 129                                gpointer user_data );</div>
 130
 131 <p class="faq_question">
 132 Accessing received data inside a callback handling function:
 133 </p>
 134
 135 <p>
 136 In this case, words is a <span class="code">GArray</span> of <span class="code">osso_rpc_t</span> values. To access the contents of an <span class="code">osso_rpc_t</span> variable, You first have to check its type by accessing the type field. The value field is an union of primitives. Depending on the type, You should read the value by accessing a proper field. Here is an example:
 137 </p>
 138
 139 <div class="code">int i;
 140 osso_rpc_t data;
 141 for (i = 0; i < words->len; ++i)
 142 {
 143         data = g_array_index (words, osso_rpc_t, 0);
 144         if (DBUS_TYPE_STRING == data.type)
 145         {
 146                 char *tmp_word = g_strdup(data.value.s);
 147                 do_sth_with_word(tmp_word);
 148         };
 149 };
 150 </div>
 151 <p class="faq_question">
 152         Calling remote methods on manager:
 153 </p>
 154 <div class="code">ws_dbus_client_find_word (ws_gui_app->dbus_data, word);</div>
 155 <p>
 156 All functions containing the word client in their name, should be called from the GUI application.
 157
 158 Please refer to dbus wrapper API documentation for further info. It can be generated by issuing <span class="code">make docs</span> command in dbus wrapper source directory.
 159 </p>
 160
 161 </div>
 162         <div id="footer">
 163                         <p>Copyright &copy; 2006 - 2008 ComArch S.A.</p>
 164                         <br>
 165                         <a href="http://www.comarch.com"><img src="images/comarch.png"
 166                              alt="ComArch Information Technology"
 167                              width="150px"
 168                              height="36px"
 169                                  border="0"
 170                                  >
 171                         </a>
 172                 </div>
 173         </div>
 174 </div>
 175 <br>
 176 </body>
 177 </html>