summaryrefslogtreecommitdiffstats
path: root/koffice-i18n-es/docs/koffice/kugar/progguide.docbook
blob: a1bc48003aa50d61ce75a42a963659f541daa5c5 (plain)
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
<!-- If you want to validate or edit this document separately, uncomment
this prolog

<?xml version="1.0" ?>
<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd">

-->

<chapter id="prog-guide">
<chapterinfo>
<authorgroup>
<author
><firstname
>Alexander</firstname
> <surname
>Dymo</surname
> <affiliation
> <address
><email
>cloudtemple@mksat.net</email
></address>
</affiliation>
</author>
<author
><firstname
>Phil</firstname
> <surname
>Thompson</surname
> <affiliation
> <address
><email
>phil@river-bank.demon.co.uk</email
></address>
</affiliation>
</author>
<othercredit role="translator"
><firstname
>Juan Manuel</firstname
><surname
>García Molina</surname
><affiliation
><address
><email
>juanma@superiodico.net</email
></address
></affiliation
><contrib
>Traductor</contrib
></othercredit
> 
</authorgroup>
</chapterinfo>
<title
>Guía del programador</title>

<sect1 id="how-to-use-in-progs">
<title
>Cómo usar &kugar; para hacer informes en sus propios programas</title>

<itemizedlist>
<title
>Hay varias formas de usar &kugar;</title>
<listitem>
<para
>Crear un archivo temporal y rellenarlo con datos, organizados de acuerdo a la <link linkend="kugardata-dtd"
>definición del tipo de documento deKugarData</link
>. Luego llame al shell del comando <command
>kugar</command
> ( <cmdsynopsis
> <command
>kugar</command
> <group
> <option
>-d <replaceable
>archivo de datos de Kugar</replaceable
></option
> </group
> <group
> <option
>-r <replaceable
>archivo de plantilla kugar</replaceable
></option
> </group
> </cmdsynopsis
> ) para ver e imprimir el informe. En <link linkend="prog-using-for-preview"
>Usando el shell de &kugar; para visualizar informes</link
> tiene una descripción detallada. </para>
</listitem>
<listitem>
<para
>Use &kugar; directamente en el código de la aplicación. En <link linkend="prog-using-widget"
>Usar las clases de &kugar; para hacer informes</link
> tiene una descripción detallada. </para>
</listitem>
<listitem>
<para
>Cree un accesorio para &Qt; designer, úselo para construir el &GUI; de la aplicación en el designer y enlácelo con el programa dinámicamente. En <link linkend="prog-designer-plugin"
>Crear un accesorio para &Qt; designer</link
> tiene una descripción detallada. </para>
</listitem>
</itemizedlist>

<para
>Las últimas dos formas son aceptables para desarrolladores de &Qt; y &kde;. Pero &kugar; está diseñado para ser un generador de informes, independientemente de un lenguaje de programación y/o <acronym
>IDE</acronym
>. Usa el formato &XML; para describir plantillas de informes y archivos de datos. Así que cualquier programa puede producir salida en formato de archivo de datos de &kugar; como se describe en <link linkend="kugardata-dtd"
><acronym
>DTD</acronym
> de KugarData</link
> o incluso el formato de archivo de plantilla de informe (vea <link linkend="template-dtd"
><acronym
>DTD</acronym
> de KugarTemplate</link
>). El shell de &kugar; (visor de informes) se puede usar para ver e imprimir los informes generados. </para>

</sect1>

<sect1 id="prog-using-for-preview">
<title
>Usando el shell de &kugar; para visualizar informes</title>

<orderedlist>
<title
>La forma de crear y previsualizar (imprimir) informes es:</title>
<listitem>
<para
>Cree una plantilla de informe con &kudesigner; </para>
</listitem>
<listitem>
<para
>Cree un archivo de datos con valores de columnas para las bandas detalladas del informe. Use el <link linkend="kugardata-dtd"
><acronym
>DTD</acronym
> de KugarData</link
> para producir archivos de datos correctos. </para>
</listitem>
<listitem>
<para
>Lance el shell de &kugar; para visualizar e imprimir el informe. Por ejemplo, haga esto en llamadas de los lengaje C o C++:</para>

<programlisting
><function
>system(<option
>"kugar -r <replaceable
>template_file.ktf</replaceable
>-d <replaceable
>data_file.kdf</replaceable
>"</option
>)</function
>.
</programlisting>

