← Back to branch summary

~noskcaj/ubuntu/wily/epiphany-browser/merge

« back to all changes in this revision

Viewing changes to doc/reference/xml/ephy-window.xml

Tags: upstream-2.30.3
Import upstream version 2.30.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/ephy-window.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="EphyWindow">
 
5
<refmeta>
 
6
<refentrytitle role="top_of_page" id="EphyWindow.top_of_page">EphyWindow</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>
 
9
  EPIPHANY Library
 
10
</refmiscinfo>
 
11
</refmeta>
 
12
<refnamediv>
 
13
<refname>EphyWindow</refname>
 
14
<refpurpose>Epiphany's main <link linkend="GtkWindow"><type>GtkWindow</type></link> widget</refpurpose>
 
15
</refnamediv>
 
16
 
 
17
<refsynopsisdiv id="EphyWindow.synopsis" role="synopsis">
 
18
<title role="synopsis.title">Synopsis</title>
 
19
 
 
20
<synopsis>                    <link linkend="EphyWindow-struct">EphyWindow</link>;
 
21
<link linkend="EphyWindow"><returnvalue>EphyWindow</returnvalue></link> *        <link linkend="ephy-window-new">ephy_window_new</link>                     (<parameter><type>void</type></parameter>);
 
22
<link linkend="EphyWindow"><returnvalue>EphyWindow</returnvalue></link> *        <link linkend="ephy-window-new-with-chrome">ephy_window_new_with_chrome</link>         (<parameter><link linkend="EphyWebViewChrome"><type>EphyWebViewChrome</type></link> chrome</parameter>,
 
23
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_popup</parameter>);
 
