4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>YelpLocationEntry</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Yelp Reference Manual">
8
<link rel="up" href="ch01.html#id2936732" title="Widgets">
8
<link rel="up" href="ch01.html#id2796874" title="Widgets">
9
9
<link rel="prev" href="YelpView.html" title="YelpView">
10
10
<link rel="next" href="ch01s02.html" title="Document Processing">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
16
<tr valign="middle">
17
17
<td><a accesskey="p" href="YelpView.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch01.html#id2936732"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
18
<td><a accesskey="u" href="ch01.html#id2796874"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">Yelp Reference Manual</th>
21
21
<td><a accesskey="n" href="ch01s02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
44
44
<td valign="top" align="right"></td>
45
45
</tr></table></div>
46
<div class="refsynopsisdiv" title="Synopsis">
46
<div class="refsynopsisdiv">
47
47
<a name="YelpLocationEntry.synopsis"></a><h2>Synopsis</h2>
48
48
<pre class="synopsis">
49
49
#include <yelp.h>
51
<a href="YelpLocationEntry.html#YelpLocationEntry-struct">YelpLocationEntry</a>;
52
<a href="YelpLocationEntry.html#YelpLocationEntryClass">YelpLocationEntryClass</a>;
53
<span class="returnvalue">GtkWidget</span> * <a href="YelpLocationEntry.html#yelp-location-entry-new">yelp_location_entry_new</a> (<em class="parameter"><code><a href="YelpView.html"><span class="type">YelpView</span></a> *window</code></em>,
51
struct <a href="YelpLocationEntry.html#YelpLocationEntry-struct">YelpLocationEntry</a>;
52
struct <a href="YelpLocationEntry.html#YelpLocationEntryClass">YelpLocationEntryClass</a>;
53
<a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a href="YelpLocationEntry.html#yelp-location-entry-new">yelp_location_entry_new</a> (<em class="parameter"><code><a href="YelpView.html"><span class="type">YelpView</span></a> *window</code></em>,
54
54
<em class="parameter"><code><span class="type">YelpBookmarks</span> *bookmarks</code></em>);
55
55
<span class="returnvalue">void</span> <a href="YelpLocationEntry.html#yelp-location-entry-start-search">yelp_location_entry_start_search</a> (<em class="parameter"><code><a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *entry</code></em>);
58
<div class="refsect1" title="Object Hierarchy">
58
<div class="refsect1">
59
59
<a name="YelpLocationEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
60
60
<pre class="synopsis">
62
+----GInitiallyUnowned
61
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
62
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
63
+----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
64
+----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
65
+----<a href="http://library.gnome.org/devel/gtk/GtkBin.html">GtkBin</a>
66
+----<a href="http://library.gnome.org/devel/gtk/GtkComboBox.html">GtkComboBox</a>
67
67
+----YelpLocationEntry
70
<div class="refsect1" title="Implemented Interfaces">
70
<div class="refsect1">
71
71
<a name="YelpLocationEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
73
73
YelpLocationEntry implements
74
AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.</p>
74
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a>, <a href="http://library.gnome.org/devel/gtk/GtkCellLayout.html">GtkCellLayout</a> and <a href="http://library.gnome.org/devel/gtk/GtkCellEditable.html">GtkCellEditable</a>.</p>
76
<div class="refsect1" title="Properties">
76
<div class="refsect1">
77
77
<a name="YelpLocationEntry.properties"></a><h2>Properties</h2>
78
78
<pre class="synopsis">
79
79
"<a href="YelpLocationEntry.html#YelpLocationEntry--bookmarks">bookmarks</a>" <span class="type">YelpBookmarks</span>* : Read / Write / Construct Only
80
"<a href="YelpLocationEntry.html#YelpLocationEntry--enable-search">enable-search</a>" <span class="type">gboolean</span> : Read / Write / Construct
80
"<a href="YelpLocationEntry.html#YelpLocationEntry--enable-search">enable-search</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
81
81
"<a href="YelpLocationEntry.html#YelpLocationEntry--view">view</a>" <a href="YelpView.html"><span class="type">YelpView</span></a>* : Read / Write / Construct Only
84
<div class="refsect1" title="Signals">
84
<div class="refsect1">
85
85
<a name="YelpLocationEntry.signals"></a><h2>Signals</h2>
86
86
<pre class="synopsis">
87
"<a href="YelpLocationEntry.html#YelpLocationEntry-bookmark-clicked">bookmark-clicked</a>" : Run Last
88
"<a href="YelpLocationEntry.html#YelpLocationEntry-location-selected">location-selected</a>" : Run Last
89
"<a href="YelpLocationEntry.html#YelpLocationEntry-search-activated">search-activated</a>" : Run Last
87
"<a href="YelpLocationEntry.html#YelpLocationEntry-bookmark-clicked">bookmark-clicked</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
88
"<a href="YelpLocationEntry.html#YelpLocationEntry-location-selected">location-selected</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
89
"<a href="YelpLocationEntry.html#YelpLocationEntry-search-activated">search-activated</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
92
<div class="refsect1" title="Description">
92
<div class="refsect1">
93
93
<a name="YelpLocationEntry.description"></a><h2>Description</h2>
95
<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> is a <span class="type">GtkComboBox</span> designed to show the current location,
95
<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> is a <a href="http://library.gnome.org/devel/gtk/GtkComboBox.html"><span class="type">GtkComboBox</span></a> designed to show the current location,
96
96
provide a drop-down menu of previous locations, and allow the user to perform
100
The <span class="type">GtkTreeModel</span> used by a <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> is expected to have at least
100
The <a href="http://library.gnome.org/devel/gtk/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> used by a <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> is expected to have at least
101
101
four columns: <span class="type">"entry-text-column"</span> contains the displayed name
102
102
of the location, <span class="type">"desc-column"</span> contains a description
103
103
for each entry, <span class="type">"icon-column"</span> contains an icon name for
124
124
will cause the FIXME signal to be emitted.
127
<div class="refsect1" title="Details">
127
<div class="refsect1">
128
128
<a name="YelpLocationEntry.details"></a><h2>Details</h2>
129
<div class="refsect2" title="YelpLocationEntry">
130
<a name="YelpLocationEntry-struct"></a><h3>YelpLocationEntry</h3>
131
<pre class="programlisting">typedef struct _YelpLocationEntry YelpLocationEntry;</pre>
129
<div class="refsect2">
130
<a name="YelpLocationEntry-struct"></a><h3>struct YelpLocationEntry</h3>
131
<pre class="programlisting">struct YelpLocationEntry;</pre>
134
<div class="refsect2" title="YelpLocationEntryClass">
135
<a name="YelpLocationEntryClass"></a><h3>YelpLocationEntryClass</h3>
136
<pre class="programlisting">typedef struct {
134
<div class="refsect2">
135
<a name="YelpLocationEntryClass"></a><h3>struct YelpLocationEntryClass</h3>
136
<pre class="programlisting">struct YelpLocationEntryClass {
137
137
GtkComboBoxClass parent;
139
139
void (* location_selected) (YelpLocationEntry *entry);
145
145
void (*_gtk_reserved1) (void);
146
146
void (*_gtk_reserved2) (void);
147
147
void (*_gtk_reserved3) (void);
148
} YelpLocationEntryClass;
152
<div class="refsect2" title="yelp_location_entry_new ()">
152
<div class="refsect2">
153
153
<a name="yelp-location-entry-new"></a><h3>yelp_location_entry_new ()</h3>
154
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * yelp_location_entry_new (<em class="parameter"><code><a href="YelpView.html"><span class="type">YelpView</span></a> *window</code></em>,
154
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * yelp_location_entry_new (<em class="parameter"><code><a href="YelpView.html"><span class="type">YelpView</span></a> *window</code></em>,
155
155
<em class="parameter"><code><span class="type">YelpBookmarks</span> *bookmarks</code></em>);</pre>
157
157
Creates a new <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> widget to control <em class="parameter"><code>view</code></em>.
163
163
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
164
<td>A <a href="YelpView.html"><span class="type">YelpView</span></a>.
164
<td>A <a href="YelpView.html"><span class="type">YelpView</span></a>.</td>
168
167
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
169
<td> A new <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a>.
168
<td>A new <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a>.</td>
176
<div class="refsect2" title="yelp_location_entry_start_search ()">
174
<div class="refsect2">
177
175
<a name="yelp-location-entry-start-search"></a><h3>yelp_location_entry_start_search ()</h3>
178
176
<pre class="programlisting"><span class="returnvalue">void</span> yelp_location_entry_start_search (<em class="parameter"><code><a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *entry</code></em>);</pre>
224
<div class="refsect1" title="Signal Details">
221
<div class="refsect1">
225
222
<a name="YelpLocationEntry.signal-details"></a><h2>Signal Details</h2>
226
<div class="refsect2" title='The "bookmark-clicked" signal'>
223
<div class="refsect2">
227
224
<a name="YelpLocationEntry-bookmark-clicked"></a><h3>The <code class="literal">"bookmark-clicked"</code> signal</h3>
228
225
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *widget,
229
<span class="type">gpointer</span> user_data) : Run Last</pre>
226
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
231
228
This signal will be emitted whenever a user clicks the bookmark icon
232
229
embedded in the location entry.
286
<div class="refsect2" title='The "search-activated" signal'>
279
<div class="refsect2">
287
280
<a name="YelpLocationEntry-search-activated"></a><h3>The <code class="literal">"search-activated"</code> signal</h3>
288
281
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> *widget,
289
<span class="type">gchar</span> *text,
290
<span class="type">gpointer</span> user_data) : Run Last</pre>
282
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text,
283
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
292
285
This signal will be emitted whenever the user activates a search, generally
293
286
by pressing <span class="keycap"><strong>Enter</strong></span> in the embedded text entry while <em class="parameter"><code>widget</code></em>
300
293
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
301
<td>The <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> for which the signal was emitted.
294
<td>The <a href="YelpLocationEntry.html"><span class="type">YelpLocationEntry</span></a> for which the signal was emitted.</td>
305
297
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
298
<td>The search text.</td>
310
301
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
311
<td>User data set when the handler was connected.
302
<td>User data set when the handler was connected.</td>
315
305
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>