cvs: php-gtk-doc /manual/en/reference/gtk gtktexttag.xml

scottmattocks		Wed Oct  4 14:56:49 2006 UTC

  Modified files:              
    /php-gtk-doc/manual/en/reference/gtk	gtktexttag.xml 
  Log:
  GtkTextTag. Still needs a full description for the event method and a long list of properties.
  
http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/reference/gtk/gtktexttag.xml?r1=1.8&r2=1.9&diff_format=u
Index: php-gtk-doc/manual/en/reference/gtk/gtktexttag.xml
diff -u php-gtk-doc/manual/en/reference/gtk/gtktexttag.xml:1.8 php-gtk-doc/manual/en/reference/gtk/gtktexttag.xml:1.9
--- php-gtk-doc/manual/en/reference/gtk/gtktexttag.xml:1.8	Fri Aug 11 07:31:16 2006
+++ php-gtk-doc/manual/en/reference/gtk/gtktexttag.xml	Wed Oct  4 14:56:49 2006
@@ -1,15 +1,31 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <classentry id="gtk.gtktexttag">
  <classmeta>
   <classtitle>GtkTextTag</classtitle>
   <classparent>GObject</classparent>
   <shortdesc>
    An object used to change the display properties of a block of text in a 
-   GtkTextBuffer.
+   <classname>GtkTextBuffer</classname>.
   </shortdesc>
   <desc>
-
+   <para>
+    <classname>GtkTextTag</classname>s are used to change the display
+    properties of a block of text in a <classname>GtkTextBuffer</classname>.
+   </para>
+   <para>
+    A tag is applied across a range of text identified by two
+    <classname>GtkTextIter</classname>s and affects the way that range of text
+    is displayed. For example, a tag may define the font-weight, color, text
+    size or any combination of many different properties for the range of
+    text.
+   </para>
+   <para>
+    Before a tag can be used with a <classname>GtkTextBuffer</classname>, it
+    must be added to the buffer's <classname>GtkTextTagTable</classname> with
+    <function class="GtkTextTagTable">add</function> (or by creating the tag
+    with <function class="GtkTextBuffer">create_tag</function>).
+   </para>
   </desc>
  </classmeta>
 
@@ -19,14 +35,29 @@
    <funcsynopsis>
     <funcprototype>
     <funcdef> <function>GtkTextTag</function></funcdef>
-    <paramdef>string <parameter><optional>name = null</optional></parameter></paramdef>
+    <paramdef>string 
+     <parameter><optional>name = null</optional></parameter>
+    </paramdef>
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Creates a <classname>GtkTextTag</classname> instance.
    </shortdesc>
    <desc>
-
+    <para>
+     Creates a <classname>GtkTextTag</classname> instance with the name
+     <parameter>name</parameter>. If <parameter>name</parameter> is not given,
+     the tag will be anonymous. This is useful for creating tags on the fly.
+    </para>
+    <para>
+     Named tags can be retrieved from a <classname>GtkTextTagTable</classname>
+     by passing <parameter>name</parameter> to <function
+     class="GtkTextTagTable">lookup</function>.
+    </para>
+    <para>
+     After the tag is created, it cannot be applied to a buffer until it has
+     been added to the buffer's <classname>GtkTextTagTable</classname>.
+    </para>
    </desc>
   </constructor>
 
@@ -38,11 +69,19 @@
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>event</function></funcdef>
-     <paramdef>void</paramdef>
+     <paramdef>
+      GObject <parameter>object</parameter>
+     </paramdef>
+     <paramdef>
+      <classname>GdkEvent</classname> <parameter>event</parameter>
+     </paramdef>
+     <paramdef>
+      <classname>GtkTextIter</classname> <parameter>iter</parameter>
+     </paramdef>
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Emits the event signal on the tag.
    </shortdesc>
    <desc>
 
@@ -57,10 +96,16 @@
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Returns the tag's priority in relation to other tags in its
+    <classname>GtkTextTagTable</classname>.
    </shortdesc>
    <desc>
     <para>
+     Returns the tag's priority. Tags with higher priority will be applied
+     across a range of text over tags with lower priority when there are
+     conflicting attribute values for that range of text.
+    </para>
+    <para>
      &seealso;
      <function class="GtkTextTag">set_priority</function>
     </para>
@@ -76,10 +121,29 @@
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
-
+    Sets the priority of the tag in relation to the other tags in its
+    <classname>GtkTextTagTable</classname>.
    </shortdesc>
    <desc>
     <para>
+     Sets the priority of the tag to <parameter>priority</parameter>. Valid
+     <parameter>priority</parameter> values are <literal>0</literal> through
+     one less than the number of tags in the 
+     <classname>GtkTextTagTable</classname>.
+    </para>
+    <para>
+     Priorities are used to resolve conflicts when two tags attempt to set the
+     same attribute across the same range of text. The values of the tag with
+     the higher priority will take precedence over the values of the tag with
+     the lower priority.
+    </para>
+    <para>
+     Priorities are unique for all tags in a given
+     <classname>GtkTextTagTable</classname>. By default, priorties are
+     assigned in the order the tags are added to the table. If the priority of
+     a tag is changed, all other tags' priorities are adjusted.
+    </para>
+    <para>
      &seealso;
      <function class="GtkTextTag">get_priority</function>
     </para>
@@ -97,9 +161,9 @@
     <funcprototype>
      <funcdef>bool <cbfunction>callback</cbfunction></funcdef>
      <paramdef>GtkTextTag <parameter>texttag</parameter></paramdef>
-     <paramdef>GObject <parameter>UNKNOWN</parameter></paramdef>
-     <paramdef><!-- was: GdkEvent -->XXX <parameter>UNKNOWN</parameter></paramdef>
-     <paramdef><!-- was: GtkTextIter -->XXX <parameter>UNKNOWN</parameter></paramdef>
+     <paramdef>GObject <parameter>object</parameter></paramdef>
+     <paramdef>GdkEvent <parameter>event</parameter></paramdef>
+     <paramdef>GtkTextIter <parameter>iter</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
@@ -112,3 +176,22 @@
  </signals>
 
 </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
+-->