~timo-jyrinki/ubuntu/utopic/rhythmbox/enable_grilo_rhythmbox

<?xml version="1.0"?>

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 

               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="rhythmbox-rb-builder-helpers">

<refmeta>

<refentrytitle role="top_of_page" id="rhythmbox-rb-builder-helpers.top_of_page">rb-builder-helpers</refentrytitle>

<manvolnum>3</manvolnum>

<refmiscinfo>RHYTHMBOX Library</refmiscinfo>

</refmeta>

 

<refnamediv>

<refname>rb-builder-helpers</refname>

<refpurpose>helper functions for dealing with GtkBuilder files</refpurpose>

</refnamediv>

 

<refsynopsisdiv id="rhythmbox-rb-builder-helpers.synopsis" role="synopsis">

<title role="synopsis.title">Synopsis</title>

 

<synopsis>

<link linkend="GtkBuilder">GtkBuilder</link> *        <link linkend="rb-builder-load">rb_builder_load</link>                     (const <link linkend="char">char</link> *file,

                                                         <link linkend="gpointer">gpointer</link> user_data);

<link linkend="void">void</link>                <link linkend="rb-builder-boldify-label">rb_builder_boldify_label</link>            (<link linkend="GtkBuilder">GtkBuilder</link> *builder,

                                                         const <link linkend="char">char</link> *name);

<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,

                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter,

                                                         <link linkend="gpointer">gpointer</link> data);

</synopsis>

</refsynopsisdiv>

 

 

 

 

 

 

 

 

 

<refsect1 id="rhythmbox-rb-builder-helpers.description" role="desc">

<title role="desc.title">Description</title>

<para>

Some simple helper functions to make it a bit easier to deal with

widgets built from GtkBuilder files.</para>

<para>

</para>

</refsect1>

 

<refsect1 id="rhythmbox-rb-builder-helpers.details" role="details">

<title role="details.title">Details</title>

<refsect2 id="rb-builder-load" role="function">

<title>rb_builder_load ()</title>

<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,

                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>

<para>

Locates and reads a GtkBuilder file, automatically connecting

signal handlers where possible.  The caller can specify a path

relative to the shared data directory, or its 'ui' or 'art'

subdirectories.</para>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>file</parameter>&#160;:</term>

<listitem><simpara> filename, either absolute or relative to the data directory

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>user_data</parameter>&#160;:</term>

<listitem><simpara> user data to pass to autoconnected signal handlers

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GtkBuilder"><type>GtkBuilder</type></link> object built from the file

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2 id="rb-builder-boldify-label" role="function">

<title>rb_builder_boldify_label ()</title>

<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,

                                                         const <link linkend="char">char</link> *name);</programlisting>

<para>

Makes a label built from a GtkBuilder file bold.</para>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>builder</parameter>&#160;:</term>

<listitem><simpara> a <link linkend="GtkBuilder"><type>GtkBuilder</type></link> instance

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>name</parameter>&#160;:</term>

<listitem><simpara> name of the label to boldify

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2 id="rb-combo-box-hyphen-separator-func" role="function">

<title>rb_combo_box_hyphen_separator_func ()</title>

<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,

                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter,

                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>

<para>

A row separator function to use for GtkComboBox widgets.

It expects the model to contain a string in its first column,

and interprets a string containing a single hyphen character

as a separator.</para>

<para>

</para><variablelist role="params">

<varlistentry><term><parameter>model</parameter>&#160;:</term>

<listitem><simpara> a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link>

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>iter</parameter>&#160;:</term>

<listitem><simpara> a <link linkend="GtkTreeIter"><type>GtkTreeIter</type></link>

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>data</parameter>&#160;:</term>

<listitem><simpara> nothing

</simpara></listitem></varlistentry>

<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

</simpara></listitem></varlistentry>

</variablelist></refsect2>

 

</refsect1>

 

 

 

 

</refentry>