<para
>No olvide incluir <filename class="headerfile"
>stdlib.h</filename
>. </para>
</listitem>
</orderedlist>
</sect1>

<sect1 id="prog-using-widget">
<title
>Usae clases de &kugar; para hacer informes</title>
<para
>La biblioteca de &kugar; incluye dos elementos para que los use. </para>
<para
>La clase <classname
>KReportViewer</classname
> está diseñada para desarrolladores de &kde;. Admite un sistema de impresión de &kde; y localización de &UNIX; vía llamadas a <function
>i18n()</function
>. </para>
<para
>La clase <classname
>MReportViewer</classname
> está diseñada para desarrolladores de &Qt; y proporciona multiplataforma real. No sólo se puede usar en plataformas &UNIX;, sino también en &Windows; y &MacOS;. </para>
<para
>Para construir un programa que utilice la biblioteca kugar, se debe enlazar con la biblioteca compartida <filename
>libkugar.so</filename
>, que se proporciona con la distribución de &kugar; en todas las plataformas &UNIX;. </para>
<para
>Los archivos que hay que incluir son <filename
>kugarqt.h</filename
> y <filename
>kugar.h</filename
> para los programas de &Qt; y &kde; respectivamente. </para>
<para
>Para un ejemplo detallado de cómo se usan las clases de &kugar;, vea la carpeta <filename class="directory"
>/shell</filename
> en las fuentes de &kugar;. </para>
<para
><classname
>MReportViewer</classname
> (y <classname
>KReportViewer</classname
> también) contiene varios métodos públicos que se pueden usar. </para>
<funcsynopsis>
<funcprototype>
<funcdef
>void <function
>renderReport</function
></funcdef>
<void/>
</funcprototype>
<funcsynopsisinfo
>Visualiza el informe en pantalla.</funcsynopsisinfo>
</funcsynopsis>

<funcsynopsis>
<funcprototype>
<funcdef
>void <function
>printReport</function
></funcdef>
<void/>
</funcprototype>
<funcsynopsisinfo
>LLama al cuadro de diálogo de impresión para imprimir el informe.</funcsynopsisinfo>
</funcsynopsis>

<funcsynopsis>
<funcprototype>
<funcdef
>void <function
>clearReport</function
></funcdef>
<void/>
</funcprototype>
<funcsynopsisinfo
>Limpia el informe en una pantalla y libera los datos del informe. Llame a esta función antes de abrir el informe nuevo.</funcsynopsisinfo>
</funcsynopsis>

<funcsynopsis>
<funcprototype
><funcdef
>bool <function
>setReportData</function
></funcdef
> <paramdef
>const QString &amp;<parameter
>nombre_arch_datos</parameter
></paramdef
> </funcprototype>
<funcsynopsisinfo
>Toma los datos para el informe del archivo <replaceable
>nombre_arch_datos</replaceable
>.</funcsynopsisinfo>
</funcsynopsis>

<funcsynopsis>
<funcprototype
><funcdef
>bool <function
>setReportData</function
></funcdef
> <paramdef
>const QIODevice &amp;<parameter
>disp_datos_es</parameter
></paramdef
> </funcprototype>
<funcsynopsisinfo
>Toma los datos para el informe del archivo <replaceable
>disp_datos_es</replaceable
>. El dispositivo de E/S puede ser cualquier heredero de la clase <classname
>QIODevice</classname
>. Por ejemplo, para recoger registros directamente de la base de datos, cree un heredero de <classname
>QIODevice</classname
> y redefina toda la funcionalidad necesaria. </funcsynopsisinfo>
</funcsynopsis>

<funcsynopsis>
<funcprototype
><funcdef
>bool <function
>setReportTemplate</function
></funcdef
> <paramdef
>const QString &amp;<parameter
>nombre_arch_plantilla</parameter
></paramdef
> </funcprototype>
<funcsynopsisinfo
>Toma loa plantilla del informe del archivo <replaceable
>nombre_arch_plantilla</replaceable
>.</funcsynopsisinfo>
</funcsynopsis>

