~ubuntu-branches/ubuntu/precise/evince/precise-updates

« back to all changes in this revision

Viewing changes to help/reference/shell/xml/ev-page-action-widget.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2009-02-10 15:24:04 UTC
  • mto: (1.6.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 72.
  • Revision ID: james.westby@ubuntu.com-20090210152404-9el29bkm4unsnj6n
Tags: upstream-2.25.90
ImportĀ upstreamĀ versionĀ 2.25.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<refentry id="EvPageActionWidget">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page" id="EvPageActionWidget.top_of_page">EvPageActionWidget</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>EVINCE Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>EvPageActionWidget</refname>
 
10
<refpurpose></refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv id="EvPageActionWidget.synopsis" role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
#define             <link linkend="EV-TYPE-PAGE-ACTION-WIDGET:CAPS">EV_TYPE_PAGE_ACTION_WIDGET</link>
 
19
#define             <link linkend="EV-PAGE-ACTION-WIDGET:CAPS">EV_PAGE_ACTION_WIDGET</link>               (obj)
 
20
                    <link linkend="EvPageActionWidget-struct">EvPageActionWidget</link>;
 
21
<link linkend="GType">GType</link>               <link linkend="ev-page-action-widget-get-type">ev_page_action_widget_get_type</link>      (void);
 
22
<link linkend="void">void</link>                <link linkend="ev-page-action-widget-update-model">ev_page_action_widget_update_model</link>  (<link linkend="EvPageActionWidget">EvPageActionWidget</link> *proxy,
 
23
                                                         <link linkend="GtkTreeModel">GtkTreeModel</link> *model);
 
24
<link linkend="void">void</link>                <link linkend="ev-page-action-widget-set-page-cache">ev_page_action_widget_set_page_cache</link>
 
25
                                                        (<link linkend="EvPageActionWidget">EvPageActionWidget</link> *action_widget,
 
26
                                                         <link linkend="EvPageCache">EvPageCache</link> *page_cache);
 
27
</synopsis>
 
28
</refsynopsisdiv>
 
29
 
 
30
<refsect1 id="EvPageActionWidget.object-hierarchy" role="object_hierarchy">
 
31
<title role="object_hierarchy.title">Object Hierarchy</title>
 
32
<synopsis>
 
33
  <link linkend="GObject">GObject</link>
 
34
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
35
         +----<link linkend="GtkObject">GtkObject</link>
 
36
               +----<link linkend="GtkWidget">GtkWidget</link>
 
37
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
38
                           +----<link linkend="GtkBin">GtkBin</link>
 
39
                                 +----<link linkend="GtkToolItem">GtkToolItem</link>
 
40
                                       +----EvPageActionWidget
 
41
</synopsis>
 
42
 
 
43
</refsect1>
 
44
 
 
45
 
 
46
 
 
47
<refsect1 id="EvPageActionWidget.implemented-interfaces" role="impl_interfaces">
 
48
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
49
<para>
 
50
EvPageActionWidget implements
 
51
 <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
52
 
 
53
</refsect1>
 
54
 
 
55
 
 
56
 
 
57
<refsect1 id="EvPageActionWidget.signals" role="signal_proto">
 
58
<title role="signal_proto.title">Signals</title>
 
59
<synopsis>
 
60
  &quot;<link linkend="EvPageActionWidget-activate-link">activate-link</link>&quot;                                  : Run Last / Action
 
61
  &quot;<link linkend="EvPageActionWidget-activate-link">activate-link</link>&quot;                                  : Run Last / Action
 
62
</synopsis>
 
63
</refsect1>
 
64
 
 
65
 
 
66
<refsect1 id="EvPageActionWidget.description" role="desc">
 
67
<title role="desc.title">Description</title>
 
68
<para>
 
69
 
 
70
</para>
 
71
</refsect1>
 
72
 
 
73
<refsect1 id="EvPageActionWidget.details" role="details">
 
74
<title role="details.title">Details</title>
 
75
<refsect2 id="EV-TYPE-PAGE-ACTION-WIDGET:CAPS" role="macro">
 
76
<title>EV_TYPE_PAGE_ACTION_WIDGET</title>
 
77
<indexterm zone="EV-TYPE-PAGE-ACTION-WIDGET:CAPS"><primary>EV_TYPE_PAGE_ACTION_WIDGET</primary></indexterm><programlisting>#define EV_TYPE_PAGE_ACTION_WIDGET (ev_page_action_widget_get_type ())
 
78
</programlisting>
 
79
<para>
 
80
 
 
81
</para></refsect2>
 
82
<refsect2 id="EV-PAGE-ACTION-WIDGET:CAPS" role="macro">
 
83
<title>EV_PAGE_ACTION_WIDGET()</title>
 
84
<indexterm zone="EV-PAGE-ACTION-WIDGET:CAPS"><primary>EV_PAGE_ACTION_WIDGET</primary></indexterm><programlisting>#define EV_PAGE_ACTION_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EV_TYPE_PAGE_ACTION_WIDGET, EvPageActionWidget))
 
85
</programlisting>
 
86
<para>
 
87
 
 
88
</para><variablelist role="params">
 
89
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
90
<listitem><simpara>
 
91
 
 
92
 
 
93
</simpara></listitem></varlistentry>
 
94
</variablelist></refsect2>
 
95
<refsect2 id="EvPageActionWidget-struct" role="struct">
 
96
<title>EvPageActionWidget</title>
 
97
<indexterm zone="EvPageActionWidget-struct"><primary>EvPageActionWidget</primary></indexterm><programlisting>typedef struct _EvPageActionWidget EvPageActionWidget;</programlisting>
 
98
<para>
 
99
 
 
100
</para></refsect2>
 
101
<refsect2 id="ev-page-action-widget-get-type" role="function">
 
102
<title>ev_page_action_widget_get_type ()</title>
 
103
<indexterm zone="ev-page-action-widget-get-type"><primary>ev_page_action_widget_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               ev_page_action_widget_get_type      (void);</programlisting>
 
104
<para>
 
105
 
 
106
</para><variablelist role="params">
 
107
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
108
 
 
109
 
 
110
</simpara></listitem></varlistentry>
 
111
</variablelist></refsect2>
 
112
<refsect2 id="ev-page-action-widget-update-model" role="function">
 
113
<title>ev_page_action_widget_update_model ()</title>
 
114
<indexterm zone="ev-page-action-widget-update-model"><primary>ev_page_action_widget_update_model</primary></indexterm><programlisting><link linkend="void">void</link>                ev_page_action_widget_update_model  (<link linkend="EvPageActionWidget">EvPageActionWidget</link> *proxy,
 
115
                                                         <link linkend="GtkTreeModel">GtkTreeModel</link> *model);</programlisting>
 
116
<para>
 
117
 
 
118
</para><variablelist role="params">
 
119
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
120
<listitem><simpara>
 
121
</simpara></listitem></varlistentry>
 
122
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
123
<listitem><simpara>
 
124
 
 
125
 
 
126
</simpara></listitem></varlistentry>
 
127
</variablelist></refsect2>
 
128
<refsect2 id="ev-page-action-widget-set-page-cache" role="function">
 
129
<title>ev_page_action_widget_set_page_cache ()</title>
 
130
<indexterm zone="ev-page-action-widget-set-page-cache"><primary>ev_page_action_widget_set_page_cache</primary></indexterm><programlisting><link linkend="void">void</link>                ev_page_action_widget_set_page_cache
 
131
                                                        (<link linkend="EvPageActionWidget">EvPageActionWidget</link> *action_widget,
 
132
                                                         <link linkend="EvPageCache">EvPageCache</link> *page_cache);</programlisting>
 
133
<para>
 
134
 
 
135
</para><variablelist role="params">
 
136
<varlistentry><term><parameter>action_widget</parameter>&nbsp;:</term>
 
137
<listitem><simpara>
 
138
</simpara></listitem></varlistentry>
 
139
<varlistentry><term><parameter>page_cache</parameter>&nbsp;:</term>
 
140
<listitem><simpara>
 
141
 
 
142
 
 
143
</simpara></listitem></varlistentry>
 
144
</variablelist></refsect2>
 
145
 
 
146
</refsect1>
 
147
 
 
148
<refsect1 id="EvPageActionWidget.signal-details" role="signals">
 
149
<title role="signals.title">Signal Details</title>
 
150
<refsect2 id="EvPageActionWidget-activate-link"><title>The <literal>&quot;activate-link&quot;</literal> signal</title>
 
151
<indexterm zone="EvPageActionWidget-activate-link"><primary>EvPageActionWidget::activate-link</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EvPageActionWidget">EvPageActionWidget</link> *evpageactionwidget,
 
152
                                                        <link linkend="GObject">GObject</link>            *arg1,
 
153
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last / Action</programlisting>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>evpageactionwidget</parameter>&nbsp;:</term>
 
158
<listitem><simpara>the object which received the signal.
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
161
<listitem><simpara>
 
162
 
 
163
</simpara></listitem></varlistentry>
 
164
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
165
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
166
</variablelist></refsect2><refsect2 id="EvPageActionWidget-activate-link"><title>The <literal>&quot;activate-link&quot;</literal> signal</title>
 
167
<indexterm zone="EvPageActionWidget-activate-link"><primary>EvPageActionWidget::activate-link</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EvPageActionWidget">EvPageActionWidget</link> *evpageactionwidget,
 
168
                                                        <link linkend="GObject">GObject</link>            *arg1,
 
169
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last / Action</programlisting>
 
170
<para>
 
171
 
 
172
</para><variablelist role="params">
 
173
<varlistentry><term><parameter>evpageactionwidget</parameter>&nbsp;:</term>
 
174
<listitem><simpara>the object which received the signal.
 
175
</simpara></listitem></varlistentry>
 
176
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
177
<listitem><simpara>
 
178
 
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
181
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
182
</variablelist></refsect2>
 
183
</refsect1>
 
184
 
 
185
 
 
186
 
 
187
</refentry>