cvs: php-gtk-doc /manual/en/appendix glossary.xml /manual/en/reference/gtk gtktextmark.xml
[email protected] ("Scott Mattocks")
| Newsgroups | php.gtk.doc |
|---|---|
| Message-ID | <cvsscottmattocks1159986564@cvsserver> |
scottmattocks Wed Oct 4 18:29:24 2006 UTC
Modified files:
/php-gtk-doc/manual/en/appendix glossary.xml
/php-gtk-doc/manual/en/reference/gtk gtktextmark.xml
Log:
GtkTextMark docs. Committing what I have before I start messing with updater stuff.
http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/appendix/glossary.xml?r1=1.9&r2=1.10&diff_format=u
Index: php-gtk-doc/manual/en/appendix/glossary.xml
diff -u php-gtk-doc/manual/en/appendix/glossary.xml:1.9 php-gtk-doc/manual/en/appendix/glossary.xml:1.10
--- php-gtk-doc/manual/en/appendix/glossary.xml:1.9 Fri Aug 11 05:15:33 2006
+++ php-gtk-doc/manual/en/appendix/glossary.xml Wed Oct 4 18:29:23 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8" ?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<glossary id="appendix.glossary">
<title>Glossary</title>
<simpara>
@@ -189,6 +189,26 @@
<glossseealso otherterm="appendix.glossary.c.clipmask" />
</glossdef>
</glossentry>
+ <glossentry id="appendix.glossary.g.gravity">
+ <glossterm>Gravity</glossterm>
+ <glossdef>
+ <para>
+ Gravity referes to how an object is relatively positioned when objects
+ surrounding it are added and removed. An object with left gravity will
+ stay to the left of objects added in the same location. An object with
+ right gravity will stay to the right of objects added in the same
+ location. Gravity is normally associated with
+ <classname>GtkTextMark</classname> objects.
+ </para>
+ <para>
+ When used in relation to text, gravity direction is logical direction.
+ Left gravity is toward the beginning of the buffer and right gravity is
+ toward the end of the buffer. When a language like Hebrew is used, left
+ gravity is actually gravity which keeps the object on the right of newly
+ added objects.
+ </para>
+ </glossdef>
+ </glossentry>
</glossdiv>
<glossdiv id="appendix.glossary.h">
http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/reference/gtk/gtktextmark.xml?r1=1.5&r2=1.6&diff_format=u
Index: php-gtk-doc/manual/en/reference/gtk/gtktextmark.xml
diff -u php-gtk-doc/manual/en/reference/gtk/gtktextmark.xml:1.5 php-gtk-doc/manual/en/reference/gtk/gtktextmark.xml:1.6
--- php-gtk-doc/manual/en/reference/gtk/gtktextmark.xml:1.5 Fri Aug 11 07:31:16 2006
+++ php-gtk-doc/manual/en/reference/gtk/gtktextmark.xml Wed Oct 4 18:29:24 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8" ?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<classentry id="gtk.gtktextmark">
<classmeta>
<classtitle>GtkTextMark</classtitle>
@@ -8,7 +8,26 @@
A position in a GtkTextBuffer which persists across buffer modifications.
</shortdesc>
<desc>
-
+ <para>
+ A <classname>GtkTextMark</classname> is used to identify a location within
+ a <classname>GtkTextBuffer</classname>. Unlike a
+ <classname>GtkTextIter</classname>, a <classname>GtkTextMark</classname>
+ will persist across buffer modifications.
+ </para>
+ <para>
+ A <classname>GtkTextMark</classname> cannot be instantiated directly with
+ the <literal>new</literal> operator. Instead it must be created using
+ <function class="GtkTextBuffer">create_mark</function>.
+ </para>
+ <para>
+ By default, every buffer automatically creates two
+ <classname>GtkTextMark</classname>s named <literal>insert</literal> and
+ <literal>selection_boud</literal>. They point to the insertion point
+ (cursor) and the selection boundry which is not the insertion point,
+ respectively. Moving these two marks to two different places in the buffer
+ will select the range of text between them. Both marks have right <link
+ linkend="appendix.glossary.g.gravity">gravity</link>.
+ </para>
</desc>
</classmeta>
@@ -22,10 +41,18 @@
</funcprototype>
</funcsynopsis>
<shortdesc>
-
+ Returns the <classname>GtkTextBuffer</classname> that the mark belongs to.
</shortdesc>
<desc>
-
+ <para>
+ Returns the <classname>GtkTextBuffer</classname> that the mark belongs
+ to. The buffer returned will be the buffer that was used to call
+ <function class="GtkTextBuffer">create_mark</function>.
+ </para>
+ <para>
+ &seealso;
+ <function class="GtkTextBuffer">create_mark</function>
+ </para>
</desc>
</method>
@@ -37,10 +64,19 @@
</funcprototype>
</funcsynopsis>
<shortdesc>
-
+ Returns whether or not the mark has been deleted from its
+ <classname>GtkTextBuffer</classname>.
</shortdesc>
<desc>
-
+ <para>
+ Returns whether or not the mark has been deleted from its
+ <classname>GtkTextBuffer</classname>. A mark which has been deleted may
+ not be used.
+ </para>
+ <para>
+ &seealso;
+ <function class="GtkTextBuffer">delete_mark</function>
+ </para>
</desc>
</method>
@@ -52,10 +88,16 @@
</funcprototype>
</funcsynopsis>
<shortdesc>
-
+ Returns whether or not the mark has left <link
+ linkend="appendix.glossary.g.gravity">gravity</link>.
</shortdesc>
<desc>
-
+ <para>
+ Returns <literal>true</literal> if the mark has left <link
+ linkend="appendix.glossary.g.gravity">gravity</link> and
+ <literal>false</literal> if it has right <link
+ linkend="appendix.glossary.g.gravity">gravity</link>.
+ </para>
</desc>
</method>
@@ -67,10 +109,18 @@
</funcprototype>
</funcsynopsis>
<shortdesc>
-
+ Returns the name of the mark, or <literal>null</literal> if the mark is
+ anonymous.
</shortdesc>
<desc>
-
+ <para>
+ Returns the name of the mark, or <literal>null</literal> if the mark is
+ anonymous. Marks are given a name when they are created.
+ </para>
+ <para>
+ &seealso;
+ <function class="GtkTextBuffer">create_mark</function>
+ </para>
</desc>
</method>
@@ -82,14 +132,17 @@
</funcprototype>
</funcsynopsis>
<shortdesc>
-
+ Returns whether or not a cursor is shown for the mark.
</shortdesc>
<desc>
<para>
+ Returns <literal>true</literal> if a cursor is shown for the mark and
+ <literal>false</literal> if a cursor is not shown.
+ </para>
+ <para>
&seealso;
<function class="GtkTextMark">set_visible</function>
</para>
-
</desc>
</method>
@@ -97,21 +150,45 @@
<funcsynopsis>
<funcprototype>
<funcdef>void <function>set_visible</function></funcdef>
- <paramdef>bool <parameter>setting</parameter></paramdef>
+ <paramdef>bool <parameter>visible</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<shortdesc>
-
+ Sets whether or not a cursor should be shown for the mark.
</shortdesc>
<desc>
<para>
+ If <parameter>visible</parameter> is <literal>true</literal> a cursor
+ will be shown where the mark is located in the buffer. If
+ <parameter>visible</parameter> is <literal>false</literal> nothing will
+ be shown at the position of the mark.
+ </para>
+ <para>
&seealso;
<function class="GtkTextMark">get_visible</function>
</para>
-
</desc>
</method>
</methods>
</classentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->