<funcsynopsis>
<funcprototype
><funcdef
>bool <function
>setReportTemplate</function
></funcdef
> <paramdef
>const QIODevice &amp;<parameter
>disp_es_plantilla</parameter
></paramdef
> </funcprototype>
<funcsynopsisinfo
>Toma la plantilla del informe del archivo <replaceable
>disp_es_plantilla</replaceable
> . El dispositivo de E/S puede ser cualquier heredero de la clase <classname
>QIODevice</classname
>. Por ejemplo, para obtener una plantilla del informe de algún sitio de almacenamiento de la red o una base de datos, cree un heredero de QIODevice y redefina toda la funcionalidad necesaria. </funcsynopsisinfo>
</funcsynopsis>

</sect1>

<sect1 id="prog-designer-plugin">
<title
>Creando un plugin de &Qt; designer</title>

<para
>Este es el código de ejemplo de cómo se crea el accesorio del diseñador. El código de abajo crea el accesorio para un elemento <classname
>KReportViewer</classname
> de &kde;. </para>

<para
>Si se desea un accesorio para &Qt;, cambie <classname
>KReportViewer</classname
> por <classname
>MReportViewer</classname
> y <filename
>kugar.h</filename
> por <filename
>kugarqt.h</filename
> en el código del accesorio. </para>

<sect2 id="plugin-usage">
<title
>Uso del plugin</title>
<para
>El accesorio del diseñador permitirá el uso de &Qt; Designer para ubicar el elemento <classname
>KReportViewer</classname
> en una ventana y visualizarlo correctamente. </para>

<para
>Los programas que hacen uso de este accesorio se deben enlazar con él dinámicamente. La biblioteca correspondiente se llama <filename
>libkugar_plugin.so</filename
>. Los elementos o diálogos que incluyen el elemento <classname
>KReportViewer</classname
> deben incluir &lt;kugar.h&gt; en la implementación y tener una declaración más adelante de la clase <classname
>class KReportViewer</classname
>. Se pueden hacer los «includes» con el Explorador de objetos de &Qt; Designer (solapa Fuente). </para>

<para
>Para construir un accesorio, ejecute: <cmdsynopsis
><command
>qmake</command
> <arg
>kugar_plugin.pro</arg
> </cmdsynopsis>
<cmdsynopsis>
<command
>make</command>
</cmdsynopsis>
</para>

</sect2>

<sect2 id="plugin-code">
<title
>Código del plugin</title>

<segmentedlist>
<title
>El código del plugin consta de tres archivos:</title>
<segtitle
><link linkend="plugin-h-source"
>kugar_plugin.h</link
></segtitle>
<segtitle
><link linkend="plugin-cpp-source"
>kugar_plugin.cpp</link
></segtitle>
<segtitle
><link linkend="plugin-pro-source"
>kugar_plugin.pro</link
></segtitle>
<seglistitem>
<seg
>Un archivo de encabezado para <classname
>KugarWidgetPlugin</classname
>, sucesor de <classname
>QWidgetPlugin</classname
>.</seg>
<seg
>Un archivo fuente para <classname
>KugarWidgetPlugin</classname
>, sucesor de <classname
>QWidgetPlugin</classname
>.</seg>
<seg
>Un archivo de proyecto para la utilidad <application
>QMake</application
>.</seg>
</seglistitem>
</segmentedlist>

<sect3 id="plugin-h-source">
<title
>kugar_plugin.h</title>

<programlisting
>#include &lt;qwidgetplugin.h
>&gt;

class KugarWidgetPlugin:public QWidgetPlugin
{
public:
  KugarWidgetPlugin ();

  QStringList keys () const;
  QWidget *create (const QString &amp; classname, QWidget * parent =
                   0, const char *name = 0);
  QString group (const QString &amp;) const;
  QIconSet iconSet (const QString &amp;) const;
  QString includeFile (const QString &amp;) const;
  QString toolTip (const QString &amp;) const;
  QString whatsThis (const QString &amp;) const;
  bool isContainer (const QString &amp;) const;
};
</programlisting>
</sect3>


<sect3 id="plugin-cpp-source">
<title
>kugar_plugin.cpp</title>

<programlisting
>#include "kugar_plugin.h"
#include &lt;kugar.h&gt;

