← Back to branch summary

~bratsche/ubuntu/maverick/gtk+2.0/menu-activation-fix

« back to all changes in this revision

Viewing changes to docs/reference/gtk/xml/gtktextmark.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-06-13 10:00:13 UTC
  • mto: (72.2.1 lenny) (1.5.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 44.
  • Revision ID: james.westby@ubuntu.com-20070613100013-qstao3cwpm6xdlxc
Tags: upstream-2.11.2
Import upstream version 2.11.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/xml/gtktextmark.xml
21
21
 
22
22
 
23
23
                    <link linkend="GtkTextMark-struct">GtkTextMark</link>;
 
24
<link linkend="GtkTextMark">GtkTextMark</link>*        <link linkend="gtk-text-mark-new">gtk_text_mark_new</link>                   (const <link linkend="gchar">gchar</link> *name,
 
25
                                                         <link linkend="gboolean">gboolean</link> left_gravity);
24
26
<link linkend="void">void</link>                <link linkend="gtk-text-mark-set-visible">gtk_text_mark_set_visible</link>           (<link linkend="GtkTextMark">GtkTextMark</link> *mark,
25
27
                                                         <link linkend="gboolean">gboolean</link> setting);
26
28
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-text-mark-get-visible">gtk_text_mark_get_visible</link>           (<link linkend="GtkTextMark">GtkTextMark</link> *mark);
47
49
 
48
50
 
49
51
 
 
52
<refsect1 role="properties">
 
53
<title role="properties.title">Properties</title>
 
54
<synopsis>
 
55
 
 
56
  <link linkend="GtkTextMark--left-gravity">left-gravity</link>             <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only
 
57
  <link linkend="GtkTextMark--name">name</link>                     <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
 
58
</synopsis>
 
59
</refsect1>
50
60
 
51
61
 
52
62
 
104
114
 
105
115
</para></refsect2>
106
116
<refsect2>
 
117
<title><anchor id="gtk-text-mark-new" role="function" condition="since:2.12"/>gtk_text_mark_new ()</title>
 
118
<indexterm role="2.12"><primary>gtk_text_mark_new</primary></indexterm><programlisting><link linkend="GtkTextMark">GtkTextMark</link>*        gtk_text_mark_new                   (const <link linkend="gchar">gchar</link> *name,
 
119
                                                         <link linkend="gboolean">gboolean</link> left_gravity);</programlisting>
 
120
<para>
 
121
Creates a text mark. Add it to a buffer using <link linkend="gtk-text-buffer-add-mark"><function>gtk_text_buffer_add_mark()</function></link>.
 
122
If <parameter>name</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the mark is anonymous; otherwise, the mark can be 
 
123
retrieved by name using <link linkend="gtk-text-buffer-get-mark"><function>gtk_text_buffer_get_mark()</function></link>. If a mark has left 
 
124
gravity, and text is inserted at the mark's current location, the mark 
 
125
will be moved to the left of the newly-inserted text. If the mark has 
 
126
right gravity (<parameter>left_gravity</parameter> = <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>), the mark will end up on the 
 
127
right of newly-inserted text. The standard left-to-right cursor is a 
 
128
mark with right gravity (when you type, the cursor stays on the right
 
129
side of the text you're typing).</para>
 
130
<para>
 
131
 
 
132
</para><variablelist role="params">
 
133
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
134
<listitem><simpara> mark name or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
135
</simpara></listitem></varlistentry>
 
136
<varlistentry><term><parameter>left_gravity</parameter>&nbsp;:</term>
 
137
<listitem><simpara> whether the mark should have left gravity
 
138
</simpara></listitem></varlistentry>
 
139
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> new <link linkend="GtkTextMark"><type>GtkTextMark</type></link>
 
140
 
 
141
</simpara></listitem></varlistentry>
 
142
</variablelist><para role="since">Since  2.12
 
143
</para></refsect2>
 
144
<refsect2>
107
145
<title><anchor id="gtk-text-mark-set-visible" role="function"/>gtk_text_mark_set_visible ()</title>
108
146
<indexterm><primary>gtk_text_mark_set_visible</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_text_mark_set_visible           (<link linkend="GtkTextMark">GtkTextMark</link> *mark,
109
147
                                                         <link linkend="gboolean">gboolean</link> setting);</programlisting>
128
166
<indexterm><primary>gtk_text_mark_get_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_text_mark_get_visible           (<link linkend="GtkTextMark">GtkTextMark</link> *mark);</programlisting>
129
167
<para>
130
168
Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the mark is visible (i.e. a cursor is displayed
131
 
for it)</para>
 
169
for it).</para>
132
170
<para>
133
171
 
134
172
</para><variablelist role="params">
143
181
<indexterm><primary>gtk_text_mark_get_deleted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_text_mark_get_deleted           (<link linkend="GtkTextMark">GtkTextMark</link> *mark);</programlisting>
144
182
<para>
145
183
Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the mark has been removed from its buffer
146
 
with <link linkend="gtk-text-buffer-delete-mark"><function>gtk_text_buffer_delete_mark()</function></link>. Marks can't be used
147
 
once deleted.</para>
 
184
with <link linkend="gtk-text-buffer-delete-mark"><function>gtk_text_buffer_delete_mark()</function></link>. See <link linkend="gtk-text-buffer-add-mark"><function>gtk_text_buffer_add_mark()</function></link>
 
185
for a way to add it to a buffer again.</para>
148
186
<para>
149
187
 
150
188
</para><variablelist role="params">
173
211
<indexterm><primary>gtk_text_mark_get_buffer</primary></indexterm><programlisting><link linkend="GtkTextBuffer">GtkTextBuffer</link>*      gtk_text_mark_get_buffer            (<link linkend="GtkTextMark">GtkTextMark</link> *mark);</programlisting>
174
212
<para>
175
213
Gets the buffer this mark is located inside,
176
 
or NULL if the mark is deleted.</para>
 
214
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the mark is deleted.</para>
177
215
<para>
178
216
 
179
217
</para><variablelist role="params">
199
237
</variablelist></refsect2>
200
238
 
201
239
</refsect1>
 
240
<refsect1 role="property_details">
 
241
<title role="property_details.title">Property Details</title>
 
242
<refsect2><title><anchor id="GtkTextMark--left-gravity"/>The :<literal>left-gravity</literal> property</title>
 
243
<indexterm><primary>GtkTextMark:left-gravity</primary></indexterm><programlisting>  left-gravity             <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
 
244
<para>Whether the mark has left gravity.</para><para>Default value: FALSE</para>
 
245
</refsect2>
 
246
<refsect2><title><anchor id="GtkTextMark--name"/>The :<literal>name</literal> property</title>
 
247
<indexterm><primary>GtkTextMark:name</primary></indexterm><programlisting>  name                     <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
 
248
<para>Mark name.</para><para>Default value: NULL</para>
 
249
</refsect2>
 
250
 
 
251
</refsect1>
202
252
 
203
253
 
204
254