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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="AsMenuParser">
<refmeta>
<refentrytitle role="top_of_page" id="AsMenuParser.top_of_page">AsMenuParser</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AsMenuParser</refname>
<refpurpose>Parser for XDG menu files designed for software-centers</refpurpose>
</refnamediv>
<refsect1 id="AsMenuParser.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-menu-parser-new">as_menu_parser_new</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-menu-parser-construct">as_menu_parser_construct</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-menu-parser-new-from-file">as_menu_parser_new_from_file</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-menu-parser-construct-from-file">as_menu_parser_construct_from_file</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-menu-parser-set-update-category-data">as_menu_parser_set_update_category_data</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-menu-parser-parse">as_menu_parser_parse</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-menu-parser-get-update-category-data">as_menu_parser_get_update_category_data</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-get-system-categories">as_get_system_categories</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsMenuParser.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="AsMenuParser--update-category-data">update-category-data</link></entry><entry role="property_flags">Read / Write</entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsMenuParser.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen> <link linkend="GObject">GObject</link>
<phrase role="lineart">╰──</phrase> AsMenuParser
</screen>
</refsect1>
<refsect1 id="AsMenuParser.includes"><title>Includes</title><synopsis>#include <appstream.h>
</synopsis></refsect1>
<refsect1 id="AsMenuParser.description" role="desc">
<title role="desc.title">Description</title>
<para>This object parses an XDG menu file and returns a set of <link linkend="AsCategory"><type>AsCategory</type></link> objects which
can be used by software-centers to group the applications they show.
By default, it loads a common set of categories from an internal menu file.
A custom menu file may be specified using the alternative class constructor.</para>
<para>See also: <link linkend="AsCategory"><type>AsCategory</type></link></para>
</refsect1>
<refsect1 id="AsMenuParser.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-menu-parser-new" role="function">
<title>as_menu_parser_new ()</title>
<indexterm zone="as-menu-parser-new"><primary>as_menu_parser_new</primary></indexterm>
<programlisting language="C"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
as_menu_parser_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="AsMenuParser"><type>AsMenuParser</type></link>.</para>
<refsect3 role="returns">
<title>Returns</title>
<para> an <link linkend="AsMenuParser"><type>AsMenuParser</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-menu-parser-construct" role="function">
<title>as_menu_parser_construct ()</title>
<indexterm zone="as-menu-parser-construct"><primary>as_menu_parser_construct</primary></indexterm>
<programlisting language="C"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
as_menu_parser_construct (<parameter><link linkend="GType"><type>GType</type></link> object_type</parameter>);</programlisting>
<para>Create a new MenuParser for the generic AppStream categories list</para>
<refsect3 role="returns">
<title>Returns</title>
<para> an <link linkend="AsMenuParser"><type>AsMenuParser</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-menu-parser-new-from-file" role="function">
<title>as_menu_parser_new_from_file ()</title>
<indexterm zone="as-menu-parser-new-from-file"><primary>as_menu_parser_new_from_file</primary></indexterm>
<programlisting language="C"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
as_menu_parser_new_from_file (<parameter>const <link linkend="gchar"><type>gchar</type></link> *menu_file</parameter>);</programlisting>
<para>Creates a new <link linkend="AsMenuParser"><type>AsMenuParser</type></link> with a custom XDG menu file.</para>
<para><parameter>menu_file</parameter>
a custom XDG menu XML file</para>
<refsect3 role="returns">
<title>Returns</title>
<para> an <link linkend="AsMenuParser"><type>AsMenuParser</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-menu-parser-construct-from-file" role="function">
<title>as_menu_parser_construct_from_file ()</title>
<indexterm zone="as-menu-parser-construct-from-file"><primary>as_menu_parser_construct_from_file</primary></indexterm>
<programlisting language="C"><link linkend="AsMenuParser"><returnvalue>AsMenuParser</returnvalue></link> *
as_menu_parser_construct_from_file (<parameter><link linkend="GType"><type>GType</type></link> object_type</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *menu_file</parameter>);</programlisting>
<para>Create a new MenuParser for an arbitrary menu file</para>
<refsect3 role="returns">
<title>Returns</title>
<para> an <link linkend="AsMenuParser"><type>AsMenuParser</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-menu-parser-set-update-category-data" role="function">
<title>as_menu_parser_set_update_category_data ()</title>
<indexterm zone="as-menu-parser-set-update-category-data"><primary>as_menu_parser_set_update_category_data</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_menu_parser_set_update_category_data
(<parameter><link linkend="AsMenuParser"><type>AsMenuParser</type></link> *self</parameter>,
<parameter><link linkend="gboolean"><type>gboolean</type></link> value</parameter>);</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="as-menu-parser-parse" role="function">
<title>as_menu_parser_parse ()</title>
<indexterm zone="as-menu-parser-parse"><primary>as_menu_parser_parse</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link> *
as_menu_parser_parse (<parameter><link linkend="AsMenuParser"><type>AsMenuParser</type></link> *self</parameter>);</programlisting>
<para>Parse the menu file</para>
<refsect3 role="returns">
<title>Returns</title>
<para> <link linkend="GList"><type>GList</type></link> of <link linkend="AsCategory"><type>AsCategory</type></link> objects found in the menu, or NULL if there was an error. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> AsCategory][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-menu-parser-get-update-category-data" role="function">
<title>as_menu_parser_get_update_category_data ()</title>
<indexterm zone="as-menu-parser-get-update-category-data"><primary>as_menu_parser_get_update_category_data</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
as_menu_parser_get_update_category_data
(<parameter><link linkend="AsMenuParser"><type>AsMenuParser</type></link> *self</parameter>);</programlisting>
<para>
</para>
<refsect3 role="returns">
<title>Returns</title>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-get-system-categories" role="function">
<title>as_get_system_categories ()</title>
<indexterm zone="as-get-system-categories"><primary>as_get_system_categories</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link> *
as_get_system_categories (<parameter><type>void</type></parameter>);</programlisting>
<para>Get a GList of the default AppStream categories</para>
<refsect3 role="returns">
<title>Returns</title>
<para> <link linkend="GList"><type>GList</type></link> of <link linkend="AsCategory"><type>AsCategory</type></link> objects. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> AsCategory][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
</refsect1>
<refsect1 id="AsMenuParser.other_details" role="details">
<title role="details.title">Types and Values</title>
</refsect1>
<refsect1 id="AsMenuParser.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="AsMenuParser--update-category-data" role="property"><title>The <literal>“update-category-data”</literal> property</title>
<indexterm zone="AsMenuParser--update-category-data"><primary>AsMenuParser:update-category-data</primary></indexterm>
<programlisting> “update-category-data” <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>update-category-data.</para><para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>
</refsect1>
</refentry>
|