static const char *kugar_pixmap[] = {
  "22 22 127 2",
  ".d c #000000",
  ".c c #131313",
  ".b c #282828",
  ".a c #434241",
  ".e c #4e463a",
  ".# c #595551",
  ".G c #66553b",
  "#F c #68635f",
  "#R c #6b4f23",
  "#q c #6e6862",
  "#M c #6f5229",
  ".n c #6f6146",
  ".w c #735310",
  ".V c #755c2a",
  ".I c #775f34",
  ".0 c #77694a",
  "#n c #7e6434",
  ".o c #806f50",
  "#C c #835d2d",
  ".P c #837c75",
  "#B c #85653a",
  "#k c #85827e",
  ".x c #866d46",
  ".U c #877967",
  ".X c #888888",
  ".F c #89724d",
  "#x c #8b6d2a",
  ".S c #8d7759",
  ".z c #8e733b",
  "#L c #906e49",
  "#Q c #947b56",
  ".r c #948058",
  ".J c #957844",
  ".4 c #987736",
  ".q c #998969",
  ".k c #999897",
  ".R c #9a8a75",
  "#i c #9f8348",
  "#I c #a37c4b",
  ".u c #a38d66",
  ".E c #a58558",
  "#A c #a8834b",
  ".s c #a9967a",
  ".t c #aa9467",
  ".C c #ae9f8d",
  "#6 c #afa49d",
  "#5 c #afa9a4",
  "#W c #b18e4d",
  ".K c #b1935a",
  ".B c #b39660",
  "#V c #b49866",
  "#a c #b49d6c",
  "## c #b49d72",
  ".j c #b5b4b4",
  "#0 c #b7a597",
  ".O c #b9b1a9",
  ".L c #bb9c61",
  ".M c #bb9e6b",
  ".A c #bca778",
  "#j c #bea46b",
  ".T c #bfb37d",
  ".v c #c0b391",
  ".W c #c3a262",
  ".i c #c4c4c4",
  "#m c #c5b7aa",
  "#8 c #c69f80",
  ".D c #c6b79b",
  "#3 c #c7a589",
  ".7 c #c7a76c",
  "#u c #c7bbaf",
  ".6 c #c8ad74",
  "#7 c #c8b7a9",
  "#r c #c8beb5",
  ".m c #c8c8c8",
  "#U c #cbad96",
  "#f c #ccb681",
  "#h c #cdac6c",
  "#P c #cdb49f",
  "#X c #cdb8a6",
  "#H c #ceb7a4",
  ".y c #ceb892",
  ".N c #cecac3",
  "#Z c #cfb16f",
  "#O c #cfbdad",
  ".Z c #cfc7c0",
  "#w c #d0bcab",
  ".5 c #d1ad6b",
  "#s c #d1bfb1",
  ".h c #d5d5d5",
  "#l c #d6cdc6",
  "#D c #d8b36e",
  ".H c #dac592",
  "#t c #dbb977",
  ".g c #dcdcdc",
  ".1 c #e0dcc1",
  ".f c #e0e0df",
  "#1 c #e3c8b1",
  "#S c #e4cdb9",
  ".3 c #e4d9a3",
  "#4 c #e6c1a1",
  "#2 c #e7c4a5",
  "#K c #e9c179",
  "#g c #e9c47e",
  "#Y c #e9c8ac",
  ".2 c #eae6c0",
  "#T c #ebcdb3",
  ".Q c #ebd4b9",
  "#E c #ecca87",
  "#z c #ecd799",
  ".l c #ececeb",
  "#G c #efd7c2",
  "#e c #efe3ab",
  ".8 c #efe8e3",
  "#v c #f1dcca",
  "#. c #f2e2d4",
  ".p c #f4f4f4",
  "#y c #f5daa0",
  "#J c #f6cf7f",
  ".9 c #f7ede4",
  "#p c #f9d995",
  ".Y c #fcf9f6",
  "#d c #fefcc5",
  "#c c #fefdda",
  "#b c #fefee1",
  "#N c #ffd685",
  "#o c #fff0a9",
  "Qt c #ffffff",
  "QtQtQtQtQtQt.#.a.a.a.b.b.b.c.c.d.d.dQtQtQtQt",
  "QtQtQtQtQtQt.e.f.g.g.f.g.g.h.i.j.d.k.dQtQtQt",
  "QtQtQtQtQtQt.a.gQtQtQtQtQtQt.l.f.c.m.k.dQtQt",
  "QtQtQtQtQt.n.n.n.n.n.o.g.pQtQt.l.bQt.m.k.dQt",
  "QtQtQt.q.q.r.q.s.t.r.q.u.u.g.pQt.a.fQt.m.k.d",
  "QtQt.s.s.v.w.x.y.y.t.z.A.t.B.i.p.#.a.b.c.d.d",
  "Qt.C.C.D.E.F.G.A.H.F.I.J.K.L.M.i.p.l.N.O.P.d",
  "Qt.s.v.Q.q.R.S.T.A.R.U.V.L.W.W.X.g.Y.f.Z.k.d",
  ".0.s.t.Q.1.U.R.2.3.S.U.4.5.6.6.7.j.8.9#..O.d",
  ".G##.V#a#b.1#c#c#d#e#f#g#h#i#j.W#k#l.9#.#m.d",
  ".G.4.F#n#c#c#c#d#d#o#p#g.x.w#i.L#q#r#.#.#s.d",
  ".e.J.J.I.3#d.H#j.6#f#p#t#n.w.E.L#q#u#.#v#w.d",
  ".G.A#x.z#y#z#A#B#B#C#D#E.4.4.6#h#F#m#v#G#H.d",
  ".o.s.A#j#E#t#I#I#I#C#A#J#p#p#K#t#F#m#v#G#H.d",
  "Qt##.A.6.7#I#I#A.E#L#M.W#N#J#K.a.U#O#G.Q#P.d",
  "Qt#a.M.L.J#A#I.4.E#Q.x#R#D#J#g.#.C#S.Q#T#U.d",
  "QtQt#V.K.z#Q.s.S.x.S#B#M#W#E.a.U#X.Q#T#Y#U.d",
  "QtQtQt.M#i#B.r#Q#Q.r#Q.z#Z.a#q#0#1#T#Y#2#3.d",
  "QtQtQtQtQt#j.L.L.W.5#t.a.#.U#0#1#T#Y#2#4#3.d",
  "QtQtQtQtQtQt.d#F#q#q#q.P.C#O#S.Q#T#Y#2#4#3.d",
  "QtQtQtQtQtQt.d#5#5#6#6#0#7#w#H#P#U#U#3#3#8.d",
  "QtQtQtQtQtQt.d.d.d.d.d.d.d.d.d.d.d.d.d.d.d.d"
};

