← Back to branch summary

~ubuntu-branches/ubuntu/natty/avant-window-navigator/natty

« back to all changes in this revision

Viewing changes to doc/reference/xml/awn-defines.xml

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2010-12-17 13:48:28 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20101217134828-l394fb03wdkxc3mq
Tags: 0.4.1~bzr803-0ubuntu1
https://launchpad.net/bugs/612144
https://launchpad.net/bugs/568555
* New upstream snapshot.
 - Fix a crash with signal 5 in _XError (LP: #612144)
 - Re-add "move to another workspace" to launcher (LP: #568555)
* debian/patches:
 - 02-ftbfs-python-2.6.patch: Refresh.
 - 03-python-import.patch: Refresh.
 - 04-lda-requierement.patch: New patch, lower desktop-agnostic requierement,
   the version in Natty is enough.
 - Drop all others patches, merged upstream.
* debian/copyright:
 - Update copyright years and upstream authors.
* debian/control:
 - Build-depends on valac-0.10 (>= 0.9.1), to force stable version of Vala.
* debian/libawn1.symbols:
 - Update with new symbols. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/awn-defines.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="libawn-awn-defines">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="libawn-awn-defines.top_of_page">awn-defines</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBAWN Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>awn-defines</refname>
13
 
<refpurpose></refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="libawn-awn-defines.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
#define             <link linkend="AWN-MAX-HEIGHT--CAPS">AWN_MAX_HEIGHT</link>
21
 
#define             <link linkend="AWN-MIN-HEIGHT--CAPS">AWN_MIN_HEIGHT</link>
22
 
enum                <link linkend="AwnAppletFlags">AwnAppletFlags</link>;
23
 
enum                <link linkend="AwnAppletLicense">AwnAppletLicense</link>;
24
 
enum                <link linkend="AwnPathType">AwnPathType</link>;
25
 
#define             <link linkend="AWN-PANEL-ID-DEFAULT--CAPS">AWN_PANEL_ID_DEFAULT</link>
26
 
#define             <link linkend="AWN-FONT-SIZE-EXTRA-SMALL--CAPS">AWN_FONT_SIZE_EXTRA_SMALL</link>
27
 
#define             <link linkend="AWN-FONT-SIZE-SMALL--CAPS">AWN_FONT_SIZE_SMALL</link>
28
 
#define             <link linkend="AWN-FONT-SIZE-MEDIUM--CAPS">AWN_FONT_SIZE_MEDIUM</link>
29
 
#define             <link linkend="AWN-FONT-SIZE-LARGE--CAPS">AWN_FONT_SIZE_LARGE</link>
30
 
#define             <link linkend="AWN-FONT-SIZE-EXTRA-LARGE--CAPS">AWN_FONT_SIZE_EXTRA_LARGE</link>
31
 
</synopsis>
32
 
</refsynopsisdiv>
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
<refsect1 id="libawn-awn-defines.description" role="desc">
43
 
<title role="desc.title">Description</title>
44
 
<para>
45
 
</para>
46
 
</refsect1>
47
 
 
48
 
<refsect1 id="libawn-awn-defines.details" role="details">
49
 
<title role="details.title">Details</title>
50
 
<refsect2 id="AWN-MAX-HEIGHT--CAPS" role="macro">
51
 
<title>AWN_MAX_HEIGHT</title>
52
 
<indexterm zone="AWN-MAX-HEIGHT--CAPS"><primary sortas="AWN_MAX_HEIGHT">AWN_MAX_HEIGHT</primary></indexterm><programlisting>#define AWN_MAX_HEIGHT 100
53
 
</programlisting>
54
 
<para>
55
 
The maximum size of the panel</para>
56
 
<para>
57
 
</para></refsect2>
58
 
<refsect2 id="AWN-MIN-HEIGHT--CAPS" role="macro">
59
 
<title>AWN_MIN_HEIGHT</title>
60
 
<indexterm zone="AWN-MIN-HEIGHT--CAPS"><primary sortas="AWN_MIN_HEIGHT">AWN_MIN_HEIGHT</primary></indexterm><programlisting>#define AWN_MIN_HEIGHT 12
61
 
</programlisting>
62
 
<para>
63
 
The minimum size of the panel</para>
64
 
<para>
65
 
</para></refsect2>
66
 
<refsect2 id="AwnAppletFlags" role="enum">
67
 
<title>enum AwnAppletFlags</title>
68
 
<indexterm zone="AwnAppletFlags"><primary sortas="AwnAppletFlags">AwnAppletFlags</primary></indexterm><programlisting>typedef enum
69
 
{
70
 
  AWN_APPLET_FLAGS_NONE     = 0,
71
 
  AWN_APPLET_EXPAND_MINOR   = 1 &lt;&lt; 0,
72
 
  AWN_APPLET_EXPAND_MAJOR   = 1 &lt;&lt; 1,
73
 
  AWN_APPLET_IS_EXPANDER    = 1 &lt;&lt; 2,
74
 
  AWN_APPLET_IS_SEPARATOR   = 1 &lt;&lt; 3,
75
 
  AWN_APPLET_HAS_SHAPE_MASK = 1 &lt;&lt; 4,
76
 
 
77
 
  AWN_APPLET_DOCKLET_HANDLES_POSITION_CHANGE = 1 &lt;&lt; 10,
78
 
  AWN_APPLET_DOCKLET_CLOSE_ON_MOUSE_OUT = 1 &lt;&lt; 11
79
 
} AwnAppletFlags;
80
 
</programlisting>
81
 
<para>
82
 
</para></refsect2>
83
 
<refsect2 id="AwnAppletLicense" role="enum">
84
 
<title>enum AwnAppletLicense</title>
85
 
<indexterm zone="AwnAppletLicense"><primary sortas="AwnAppletLicense">AwnAppletLicense</primary></indexterm><programlisting>typedef enum
86
 
{
87
 
  AWN_APPLET_LICENSE_GPLV2 = 10,
88
 
  AWN_APPLET_LICENSE_GPLV3 = 11,
89
 
  AWN_APPLET_LICENSE_LGPLV2_1 = 12,
90
 
  AWN_APPLET_LICENSE_LGPLV3 = 13
91
 
} AwnAppletLicense;
92
 
</programlisting>
93
 
<para>
94
 
The license to use for the applet's about dialog.
95
 
Starting the acceptable values at 10 makes it rather unlikely
96
 
that someone can specify a license type by accident.</para>
97
 
<para>
98
 
</para><variablelist role="enum">
99
 
<varlistentry id="AWN-APPLET-LICENSE-GPLV2--CAPS" role="constant">
100
 
<term><literal>AWN_APPLET_LICENSE_GPLV2</literal></term>
101
 
<listitem><simpara> GPL version 2 or later
102
 
</simpara></listitem>
103
 
</varlistentry>
104
 
<varlistentry id="AWN-APPLET-LICENSE-GPLV3--CAPS" role="constant">
105
 
<term><literal>AWN_APPLET_LICENSE_GPLV3</literal></term>
106
 
<listitem><simpara> GPL version 3 or later
107
 
</simpara></listitem>
108
 
</varlistentry>
109
 
<varlistentry id="AWN-APPLET-LICENSE-LGPLV2-1--CAPS" role="constant">
110
 
<term><literal>AWN_APPLET_LICENSE_LGPLV2_1</literal></term>
111
 
<listitem><simpara> LGPL version 2.1 or later
112
 
</simpara></listitem>
113
 
</varlistentry>
114
 
<varlistentry id="AWN-APPLET-LICENSE-LGPLV3--CAPS" role="constant">
115
 
<term><literal>AWN_APPLET_LICENSE_LGPLV3</literal></term>
116
 
<listitem><simpara> LGPL version 3 or later
117
 
</simpara></listitem>
118
 
</varlistentry>
119
 
</variablelist></refsect2>
120
 
<refsect2 id="AwnPathType" role="enum">
121
 
<title>enum AwnPathType</title>
122
 
<indexterm zone="AwnPathType"><primary sortas="AwnPathType">AwnPathType</primary></indexterm><programlisting>typedef enum
123
 
{
124
 
        AWN_PATH_LINEAR=0,
125
 
        AWN_PATH_ELLIPSE,
126
 
 
127
 
        AWN_PATH_LAST
128
 
 
129
 
} AwnPathType;
130
 
</programlisting>
131
 
<para>
132
 
Describes the layout of icons on the panel.</para>
133
 
<para>
134
 
</para><variablelist role="enum">
135
 
<varlistentry id="AWN-PATH-LINEAR--CAPS" role="constant">
136
 
<term><literal>AWN_PATH_LINEAR</literal></term>
137
 
<listitem><simpara> Standard (non-curved) panel layout.
138
 
</simpara></listitem>
139
 
</varlistentry>
140
 
<varlistentry id="AWN-PATH-ELLIPSE--CAPS" role="constant">
141
 
<term><literal>AWN_PATH_ELLIPSE</literal></term>
142
 
<listitem><simpara> Elliptical (curved) panel layout.
143
 
</simpara></listitem>
144
 
</varlistentry>
145
 
<varlistentry id="AWN-PATH-LAST--CAPS" role="constant">
146
 
<term><literal>AWN_PATH_LAST</literal></term>
147
 
<listitem><simpara> Placeholder value.
148
 
</simpara></listitem>
149
 
</varlistentry>
150
 
</variablelist></refsect2>
151
 
<refsect2 id="AWN-PANEL-ID-DEFAULT--CAPS" role="macro">
152
 
<title>AWN_PANEL_ID_DEFAULT</title>
153
 
<indexterm zone="AWN-PANEL-ID-DEFAULT--CAPS"><primary sortas="AWN_PANEL_ID_DEFAULT">AWN_PANEL_ID_DEFAULT</primary></indexterm><programlisting>#define AWN_PANEL_ID_DEFAULT 1
154
 
</programlisting>
155
 
<para>
156
 
The default panel ID.</para>
157
 
<para>
158
 
</para></refsect2>
159
 
<refsect2 id="AWN-FONT-SIZE-EXTRA-SMALL--CAPS" role="macro">
160
 
<title>AWN_FONT_SIZE_EXTRA_SMALL</title>
161
 
<indexterm zone="AWN-FONT-SIZE-EXTRA-SMALL--CAPS"><primary sortas="AWN_FONT_SIZE_EXTRA_SMALL">AWN_FONT_SIZE_EXTRA_SMALL</primary></indexterm><programlisting>#define AWN_FONT_SIZE_EXTRA_SMALL 6.0
162
 
</programlisting>
163
 
<para>
164
 
Extra small font size. For use with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.
165
 
Standardized font sizes to be used with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.  Corresponds to 
166
 
standard Pango font size units for standard <link linkend="PANGO-SCALE--CAPS"><literal>PANGO_SCALE</literal></link> when the awn icon
167
 
size is 48.0 pixels.</para>
168
 
<para>
169
 
</para></refsect2>
170
 
<refsect2 id="AWN-FONT-SIZE-SMALL--CAPS" role="macro">
171
 
<title>AWN_FONT_SIZE_SMALL</title>
172
 
<indexterm zone="AWN-FONT-SIZE-SMALL--CAPS"><primary sortas="AWN_FONT_SIZE_SMALL">AWN_FONT_SIZE_SMALL</primary></indexterm><programlisting>#define AWN_FONT_SIZE_SMALL       9.0
173
 
</programlisting>
174
 
<para>
175
 
Small font size. For use with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.
176
 
Standardized font sizes to be used with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.  Corresponds to 
177
 
standard Pango font size units for standard <link linkend="PANGO-SCALE--CAPS"><literal>PANGO_SCALE</literal></link> when the awn icon
178
 
size is 48.0 pixels.</para>
179
 
<para>
180
 
</para></refsect2>
181
 
<refsect2 id="AWN-FONT-SIZE-MEDIUM--CAPS" role="macro">
182
 
<title>AWN_FONT_SIZE_MEDIUM</title>
183
 
<indexterm zone="AWN-FONT-SIZE-MEDIUM--CAPS"><primary sortas="AWN_FONT_SIZE_MEDIUM">AWN_FONT_SIZE_MEDIUM</primary></indexterm><programlisting>#define AWN_FONT_SIZE_MEDIUM      12.0
184
 
</programlisting>
185
 
<para>
186
 
Medium font size. For use with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.
187
 
Standardized font sizes to be used with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.  Corresponds to 
188
 
standard Pango font size units for standard <link linkend="PANGO-SCALE--CAPS"><literal>PANGO_SCALE</literal></link> when the awn icon
189
 
size is 48.0 pixels.</para>
190
 
<para>
191
 
</para></refsect2>
192
 
<refsect2 id="AWN-FONT-SIZE-LARGE--CAPS" role="macro">
193
 
<title>AWN_FONT_SIZE_LARGE</title>
194
 
<indexterm zone="AWN-FONT-SIZE-LARGE--CAPS"><primary sortas="AWN_FONT_SIZE_LARGE">AWN_FONT_SIZE_LARGE</primary></indexterm><programlisting>#define AWN_FONT_SIZE_LARGE       15.0
195
 
</programlisting>
196
 
<para>
197
 
Large font size. For use with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.
198
 
Standardized font sizes to be used with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.  Corresponds to 
199
 
standard Pango font size units for standard <link linkend="PANGO-SCALE--CAPS"><literal>PANGO_SCALE</literal></link> when the awn icon
200
 
size is 48.0 pixels.</para>
201
 
<para>
202
 
</para></refsect2>
203
 
<refsect2 id="AWN-FONT-SIZE-EXTRA-LARGE--CAPS" role="macro">
204
 
<title>AWN_FONT_SIZE_EXTRA_LARGE</title>
205
 
<indexterm zone="AWN-FONT-SIZE-EXTRA-LARGE--CAPS"><primary sortas="AWN_FONT_SIZE_EXTRA_LARGE">AWN_FONT_SIZE_EXTRA_LARGE</primary></indexterm><programlisting>#define AWN_FONT_SIZE_EXTRA_LARGE 18.0
206
 
</programlisting>
207
 
<para>
208
 
Extra large font size. For use with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.
209
 
Standardized font sizes to be used with <link linkend="AwnOverlayText"><type>AwnOverlayText</type></link>.  Corresponds to 
210
 
standard Pango font size units for standard <link linkend="PANGO-SCALE--CAPS"><literal>PANGO_SCALE</literal></link> when the awn icon
211
 
size is 48.0 pixels.</para>
212
 
<para>
213
 
</para></refsect2>
214
 
 
215
 
</refsect1>
216
 
 
217
 
 
218
 
 
219
 
 
220
 
</refentry>