← Back to branch summary

~ubuntu-branches/ubuntu/lucid/rhythmbox/lucid-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-builder-helpers.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-29 10:12:48 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20100329101248-fu29j0q1s2dx8k99
Tags: 0.12.8-0ubuntu1
* New upstream version
* debian/patches/90_autoreconf.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-builder-helpers.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="rhythmbox-rb-builder-helpers">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="rhythmbox-rb-builder-helpers.top_of_page">rb-builder-helpers</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>rb-builder-helpers</refname>
13
 
<refpurpose>helper functions for dealing with GtkBuilder files</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="rhythmbox-rb-builder-helpers.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
<link linkend="GtkBuilder">GtkBuilder</link> *        <link linkend="rb-builder-load">rb_builder_load</link>                     (const <link linkend="char">char</link> *file,
21
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
22
 
<link linkend="void">void</link>                <link linkend="rb-builder-boldify-label">rb_builder_boldify_label</link>            (<link linkend="GtkBuilder">GtkBuilder</link> *builder,
23
 
                                                         const <link linkend="char">char</link> *name);
24
 
<link linkend="gboolean">gboolean</link>            <link linkend="rb-combo-box-hyphen-separator-func">rb_combo_box_hyphen_separator_func</link>  (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
25
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter,
26
 
                                                         <link linkend="gpointer">gpointer</link> data);
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
<refsect1 id="rhythmbox-rb-builder-helpers.description" role="desc">
39
 
<title role="desc.title">Description</title>
40
 
<para>
41
 
Some simple helper functions to make it a bit easier to deal with
42
 
widgets built from GtkBuilder files.</para>
43
 
<para>
44
 
</para>
45
 
</refsect1>
46
 
 
47
 
<refsect1 id="rhythmbox-rb-builder-helpers.details" role="details">
48
 
<title role="details.title">Details</title>
49
 
<refsect2 id="rb-builder-load" role="function">
50
 
<title>rb_builder_load ()</title>
51
 
<indexterm zone="rb-builder-load"><primary sortas="rb_builder_load">rb_builder_load</primary></indexterm><programlisting><link linkend="GtkBuilder">GtkBuilder</link> *        rb_builder_load                     (const <link linkend="char">char</link> *file,
52
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
53
 
<para>
54
 
Locates and reads a GtkBuilder file, automatically connecting
55
 
signal handlers where possible.  The caller can specify a path
56
 
relative to the shared data directory, or its 'ui' or 'art'
57
 
subdirectories.</para>
58
 
<para>
59
 
</para><variablelist role="params">
60
 
<varlistentry><term><parameter>file</parameter>&#160;:</term>
61
 
<listitem><simpara> filename, either absolute or relative to the data directory
62
 
</simpara></listitem></varlistentry>
63
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
64
 
<listitem><simpara> user data to pass to autoconnected signal handlers
65
 
</simpara></listitem></varlistentry>
66
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GtkBuilder"><type>GtkBuilder</type></link> object built from the file
67
 
</simpara></listitem></varlistentry>
68
 
</variablelist></refsect2>
69
 
<refsect2 id="rb-builder-boldify-label" role="function">
70
 
<title>rb_builder_boldify_label ()</title>
71
 
<indexterm zone="rb-builder-boldify-label"><primary sortas="rb_builder_boldify_label">rb_builder_boldify_label</primary></indexterm><programlisting><link linkend="void">void</link>                rb_builder_boldify_label            (<link linkend="GtkBuilder">GtkBuilder</link> *builder,
72
 
                                                         const <link linkend="char">char</link> *name);</programlisting>
73
 
<para>
74
 
Makes a label built from a GtkBuilder file bold.</para>
75
 
<para>
76
 
</para><variablelist role="params">
77
 
<varlistentry><term><parameter>builder</parameter>&#160;:</term>
78
 
<listitem><simpara> a <link linkend="GtkBuilder"><type>GtkBuilder</type></link> instance
79
 
</simpara></listitem></varlistentry>
80
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
81
 
<listitem><simpara> name of the label to boldify
82
 
</simpara></listitem></varlistentry>
83
 
</variablelist></refsect2>
84
 
<refsect2 id="rb-combo-box-hyphen-separator-func" role="function">
85
 
<title>rb_combo_box_hyphen_separator_func ()</title>
86
 
<indexterm zone="rb-combo-box-hyphen-separator-func"><primary sortas="rb_combo_box_hyphen_separator_func">rb_combo_box_hyphen_separator_func</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_combo_box_hyphen_separator_func  (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
87
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter,
88
 
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
89
 
<para>
90
 
A row separator function to use for GtkComboBox widgets.
91
 
It expects the model to contain a string in its first column,
92
 
and interprets a string containing a single hyphen character
93
 
as a separator.</para>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>model</parameter>&#160;:</term>
97
 
<listitem><simpara> a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link>
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
100
 
<listitem><simpara> a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link>
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><parameter>data</parameter>&#160;:</term>
103
 
<listitem><simpara> nothing
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the row pointed to by <parameter>iter</parameter> is a separator
106
 
</simpara></listitem></varlistentry>
107
 
</variablelist></refsect2>
108
 
 
109
 
</refsect1>
110
 
 
111
 
 
112
 
 
113
 
 
114
 
</refentry>