1
<refentry id="libxfce4util-Software-Licenses">
3
<refentrytitle role="top_of_page" id="libxfce4util-Software-Licenses.top_of_page">Software Licenses</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>LIBXFCE4UTIL Library</refmiscinfo>
9
<refname>Software Licenses</refname>
10
<refpurpose></refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
<refsynopsisdiv id="libxfce4util-Software-Licenses.synopsis" role="synopsis">
15
<title role="synopsis.title">Synopsis</title>
19
#include <libxfce4util/libxfce4util.h>
21
#define <link linkend="XFCE-LICENSE-BSD:CAPS">XFCE_LICENSE_BSD</link>
22
#define <link linkend="XFCE-LICENSE-GPL:CAPS">XFCE_LICENSE_GPL</link>
23
#define <link linkend="XFCE-LICENSE-LGPL:CAPS">XFCE_LICENSE_LGPL</link>
24
enum <link linkend="XfceLicenseTextType">XfceLicenseTextType</link>;
25
const <link linkend="gchar">gchar</link>* <link linkend="xfce-get-license-text">xfce_get_license_text</link> (<link linkend="XfceLicenseTextType">XfceLicenseTextType</link> license_type);
37
<refsect1 id="libxfce4util-Software-Licenses.description" role="desc">
38
<title role="desc.title">Description</title>
44
<refsect1 id="libxfce4util-Software-Licenses.details" role="details">
45
<title role="details.title">Details</title>
46
<refsect2 id="XFCE-LICENSE-BSD:CAPS" role="macro">
47
<title>XFCE_LICENSE_BSD</title>
48
<indexterm zone="XFCE-LICENSE-BSD:CAPS"><primary>XFCE_LICENSE_BSD</primary></indexterm><programlisting>#define XFCE_LICENSE_BSD (xfce_get_license_text (XFCE_LICENSE_TEXT_BSD))
51
Contains the text of the BSD license.
53
<refsect2 id="XFCE-LICENSE-GPL:CAPS" role="macro">
54
<title>XFCE_LICENSE_GPL</title>
55
<indexterm zone="XFCE-LICENSE-GPL:CAPS"><primary>XFCE_LICENSE_GPL</primary></indexterm><programlisting>#define XFCE_LICENSE_GPL (xfce_get_license_text (XFCE_LICENSE_TEXT_GPL))
58
Contains the text of the GNU General Public License.
60
<refsect2 id="XFCE-LICENSE-LGPL:CAPS" role="macro">
61
<title>XFCE_LICENSE_LGPL</title>
62
<indexterm zone="XFCE-LICENSE-LGPL:CAPS"><primary>XFCE_LICENSE_LGPL</primary></indexterm><programlisting>#define XFCE_LICENSE_LGPL (xfce_get_license_text (XFCE_LICENSE_TEXT_LGPL))
65
Contains the text of the GNU Lesser General Public License.
67
<refsect2 id="XfceLicenseTextType" role="enum">
68
<title>enum XfceLicenseTextType</title>
69
<indexterm zone="XfceLicenseTextType"><primary>XfceLicenseTextType</primary></indexterm><programlisting>typedef enum /*< enum >*/
71
XFCE_LICENSE_TEXT_BSD,
72
XFCE_LICENSE_TEXT_GPL,
73
XFCE_LICENSE_TEXT_LGPL,
74
} XfceLicenseTextType;
77
The license text to return from <link linkend="xfce-get-license-text"><function>xfce_get_license_text()</function></link>.</para>
80
</para><variablelist role="enum">
81
</variablelist></refsect2>
82
<refsect2 id="xfce-get-license-text" role="function">
83
<title>xfce_get_license_text ()</title>
84
<indexterm zone="xfce-get-license-text"><primary>xfce_get_license_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* xfce_get_license_text (<link linkend="XfceLicenseTextType">XfceLicenseTextType</link> license_type);</programlisting>
86
Returns the text of the software license specified in the
87
<parameter>license_type</parameter> translated to the current language. If no
88
translation is available, the english license text will
92
</para><variablelist role="params">
93
<varlistentry><term><parameter>license_type</parameter> :</term>
94
<listitem><simpara> an <link linkend="XfceLicenseTextType"><type>XfceLicenseTextType</type></link>.
95
</simpara></listitem></varlistentry>
96
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the license text for <parameter>license_type</parameter>.
97
</simpara></listitem></varlistentry>
98
</variablelist></refsect2>