File: text_properties.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (346 lines) | stat: -rw-r--r-- 11,718 bytes parent folder | download
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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Djalel Abdemouche
 * Copyright (C) INRIA - Jean-Baptiste silvy
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<refentry version="5.0-subset Scilab" xml:id="text_properties" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns4="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>

  <refnamediv>
    <refname>text_properties</refname>

    <refpurpose>Descrio das propriedades da entidade Text
    (texto)</refpurpose>
  </refnamediv>

  <refsection>
    <title>Descrio</title>

    <para>A entidade Text  uma folha na hierarquia de entidades grficas.
    Esta entidade define parmetros para escrita de strings.</para>

    <variablelist>
      <varlistentry>
        <term>parent:</term>

        <listitem>
          <para>esta propriedade contm o manipulador da raiz. A raiz de uma
          entidade Text deve ser do tipo <literal>"Axes"</literal> ou
          <literal>"Compound"</literal>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>children:</term>

        <listitem>
          <para>esta propriedade contm um vetor com os galhos do manipulador.
          Contudo, manipuladores text no possuem galhos correntemente.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>visible:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>visible</literal> para a entidade. Pode ser <literal>"on"
          </literal> ou <literal>"off"</literal> . Por padro, o texto 
          visvel, a propriedade  <literal>"on"</literal>. Se
          <literal>"off"</literal>, o texto no  exibido na tela. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>text:</term>

        <listitem>
          <para>a matriz contendo os strings do objeto. As linhas da matriz
          so exibidas horizontalmente, e as colunas verticalmente.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>alignment:</term>

        <listitem>
          <para>especifica como os strings sero alinhados em suas colunas. o
          valor deve ser <emphasis role="bold">'left'</emphasis>,<emphasis
          role="bold"> 'center' </emphasis>ou <emphasis
          role="bold">'right'</emphasis>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>data:</term>

        <listitem>
          <para>este campo  o vetor <literal>[x,y,[z]]</literal> da origem do
          texto na unidade de dados dos eixos. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>box:</term>

        <listitem>
          <para>o valor deste campo pode ser <literal>"on"</literal> ou
          <literal>"off"</literal>. Se <literal>"on"</literal> uma caixa 
          desenhada ao redor do texto com uma linha em sua borda e um plano de
          fundo. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>line_mode:</term>

        <listitem>
          <para>esta propriedade booleana permite desenhar apenas o plano de
          fundo da caixa quando a propriedade <literal>box</literal> 
          <literal>"on"</literal>. Se <literal>line_mode</literal> 
          <literal>"off"</literal> , a linha da caixa no  desenhada. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>fill_mode:</term>

        <listitem>
          <para>esta propriedade booleana permite desenhar ou no o plano de
          fundo da caixa quando a propriedade <literal>box</literal> 
          <literal>"on"</literal>. Se <literal>fill_mode</literal> for
          <literal>"off"</literal>, o plano de fundo da caixa no 
          transparente. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>text_box:</term>

        <listitem>
          <para>um vetor bidimensional especificando o tamanho do retngulo em
          coordenadas do usurio. O retngulo  utilizado quando a propriedade
          text_box_mode est ajustada pra <emphasis
          role="bold">'centered'</emphasis> ou <emphasis
          role="bold">'filled'</emphasis>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>text_box_mode:</term>

        <listitem>
          <para>Pode ter trs valores diferentes : <emphasis
          role="bold">'off'</emphasis>, <emphasis
          role="bold">'centered'</emphasis> ou <emphasis
          role="bold">'filled'</emphasis>. Se <emphasis
          role="bold">'off'</emphasis>, os strings so exibidos utilizando-se
          a dada fonte e o campo data especifica a posio do ponto inferior
          esquerdo do texto. Se <emphasis role="bold">'centered'</emphasis>, o
          texto  exibido no meio do retngulo cujo tamanho  fornecido por
          text_box. Se <emphasis role="bold">'filled'</emphasis>, o tamanho de
          fonte dos strings ser expandido para se preencher o
          retngulo.</para>

          <para>Ao se utilizar os modos <emphasis role="bold">'off'</emphasis>
          ou <emphasis role="bold">'centered'</emphasis> , o tamanho dos
          textos se mantm constante sob ampliao. Eles so os melhores modos
          para se criar anotaes em um grfico. Por outro lado, ao se
          utilizar o modo <emphasis role="bold">'filled'</emphasis>, o tamanho
          do texto segue a escala grfica.  ento possvel ampliar objetos
          textos.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>font_foreground:</term>

        <listitem>
          <para>este campo contm a cor utilizada para exibir os caracteres do
          texto. O valor deve ser um ndice de cor (relativo ao mapa de cores
          corrente). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>foreground:</term>

        <listitem>
          <para>este campo contm a cor utilizada para exibir a linha na borda
          da caixa. O valor deve ser um ndice de cores (relativo ao mapa de
          cores corrente). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>background:</term>

        <listitem>
          <para>este campo contm a cor utilizada para preencher a caixa ao
          redor do texto. O valor deve ser um ndice de cor (relativo ao mapa
          de cores corrente). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>font_size:</term>

        <listitem>
          <para> um escalar especificando o tamanho dos caracteres exibidos.
          Se a propriedade <literal>fractional_font</literal> 
          <literal>"off"</literal> , apenas a parte inteira do valor 
          utilzada. Para mais informaes, veja <link
          linkend="graphics_fonts">graphics_fonts</link>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>font_style:</term>

        <listitem>
          <para>especifica a fonte a ser utilizada para exibir os strings. 
          um inteiro positivo fazendo referncia a uma das fontes carregadas.
          Seu valor deve estar entre 0, referncia  primeira fonte, e o
          nmero de fontes carregadas menos um, referncia  ltima fonte.
          Para mais informaes, veja <link
          linkend="graphics_fonts">graphics_fonts</link>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>fractional_font:</term>

        <listitem>
          <para>Esta propriedade indica se o texto ser exibido utilizando-se
          tamanhos de fonte fracionrios. Pode ser <literal>"on"</literal> ou
          <literal>"off"</literal>. Se <literal>"on"</literal> o valor em
          ponto flutuante de <literal>font_size</literal>  utilizado para
          exibio e retira-se o serrilhamento da fonte. Se
          <literal>"off"</literal> , apenas a parte inteira  utilizada e a
          fonte no  suavizada.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>font_angle:</term>

        <listitem>
          <para>esta propriedade determina a orientao do string. Especifica
          o valor da rotao em graus. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>clip_state:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>clip_state</literal> para o texto. O valor de clip_state
          pode ser:</para>

          <itemizedlist>
            <listitem>
              <para><literal>"off"</literal> significa que o texto no 
              recortado. </para>
            </listitem>

            <listitem>
              <para><literal>"cliprf"</literal> significa que o texto 
              recortado fora da caixa dos eixos. </para>
            </listitem>

            <listitem>
              <para><literal>"on"</literal> significa que o texto  recortado
              fora do retngulo dado pela propriedade clip_box.</para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>clip_box:</term>

        <listitem>
          <para>este campo contm o valor da propriedade
          <literal>clip_box</literal>. Seu valor deve ser uma matriz vazia se
          clip_state  "off" ou o vetor <literal>[x,y,w,h</literal>] (ponto
          superior esquerdo, largura, altura). </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>user_data:</term>

        <listitem>
          <para>este campo pode ser utilizado para armazenar qualquer varivel
          Scilab na estrutura de dados da entidade texto e recuper-la.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Exemplos</title>

    <programlisting role="example"><![CDATA[ 
a=get("current_axes");
a.data_bounds=[0,0;1,1];
a.axes_visible = 'on' ;

xstring(0.5,0.5,"Scilab is not esilaB",0,0)

t=get("hdl")   //obtendo o manipulador do novo objeto criado

t.font_foreground=6; // alterando as propriedades da fonte
t.font_size=5;
t.font_style=5;

t.text=["SCILAB","no";"","esilaB"] ; // alterando
t.font_angle=90 ; // virando os strings
t.text_box = [0,0] ;
t.text_box_mode = 'centered' ; // o texto est agora centrado em [0.5,0.5].
t.alignment = 'center' ;
t.box = 'on' ; // desenhando uma caixa ao redor do texto
 ]]></programlisting>
  </refsection>

  <refsection>
    <title>Ver Tambm</title>

    <simplelist type="inline">
      <member><link linkend="set">set</link></member>

      <member><link linkend="get">get</link></member>

      <member><link linkend="delete">delete</link></member>

      <member><link linkend="xtitle">xtitle</link></member>

      <member><link
      linkend="graphics_entities">graphics_entities</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Autor</title>

    <para>Djalel ABDEMOUCHE, Jean-Baptiste SILVY</para>
  </refsection>
</refentry>