KugarWidgetPlugin::KugarWidgetPlugin ()
{
}

QStringList KugarWidgetPlugin::keys () const
{
  QStringList list;
  list &lt;&lt; "KReportViewer";
  return list;
}

QWidget* KugarWidgetPlugin::create (const QString &amp; key, QWidget * parent,
                                    const char *name)
{
  if (key == "KReportViewer")
    return new KReportViewer (parent, name);
  return 0;
}

QString KugarWidgetPlugin::group (const QString &amp; feature) const
{
  if (feature == "KReportViewer")
    return "Display";
  return QString::null;
}

QIconSet KugarWidgetPlugin::iconSet (const QString &amp;) const
{
  return QIconSet (QPixmap (kugar_pixmap));
}

QString KugarWidgetPlugin::includeFile (const QString &amp; feature) const
{
  if (feature == "KReportViewer")
    return "kugar.h";
  return QString::null;
}

QString KugarWidgetPlugin::toolTip (const QString &amp; feature) const
{
  if (feature == "KReportViewer")
    return "Kugar report viewer widget";
  return QString::null;
}

QString KugarWidgetPlugin::whatsThis (const QString &amp; feature) const
{
  if (feature == "KReportViewer")
    return "A widget to view xml reports";
  return QString::null;
}

bool KugarWidgetPlugin::isContainer (const QString &amp;) const
{
  return FALSE;
}

TQ_EXPORT_PLUGIN( KugarWidgetPlugin )
</programlisting>
</sect3>

<sect3 id="plugin-pro-source">
<title
>kugar_plugin.pro</title>

<programlisting
>SOURCES        += kugar_plugin.cpp
HEADERS        += kugar_plugin.h

DESTDIR = $(TQTDIR)/plugins/designer
TARGET  = kugar_plugin

target.path=$$plugins.path
isEmpty(target.path):target.path=$$QT_PREFIX/plugins
PROJECTNAME = KugarPlugin
TEMPLATE    = lib
CONFIG           += qt warn_on release plugin
unix:LIBS  += -lkugar
LANGUAGE    = C++
</programlisting>
</sect3>

</sect2>

</sect1>
</chapter>