Translation by Artem Sereda with my minor changes
[kde-ru.git] / docs / koffice / kugar / progguide.docbook
blobb137c39ee3d441660a7fc59950c5f0f7ab677ccf
1 <!-- If you want to validate or edit this document separately, uncomment
2 this prolog
4 <?xml version="1.0" ?>
5 <!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd">
7 -->
9 <chapter id="prog-guide">
10 <chapterinfo>
11 <authorgroup>
12 <author
13 ><firstname
14 >Alexander</firstname
15 > <surname
16 >Dymo</surname
17 > <affiliation
18 > <address
19 ><email
20 >cloudtemple@mksat.net </email
21 ></address>
22 </affiliation>
23 </author>
24 <author
25 ><firstname
26 >Phil</firstname
27 > <surname
28 >Thompson</surname
29 > <affiliation
30 > <address
31 ><email
32 >phil@river-bank.demon.co.uk </email
33 ></address>
34 </affiliation>
35 </author>
36 <othercredit role="translator"
37 ><firstname
38 >Олег</firstname
39 ><surname
40 >Баталов</surname
41 ><affiliation
42 ><address
43 ><email
44 >olegbatalov@mail.ru</email
45 ></address
46 ></affiliation
47 ><contrib
48 >Перевод на русский язык</contrib
49 ></othercredit
50
51 </authorgroup>
52 </chapterinfo>
53 <title
54 >Руководство программиста</title>
56 <sect1 id="how-to-use-in-progs">
57 <title
58 >Как использовать &kugar; в ваших программах для создания отчётов</title>
60 <itemizedlist>
61 <title
62 >Существуют несколько способов использования &kugar;</title>
63 <listitem>
64 <para
65 >Создать временный файл и заполнить его данными, организованными согласно <link linkend="kugardata-dtd"
66 >Определению типа документа (DTD) KugarData</link
67 >. Затем вызвать в командной оболочке <command
68 > kugar</command
69 > (<cmdsynopsis
70 > <command
71 >kugar</command
72 > <group
73 > <option
74 >-d <replaceable
75 >файл данных Kugar</replaceable
76 ></option
77 > </group
78 ><group
79 > <option
80 >-r <replaceable
81 >Файл шаблона Kugar </replaceable
82 > </option
83 > </group
84 > </cmdsynopsis
85 >) для предварительного просмотра и распечатки отчёта. Подробноt описание смотрите в разделе <link linkend="prog-using-for-preview"
86 >Использование оболочки &kugar; для предварительного просмотра отчётов</link
87 > </para>
88 </listitem>
89 <listitem>
90 <para
91 >Использовать &kugar; непосредственно в коде приложения. Смотрите подробности в разделе <link linkend="prog-using-widget"
92 >Использование классов &kugar; в отчётах</link
93 >  </para>
94 </listitem>
95 <listitem>
96 <para
97 >Создать модуль дизайнера &Qt;, и использовать его для создания приложений &GUI; в дизайнере и подключать его к программе динамически. Подробности смотрите в разделе <link linkend="prog-designer-plugin"
98 >Создание модулей дизайнера &Qt;</link
99 >. </para>
100 </listitem>
101 </itemizedlist>
103 <para
104 >Два последних метода приемлемы для разработчиков &Qt; и &kde;, но &kugar; спроектирован генератором отчётов, независящим от языка программирования и/или <acronym
105 >IDE</acronym
106 >. Он использует формат &XML; для описания шаблона отчёта и фала данных. Так что любая программа может произвести вывод в в формат файла данных &kugar;, как описано в <link linkend="kugardata-dtd"
107 >KugarData <acronym
108 >DTD</acronym
109 ></link
110 > или даже в формат файла шаблона отчёта (см. <link linkend="template-dtd"
111 >KugarTemplate <acronym
112 >DTD</acronym
113 ></link
114 >). Оболочка &kugar; (программа просмотра отчётов) может использоваться для предварительного просмотра и печати созданных отчётов. </para>
116 </sect1>
118 <sect1 id="prog-using-for-preview">
119 <title
120 >Использование оболочки &kugar; для предварительного просмотра отчётов</title>
122 <orderedlist>
123 <title
124 >Способ создания и предварительного просмотра (печати) отчёта состоит из:</title>
125 <listitem>
126 <para
127 >Создания с помощью &kudesigner; шаблона отчёта. </para>
128 </listitem>
129 <listitem>
130 <para
131 >Создания файла данных со значениями столбцов для секций в отчёте. Используя <link linkend="kugardata-dtd"
132 >KugarData <acronym
133 >DTD</acronym
134 ></link
135 > для производства корректных файлов данных. </para>
136 </listitem>
137 <listitem>
138 <para
139 >Выполнения оболочки &kugar;  для предварительного просмотра и печати отчёта. Например, для этого в языке C или C++ вызовите:</para>
141 <programlisting
142 ><function
143 >system(<option
144 >"kugar -r <replaceable
145 >template_file.kut</replaceable
146 >-d <replaceable
147 >data_file.kud</replaceable
148 >"</option
149 >)</function
150 >. 
151 </programlisting>
153 <para
154 >Не забудьте включить файл <filename class="headerfile"
155 >stdlib.h</filename
156 >. </para>
157 </listitem>
158 </orderedlist>
159 </sect1>
161 <sect1 id="prog-using-widget">
162 <title
163 >Использования в отчётах классов &kugar;</title>
164 <para
165 >Библиотека &kugar; включает два класса визуальных элементов для использования. </para>
166 <para
167 >Класс <classname
168 >KReportViewer</classname
169 > предназначен для разработчиков &kde;. Он поддерживает систему печати &kde; и локализацию &UNIX;  через вызовы функции <function
170 >i18n()</function
171 >. </para>
172 <para
173 ><classname
174 >MReportViewer</classname
175 > предназначен для разработчиков &Qt; и предоставляет реальную кросс+платформенность. Он может использоваться не только на платформах &UNIX;, но также и на &Windows; и &MacOS;. </para>
176 <para
177 >Чтобы создать программу, использующую библиотеку &kugar;, она должна быть связана с разделяемой библиотекой <filename
178 >libkugar.so</filename
179 >, которая обеспечивает работу &kugar; на всех платформах &UNIX;. </para>
180 <para
181 >Включить файлы <filename
182 >kugarqt.h</filename
183 > и <filename
184 >kugar.h</filename
185 > для программ &Qt; и &kde; соответственно. </para>
186 <para
187 >Для подробных примеров использования классов &kugar;, смотрите каталог <filename class="directory"
188 >/shell</filename
189 > в исходных текстах &kugar;. </para>
190 <para
191 ><classname
192 >MReportViewer</classname
193 > (а также <classname
194 >KReportViewer</classname
195 >) содержат несколько открытых методов, которые можно использовать. </para>
196 <funcsynopsis>
197 <funcprototype>
198 <funcdef
199 >void <function
200 >renderReport</function
201 > </funcdef>
202 <void/>
203 </funcprototype>
204 <funcsynopsisinfo
205 >Вывести отчёт на экран.</funcsynopsisinfo>
206 </funcsynopsis>
208 <funcsynopsis>
209 <funcprototype>
210 <funcdef
211 >void <function
212 >printReport</function
213 ></funcdef>
214 <void/>
215 </funcprototype>
216 <funcsynopsisinfo
217 >Вызвать диалог печати для распечатки отчёта.</funcsynopsisinfo>
218 </funcsynopsis>
220 <funcsynopsis>
221 <funcprototype>
222 <funcdef
223 >void <function
224 >clearReport</function
225 ></funcdef>
226 <void/>
227 </funcprototype>
228 <funcsynopsisinfo
229 >Очистить отчёт на экране и удалить его данные. Вызывайте его перед открытием нового отчёта.</funcsynopsisinfo>
230 </funcsynopsis>
232 <funcsynopsis>
233 <funcprototype
234 ><funcdef
235 >bool <function
236 >setReportData</function
237 ></funcdef
238 > <paramdef
239 >const QString &amp;<parameter
240 >data_file_name</parameter
241 ></paramdef
242 > </funcprototype>
243 <funcsynopsisinfo
244 >Установить данные отчёте из файла <replaceable
245 >data_file_name</replaceable
246 >.</funcsynopsisinfo>
247 </funcsynopsis>
249 <funcsynopsis>
250 <funcprototype
251 ><funcdef
252 >bool <function
253 >setReportData</function
254 ></funcdef
255 > <paramdef
256 >const QIODevice &amp;<parameter
257 >data_io_device</parameter
258 ></paramdef
259 > </funcprototype>
260 <funcsynopsisinfo
261 >Установить данные отчёта из файла <replaceable
262 >data_io_device</replaceable
263 >. Устройство IO может быть любым преемником класса <classname
264 >QIODevice</classname
265 >. Например, для получения записей непосредственно из базы данных, создайте преемника <classname
266 >QIODevice</classname
267 > и переопределите у него необходимую функциональность. </funcsynopsisinfo>
268 </funcsynopsis>
270 <funcsynopsis>
271 <funcprototype
272 ><funcdef
273 >bool <function
274 >setReportTemplate</function
275 ></funcdef
276 > <paramdef
277 >const QString &amp;<parameter
278 >template_file_name</parameter
279 ></paramdef
280 >  </funcprototype>
281 <funcsynopsisinfo
282 >Установить шаблон отчёта из файла <replaceable
283 >template_file_name</replaceable
284 ></funcsynopsisinfo>
285 </funcsynopsis>
287 <funcsynopsis>
288 <funcprototype
289 ><funcdef
290 >bool <function
291 >setReportTemplate</function
292 ></funcdef
293 > <paramdef
294 >const QIODevice &amp;<parameter
295 >template_io_device</parameter
296 ></paramdef
297 > </funcprototype>
298 <funcsynopsisinfo
299 >Установить шаблон отчёта из файла <replaceable
300 >template_io_device</replaceable
301 >. Устройство IO может быть любым преемником класса  <classname
302 >QIODevice</classname
303 >. Например, для получения шаблона отчёта из сети или базы данных, создайте преемника <classname
304 >QIODevice</classname
305 > и переопределите у него  необходимую функциональность. </funcsynopsisinfo>
306 </funcsynopsis>
308 </sect1>
310 <sect1 id="prog-designer-plugin">
311 <title
312 >Создание модуля дизайнера &Qt;</title>
314 <para
315 >Этот код примера создан как дополнение к модулю дизайнера. Код ниже создаёт модуль для графического элемента &kde; <classname
316 >KReportViewer</classname
317 >. </para>
319 <para
320 >Если желателен графический элемент &Qt;, замените <classname
321 >KReportViewer</classname
322 > на <classname
323 >MReportViewer</classname
324 > и <filename
325 >kugar.h</filename
326 > на <filename
327 >kugarqt.h</filename
328 > в коде модуля. </para>
330 <sect2 id="plugin-usage">
331 <title
332 >Использование модуля</title>
333 <para
334 >Модули дизайнера позволят использовать Дизайнер &Qt;  для помещения графического элемента <classname
335 >KReportViewer</classname
336 > в окно, и корректно просматривать его. </para>
338 <para
339 >Программы, которые используют этот модуль, должны быть динамически с ним связаны. Соответствующая библиотека называется <filename
340 >libkugar_plugin.so</filename
341 >.  Графические элементы или диалоги, которые включают графический элемент <classname
342 >KReportViewer</classname
343 > должны включать &lt;kugar.h&gt; в реализацию и иметь предварительно описание класса <classname
344 >class KReportViewer</classname
345 >. Включения могут быть сделаны с помощью Исследователь объектов дизайнера &Qt; (вкладка источник). </para>
347 <para
348 >Для создание модуля выполните: <cmdsynopsis
349 ><command
350 >qmake</command
351 > <arg
352 >kugar_plugin.pro</arg
353 > </cmdsynopsis>
354 <cmdsynopsis>
355 <command
356 >make</command>
357 </cmdsynopsis>
358 </para>
360 </sect2>
362 <sect2 id="plugin-code">
363 <title
364 >Код модуля</title>
366 <segmentedlist>
367 <title
368 >Код модуля находится в трёх файлах:</title>
369 <segtitle
370 ><link linkend="plugin-h-source"
371 >kugar_plugin.h</link
372 ></segtitle>
373 <segtitle
374 ><link linkend="plugin-cpp-source"
375 >kugar_plugin.cpp</link
376 ></segtitle>
377 <segtitle
378 ><link linkend="plugin-pro-source"
379 >kugar_plugin.pro</link
380 ></segtitle>
381 <seglistitem>
382 <seg
383 >Заголовочный файл для <classname
384 >KugarWidgetPlugin</classname
385 >, производного класса от <classname
386 >QWidgetPlugin</classname
387 >;</seg>
388 <seg
389 >Исходный файл для <classname
390 >KugarWidgetPlugin</classname
391 >, производного класса от <classname
392 >QWidgetPlugin</classname
393 >;</seg>
394 <seg
395 >Файл проекта <application
396 >QMake</application
397 >.</seg>
398 </seglistitem>
399 </segmentedlist>
401 <sect3 id="plugin-h-source">
402 <title
403 >kugar_plugin.h</title>
405 <programlisting
406 >#include &lt;qwidgetplugin.h
407 >&gt;
409 class KugarWidgetPlugin:public QWidgetPlugin
411 public:
412   KugarWidgetPlugin ();
414   QStringList keys () const;
415   QWidget *create (const QString &amp; classname, QWidget * parent =
416                    0, const char *name = 0);
417   QString group (const QString &amp;) const;
418   QIconSet iconSet (const QString &amp;) const;
419   QString includeFile (const QString &amp;) const;
420   QString toolTip (const QString &amp;) const;
421   QString whatsThis (const QString &amp;) const;
422   bool isContainer (const QString &amp;) const;
424 </programlisting>
425 </sect3>
428 <sect3 id="plugin-cpp-source">
429 <title
430 >kugar_plugin.cpp</title>
432 <programlisting
433 >#include "kugar_plugin.h"
434 #include &lt;kugar.h&gt;
436 static const char *kugar_pixmap[] = {
437   "22 22 127 2",
438   ".d c #000000",
439   ".c c #131313",
440   ".b c #282828",
441   ".a c #434241",
442   ".e c #4e463a",
443   ".# c #595551",
444   ".G c #66553b",
445   "#F c #68635f",
446   "#R c #6b4f23",
447   "#q c #6e6862",
448   "#M c #6f5229",
449   ".n c #6f6146",
450   ".w c #735310",
451   ".V c #755c2a",
452   ".I c #775f34",
453   ".0 c #77694a",
454   "#n c #7e6434",
455   ".o c #806f50",
456   "#C c #835d2d",
457   ".P c #837c75",
458   "#B c #85653a",
459   "#k c #85827e",
460   ".x c #866d46",
461   ".U c #877967",
462   ".X c #888888",
463   ".F c #89724d",
464   "#x c #8b6d2a",
465   ".S c #8d7759",
466   ".z c #8e733b",
467   "#L c #906e49",
468   "#Q c #947b56",
469   ".r c #948058",
470   ".J c #957844",
471   ".4 c #987736",
472   ".q c #998969",
473   ".k c #999897",
474   ".R c #9a8a75",
475   "#i c #9f8348",
476   "#I c #a37c4b",
477   ".u c #a38d66",
478   ".E c #a58558",
479   "#A c #a8834b",
480   ".s c #a9967a",
481   ".t c #aa9467",
482   ".C c #ae9f8d",
483   "#6 c #afa49d",
484   "#5 c #afa9a4",
485   "#W c #b18e4d",
486   ".K c #b1935a",
487   ".B c #b39660",
488   "#V c #b49866",
489   "#a c #b49d6c",
490   "## c #b49d72",
491   ".j c #b5b4b4",
492   "#0 c #b7a597",
493   ".O c #b9b1a9",
494   ".L c #bb9c61",
495   ".M c #bb9e6b",
496   ".A c #bca778",
497   "#j c #bea46b",
498   ".T c #bfb37d",
499   ".v c #c0b391",
500   ".W c #c3a262",
501   ".i c #c4c4c4",
502   "#m c #c5b7aa",
503   "#8 c #c69f80",
504   ".D c #c6b79b",
505   "#3 c #c7a589",
506   ".7 c #c7a76c",
507   "#u c #c7bbaf",
508   ".6 c #c8ad74",
509   "#7 c #c8b7a9",
510   "#r c #c8beb5",
511   ".m c #c8c8c8",
512   "#U c #cbad96",
513   "#f c #ccb681",
514   "#h c #cdac6c",
515   "#P c #cdb49f",
516   "#X c #cdb8a6",
517   "#H c #ceb7a4",
518   ".y c #ceb892",
519   ".N c #cecac3",
520   "#Z c #cfb16f",
521   "#O c #cfbdad",
522   ".Z c #cfc7c0",
523   "#w c #d0bcab",
524   ".5 c #d1ad6b",
525   "#s c #d1bfb1",
526   ".h c #d5d5d5",
527   "#l c #d6cdc6",
528   "#D c #d8b36e",
529   ".H c #dac592",
530   "#t c #dbb977",
531   ".g c #dcdcdc",
532   ".1 c #e0dcc1",
533   ".f c #e0e0df",
534   "#1 c #e3c8b1",
535   "#S c #e4cdb9",
536   ".3 c #e4d9a3",
537   "#4 c #e6c1a1",
538   "#2 c #e7c4a5",
539   "#K c #e9c179",
540   "#g c #e9c47e",
541   "#Y c #e9c8ac",
542   ".2 c #eae6c0",
543   "#T c #ebcdb3",
544   ".Q c #ebd4b9",
545   "#E c #ecca87",
546   "#z c #ecd799",
547   ".l c #ececeb",
548   "#G c #efd7c2",
549   "#e c #efe3ab",
550   ".8 c #efe8e3",
551   "#v c #f1dcca",
552   "#. c #f2e2d4",
553   ".p c #f4f4f4",
554   "#y c #f5daa0",
555   "#J c #f6cf7f",
556   ".9 c #f7ede4",
557   "#p c #f9d995",
558   ".Y c #fcf9f6",
559   "#d c #fefcc5",
560   "#c c #fefdda",
561   "#b c #fefee1",
562   "#N c #ffd685",
563   "#o c #fff0a9",
564   "Qt c #ffffff",
565   "QtQtQtQtQtQt.#.a.a.a.b.b.b.c.c.d.d.dQtQtQtQt",
566   "QtQtQtQtQtQt.e.f.g.g.f.g.g.h.i.j.d.k.dQtQtQt",
567   "QtQtQtQtQtQt.a.gQtQtQtQtQtQt.l.f.c.m.k.dQtQt",
568   "QtQtQtQtQt.n.n.n.n.n.o.g.pQtQt.l.bQt.m.k.dQt",
569   "QtQtQt.q.q.r.q.s.t.r.q.u.u.g.pQt.a.fQt.m.k.d",
570   "QtQt.s.s.v.w.x.y.y.t.z.A.t.B.i.p.#.a.b.c.d.d",
571   "Qt.C.C.D.E.F.G.A.H.F.I.J.K.L.M.i.p.l.N.O.P.d",
572   "Qt.s.v.Q.q.R.S.T.A.R.U.V.L.W.W.X.g.Y.f.Z.k.d",
573   ".0.s.t.Q.1.U.R.2.3.S.U.4.5.6.6.7.j.8.9#..O.d",
574   ".G##.V#a#b.1#c#c#d#e#f#g#h#i#j.W#k#l.9#.#m.d",
575   ".G.4.F#n#c#c#c#d#d#o#p#g.x.w#i.L#q#r#.#.#s.d",
576   ".e.J.J.I.3#d.H#j.6#f#p#t#n.w.E.L#q#u#.#v#w.d",
577   ".G.A#x.z#y#z#A#B#B#C#D#E.4.4.6#h#F#m#v#G#H.d",
578   ".o.s.A#j#E#t#I#I#I#C#A#J#p#p#K#t#F#m#v#G#H.d",
579   "Qt##.A.6.7#I#I#A.E#L#M.W#N#J#K.a.U#O#G.Q#P.d",
580   "Qt#a.M.L.J#A#I.4.E#Q.x#R#D#J#g.#.C#S.Q#T#U.d",
581   "QtQt#V.K.z#Q.s.S.x.S#B#M#W#E.a.U#X.Q#T#Y#U.d",
582   "QtQtQt.M#i#B.r#Q#Q.r#Q.z#Z.a#q#0#1#T#Y#2#3.d",
583   "QtQtQtQtQt#j.L.L.W.5#t.a.#.U#0#1#T#Y#2#4#3.d",
584   "QtQtQtQtQtQt.d#F#q#q#q.P.C#O#S.Q#T#Y#2#4#3.d",
585   "QtQtQtQtQtQt.d#5#5#6#6#0#7#w#H#P#U#U#3#3#8.d",
586   "QtQtQtQtQtQt.d.d.d.d.d.d.d.d.d.d.d.d.d.d.d.d"
589 KugarWidgetPlugin::KugarWidgetPlugin ()
593 QStringList KugarWidgetPlugin::keys () const
595   QStringList list;
596   list &lt;&lt; "KReportViewer";
597   return list;
600 QWidget* KugarWidgetPlugin::create (const QString &amp; key, QWidget * parent,
601                                     const char *name)
603   if (key == "KReportViewer")
604     return new KReportViewer (parent, name);
605   return 0;
608 QString KugarWidgetPlugin::group (const QString &amp; feature) const
610   if (feature == "KReportViewer")
611     return "Display";
612   return QString::null;
615 QIconSet KugarWidgetPlugin::iconSet (const QString &amp;) const
617   return QIconSet (QPixmap (kugar_pixmap));
620 QString KugarWidgetPlugin::includeFile (const QString &amp; feature) const
622   if (feature == "KReportViewer")
623     return "kugar.h";
624   return QString::null;
627 QString KugarWidgetPlugin::toolTip (const QString &amp; feature) const
629   if (feature == "KReportViewer")
630     return "Kugar report viewer widget";
631   return QString::null;
634 QString KugarWidgetPlugin::whatsThis (const QString &amp; feature) const
636   if (feature == "KReportViewer")
637     return "A widget to view xml reports";
638   return QString::null;
641 bool KugarWidgetPlugin::isContainer (const QString &amp;) const
643   return FALSE;
646 Q_EXPORT_PLUGIN( KugarWidgetPlugin )
647 </programlisting>
648 </sect3>
650 <sect3 id="plugin-pro-source">
651 <title
652 >kugar_plugin.pro</title>
654 <programlisting
655 >SOURCES        += kugar_plugin.cpp
656 HEADERS        += kugar_plugin.h
658 DESTDIR = $(QTDIR)/plugins/designer
659 TARGET  = kugar_plugin
661 target.path=$$plugins.path
662 isEmpty(target.path):target.path=$$QT_PREFIX/plugins
663 PROJECTNAME = KugarPlugin
664 TEMPLATE    = lib
665 CONFIG           += qt warn_on release plugin
666 unix:LIBS  += -lkugar
667 LANGUAGE    = C++
668 </programlisting>
669 </sect3>
671 </sect2>
673 </sect1>
674 </chapter>