24
<link linkend="GObject"><returnvalue>GObject</returnvalue></link> *           <link linkend="ephy-window-get-ui-manager">ephy_window_get_ui_manager</link>          (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
25
<link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         <link linkend="ephy-window-get-toolbar">ephy_window_get_toolbar</link>             (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
26
<link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         <link linkend="ephy-window-get-notebook">ephy_window_get_notebook</link>            (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
27
<link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         <link linkend="ephy-window-get-find-toolbar">ephy_window_get_find_toolbar</link>        (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
28
<link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         <link linkend="ephy-window-get-statusbar">ephy_window_get_statusbar</link>           (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
29
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-window-load-url">ephy_window_load_url</link>                (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>,
 
30
                                                         <parameter>const <link linkend="char"><type>char</type></link> *url</parameter>);
 
31
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-window-set-zoom">ephy_window_set_zoom</link>                (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>,
 
32
                                                         <parameter><link linkend="float"><type>float</type></link> zoom</parameter>);
 
33
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="ephy-window-activate-location">ephy_window_activate_location</link>       (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
34
<link linkend="EphyEmbedEvent"><returnvalue>EphyEmbedEvent</returnvalue></link> *    <link linkend="ephy-window-get-context-event">ephy_window_get_context_event</link>       (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);
 
35
</synopsis>
 
36
</refsynopsisdiv>
 
37
<refsect1 id="EphyWindow.object-hierarchy" role="object_hierarchy">
 
38
<title role="object_hierarchy.title">Object Hierarchy</title>
 
39
<synopsis>
 
40
  <link linkend="GObject">GObject</link>
 
41
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
42
         +----<link linkend="GtkObject">GtkObject</link>
 
43
               +----<link linkend="GtkWidget">GtkWidget</link>
 
44
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
45
                           +----<link linkend="GtkBin">GtkBin</link>
 
46
                                 +----<link linkend="GtkWindow">GtkWindow</link>
 
47
                                       +----EphyWindow
 
48
</synopsis>
 
49
</refsect1>
 
50
<refsect1 id="EphyWindow.implemented-interfaces" role="impl_interfaces">
 
51
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
52
<para>
 
53
EphyWindow implements
 
54
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="EphyLink">EphyLink</link> and  <link linkend="EphyEmbedContainer">EphyEmbedContainer</link>.</para>
 
55
</refsect1>
 
56
 
 
57
<refsect1 id="EphyWindow.description" role="desc">
 
58
<title role="desc.title">Description</title>
 
59
<para>
 
60
<link linkend="EphyWindow"><type>EphyWindow</type></link> is Epiphany's main widget.
 
61
</para>
 
62
</refsect1>
 
63
<refsect1 id="EphyWindow.details" role="details">
 
64
<title role="details.title">Details</title>
 
65
<refsect2 id="EphyWindow-struct" role="struct">
 
66
<title>EphyWindow</title>
 
67
<indexterm zone="EphyWindow-struct"><primary>EphyWindow</primary></indexterm>
 
68
<programlisting>typedef struct _EphyWindow EphyWindow;</programlisting>
 
69
<para>
 
70
</para></refsect2>
 
71
<refsect2 id="ephy-window-new" role="function">
 
72
<title>ephy_window_new ()</title>
 
73
<indexterm zone="ephy-window-new"><primary>ephy_window_new</primary></indexterm>
 
74
<programlisting><link linkend="EphyWindow"><returnvalue>EphyWindow</returnvalue></link> *        ephy_window_new                     (<parameter><type>void</type></parameter>);</programlisting>
 
75
<para>
 
76
Equivalent to <link linkend="g-object-new"><function>g_object_new()</function></link> but returns an <link linkend="EphyWindow"><type>EphyWindow</type></link> so you don't have
 
77
to cast it.
 
78
</para><variablelist role="params">
 
79
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
80
</simpara></listitem></varlistentry>
 
81
</variablelist></refsect2>
 
82
<refsect2 id="ephy-window-new-with-chrome" role="function">
 
83
<title>ephy_window_new_with_chrome ()</title>
 
84
<indexterm zone="ephy-window-new-with-chrome"><primary>ephy_window_new_with_chrome</primary></indexterm>
 
85
<programlisting><link linkend="EphyWindow"><returnvalue>EphyWindow</returnvalue></link> *        ephy_window_new_with_chrome         (<parameter><link linkend="EphyWebViewChrome"><type>EphyWebViewChrome</type></link> chrome</parameter>,
 
86
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_popup</parameter>);</programlisting>
 
87
<para>
 
88
Identical to <link linkend="ephy-window-new"><function>ephy_window_new()</function></link>, but allows you to specify a chrome.
 
89
</para><variablelist role="params">
 
90
<varlistentry><term><parameter>chrome</parameter>&#160;:</term>
 
91
<listitem><simpara>an <link linkend="EphyWebViewChrome"><type>EphyWebViewChrome</type></link>
 
92
</simpara></listitem></varlistentry>
 
93
<varlistentry><term><parameter>is_popup</parameter>&#160;:</term>
 
94
<listitem><simpara>whether the new window is a popup window
 
95
</simpara></listitem></varlistentry>
 
96
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
97
</simpara></listitem></varlistentry>
 
98
</variablelist></refsect2>
 
99
<refsect2 id="ephy-window-get-ui-manager" role="function">
 
100
<title>ephy_window_get_ui_manager ()</title>
 
101
<indexterm zone="ephy-window-get-ui-manager"><primary>ephy_window_get_ui_manager</primary></indexterm>
 
102
<programlisting><link linkend="GObject"><returnvalue>GObject</returnvalue></link> *           ephy_window_get_ui_manager          (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
103
<para>
 
104
Returns this window's UI manager.
 
105
</para><variablelist role="params">
 
106
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
107
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="GtkUIManager"><type>GtkUIManager</type></link>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
 
110
</variablelist></refsect2>
 
111
<refsect2 id="ephy-window-get-toolbar" role="function">
 
112
<title>ephy_window_get_toolbar ()</title>
 
113
<indexterm zone="ephy-window-get-toolbar"><primary>ephy_window_get_toolbar</primary></indexterm>
 
114
<programlisting><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         ephy_window_get_toolbar             (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
115
<para>
 
116
Returns this window's toolbar as an <link linkend="EggEditableToolbar"><type>EggEditableToolbar</type></link>.
 
117
</para><variablelist role="params">
 
118
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
119
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="EggEditableToolbar"><type>EggEditableToolbar</type></link>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
 
122
</variablelist></refsect2>
 
123
<refsect2 id="ephy-window-get-notebook" role="function">
 
124
<title>ephy_window_get_notebook ()</title>
 
125
<indexterm zone="ephy-window-get-notebook"><primary>ephy_window_get_notebook</primary></indexterm>
 
126
<programlisting><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         ephy_window_get_notebook            (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
127
<para>
 
128
Returns the <link linkend="GtkNotebook"><type>GtkNotebook</type></link> used by this window.
 
129
</para><variablelist role="params">
 
130
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
131
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <parameter>window</parameter>'s <link linkend="GtkNotebook"><type>GtkNotebook</type></link>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
 
134
</variablelist></refsect2>
 
135
<refsect2 id="ephy-window-get-find-toolbar" role="function">
 
136
<title>ephy_window_get_find_toolbar ()</title>
 
137
<indexterm zone="ephy-window-get-find-toolbar"><primary>ephy_window_get_find_toolbar</primary></indexterm>
 
138
<programlisting><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         ephy_window_get_find_toolbar        (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
139
<para>
 
140
Returns the <link linkend="EphyFindToolbar"><type>EphyFindToolbar</type></link> used by this window.
 
141
</para><variablelist role="params">
 
142
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
143
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <parameter>window</parameter>'s <link linkend="EphyFindToolbar"><type>EphyFindToolbar</type></link>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
 
146
</variablelist></refsect2>
 
147
<refsect2 id="ephy-window-get-statusbar" role="function">
 
148
<title>ephy_window_get_statusbar ()</title>
 
149
<indexterm zone="ephy-window-get-statusbar"><primary>ephy_window_get_statusbar</primary></indexterm>
 
150
<programlisting><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         ephy_window_get_statusbar           (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
151
<para>
 
152
Returns this window's statusbar as an <link linkend="EphyStatusbar"><type>EphyStatusbar</type></link>.
 
153
</para><variablelist role="params">
 
154
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
155
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
156
</simpara></listitem></varlistentry>
 
157
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> This window's statusbar. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
 
158
</variablelist></refsect2>
 
159
<refsect2 id="ephy-window-load-url" role="function">
 
160
<title>ephy_window_load_url ()</title>
 
161
<indexterm zone="ephy-window-load-url"><primary>ephy_window_load_url</primary></indexterm>
 
162
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_window_load_url                (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>,
 
163
                                                         <parameter>const <link linkend="char"><type>char</type></link> *url</parameter>);</programlisting>
 
164
<para>
 
165
Loads a new url in the active tab of <parameter>window</parameter>.
 
166
Unlike <link linkend="ephy-web-view-load-url"><function>ephy_web_view_load_url()</function></link>, this function activates
 
167
the embed.
 
168
</para><variablelist role="params">
 
169
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
170
<listitem><simpara>a <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><parameter>url</parameter>&#160;:</term>
 
173
<listitem><simpara>the url to load
 
174
</simpara></listitem></varlistentry>
 
175
</variablelist></refsect2>
 
176
<refsect2 id="ephy-window-set-zoom" role="function">
 
177
<title>ephy_window_set_zoom ()</title>
 
178
<indexterm zone="ephy-window-set-zoom"><primary>ephy_window_set_zoom</primary></indexterm>
 
179
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_window_set_zoom                (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>,
 
180
                                                         <parameter><link linkend="float"><type>float</type></link> zoom</parameter>);</programlisting>
 
181
<para>
 
182
Sets the zoom on <parameter>window</parameter>'s active <link linkend="EphyEmbed"><type>EphyEmbed</type></link>. A <parameter>zoom</parameter> of 1.0 corresponds to
 
183
100% zoom (normal size).
 
184
</para><variablelist role="params">
 
185
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
186
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><parameter>zoom</parameter>&#160;:</term>
 
189
<listitem><simpara>the desired zoom level
 
190
</simpara></listitem></varlistentry>
 
191
</variablelist></refsect2>
 
192
<refsect2 id="ephy-window-activate-location" role="function">
 
193
<title>ephy_window_activate_location ()</title>
 
194
<indexterm zone="ephy-window-activate-location"><primary>ephy_window_activate_location</primary></indexterm>
 
195
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                ephy_window_activate_location       (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
196
<para>
 
197
Activates the location entry on <parameter>window</parameter>'s toolbar.
 
198
</para><variablelist role="params">
 
199
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
200
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
201
</simpara></listitem></varlistentry>
 
202
</variablelist></refsect2>
 
203
<refsect2 id="ephy-window-get-context-event" role="function">
 
204
<title>ephy_window_get_context_event ()</title>
 
205
<indexterm zone="ephy-window-get-context-event"><primary>ephy_window_get_context_event</primary></indexterm>
 
206
<programlisting><link linkend="EphyEmbedEvent"><returnvalue>EphyEmbedEvent</returnvalue></link> *    ephy_window_get_context_event       (<parameter><link linkend="EphyWindow"><type>EphyWindow</type></link> *window</parameter>);</programlisting>
 
207
<para>
 
208
Returns the <link linkend="EphyEmbedEvent"><type>EphyEmbedEvent</type></link> for the current context menu.
 
209
Use this to get the event from the action callback.
 
210
</para><variablelist role="params">
 
211
<varlistentry><term><parameter>window</parameter>&#160;:</term>
 
212
<listitem><simpara>an <link linkend="EphyWindow"><type>EphyWindow</type></link>
 
213
</simpara></listitem></varlistentry>
 
214
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="EphyEmbedEvent"><type>EphyEmbedEvent</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
 
215
</variablelist></refsect2>
 
216
 
 
217
</refsect1>
 
218
 
 
219
</refentry>