cvs: php-gtk-doc /examples/reference/gtk/gtkentry constructor.phpw /manual/en/reference/gtk gtkarrow.xml gtkbin.xml gtkcalendar.xml gtkentry.xml
gtkenum.xml

From: Date: Sat, 19 Nov 2005 10:06:49 +0000
Subject: cvs: php-gtk-doc /examples/reference/gtk/gtkentry constructor.phpw /manual/en/reference/gtk gtkarrow.xml gtkbin.xml gtkcalendar.xml gtkentry.xml
gtkenum.xml
Groups: php.gtk.doc 
Request: Send a blank email to php-gtk-doc+get-1653@lists.php.net to get a copy of this message
cweiske Sat Nov 19 05:06:49 2005 EDT Added files: /php-gtk-doc/examples/reference/gtk/gtkentry constructor.phpw Modified files: /php-gtk-doc/manual/en/reference/gtk gtkcalendar.xml gtkentry.xml gtkbin.xml gtkarrow.xml gtkenum.xml Log: Added changes by Anant Narayana for gtkarrow, bin, calendar and entry Changed some gtkenum names to match the official gtk ones

http://cvs.php.net/diff.php/php-gtk-doc/manual/en/reference/gtk/gtkcalendar.xml?r1=1.5&r2=1.6&ty=u Index: php-gtk-doc/manual/en/reference/gtk/gtkcalendar.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkcalendar.xml:1.5 php-gtk-doc/manual/en/reference/gtk/gtkcalendar.xml:1.6 --- php-gtk-doc/manual/en/reference/gtk/gtkcalendar.xml:1.5 Tue Aug 2 07:01:44 2005 +++ php-gtk-doc/manual/en/reference/gtk/gtkcalendar.xml Sat Nov 19 05:06:48 2005 @@ -1,335 +1,366 @@ -<?xml version="1.0" encoding="utf-8" ?> -<classentry id="gtk.gtkcalendar"> - <classmeta> - <classtitle>GtkCalendar</classtitle> - <classparent>GtkWidget</classparent> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </classmeta> - - <constructors> - - <constructor id="gtk.gtkcalendar.constructor"> - <funcsynopsis> - <funcprototype> - <funcdef> <function>GtkCalendar</function></funcdef> - <paramdef>void</paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </constructor> - - </constructors> - - <methods> - - <method id="gtk.gtkcalendar.method.clear_marks"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>clear_marks</function></funcdef> - <paramdef>void</paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.display_options"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>display_options</function></funcdef> - <paramdef>GtkCalendarDisplayOptions <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.freeze"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>freeze</function></funcdef> - <paramdef>void</paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.get_date"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>get_date</function></funcdef> - <paramdef>void</paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.get_display_options"> - <funcsynopsis> - <funcprototype> - <funcdef>GtkCalendarDisplayOptions <function>get_display_options</function></funcdef> - <paramdef>void</paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - <para> - See also: - <function class="GtkCalendar">set_display_options</function> - </para> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.mark_day"> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>mark_day</function></funcdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - <para> - See also: - <function class="GtkCalendar">select_day</function>, - <function class="GtkCalendar">unmark_day</function> - </para> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.select_day"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>select_day</function></funcdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - <para> - See also: - <function class="GtkCalendar">mark_day</function>, - <function class="GtkCalendar">unmark_day</function> - </para> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.select_month"> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>select_month</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.set_display_options"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>set_display_options</function></funcdef> - <paramdef>GtkCalendarDisplayOptions <parameter>flags</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - <para> - See also: - <function class="GtkCalendar">get_display_options</function> - </para> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.thaw"> - <funcsynopsis> - <funcprototype> - <funcdef>void <function>thaw</function></funcdef> - <paramdef>void</paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - - </desc> - </method> - - <method id="gtk.gtkcalendar.method.unmark_day"> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>unmark_day</function></funcdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - - </shortdesc> - <desc> - <para> - See also: - <function class="GtkCalendar">mark_day</function>, - <function class="GtkCalendar">select_day</function> - </para> - - </desc> - </method> - - </methods> - - <signals> - - <signal id="gtk.gtkcalendar.signal.day-selected"> - <signalname>day-selected</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - <signal id="gtk.gtkcalendar.signal.day-selected-double-click"> - <signalname>day-selected-double-click</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - <signal id="gtk.gtkcalendar.signal.month-changed"> - <signalname>month-changed</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - <signal id="gtk.gtkcalendar.signal.next-month"> - <signalname>next-month</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - <signal id="gtk.gtkcalendar.signal.next-year"> - <signalname>next-year</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - <signal id="gtk.gtkcalendar.signal.prev-month"> - <signalname>prev-month</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - <signal id="gtk.gtkcalendar.signal.prev-year"> - <signalname>prev-year</signalname> - <funcsynopsis> - <funcprototype> - <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkCalendar <parameter>calendar</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <shortdesc> - </shortdesc> - <desc> - - </desc> - </signal> - - </signals> - -</classentry> +<?xml version="1.0" encoding="utf-8" ?> +<classentry id="gtk.gtkcalendar"> + <classmeta> + <classtitle>GtkCalendar</classtitle> + <classparent>GtkWidget</classparent> + <shortdesc> + Displays a calendar and allows the user to select a date. + </shortdesc> + <desc> + <para> + A <classname>GtkCalendar</classname> is a widget that displays a + calendar as a grid, one month at a time, allowing the user to select a + particular date. + </para> + <para> + The month and year currently displayed can be modified using + <function class="GtkCalendar">select_month</function>. The exact + day to be selected may be modified using + <function class="GtkCalendar">select_day</function>. + </para> + <para> + You may place a visual mark on a particular day by using + <function class="GtkCalendar">mark_day</function>. The marker + may be removed using + <function class="GtkCalendar">unmark_day</function>. + </para> + <para> + The visual style of the calendar may be modified comprehensively using + <function class="GtkCalendar">set_display_options</function>. Of course, + the whole purpose of creating the calendar itself is to retrive the + input from the user! You may use + <function class="GtkCalendar">get_month</function>to retrieve the date + selected by the user. + </para> + </desc> + </classmeta> + + <constructors> + + <constructor id="gtk.gtkcalendar.constructor"> + <funcsynopsis> + <funcprototype> + <funcdef> <function>GtkCalendar</function></funcdef> + <paramdef>void</paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Creates a calender widget. + </shortdesc> + <desc> + Creates a calender widget that is set to display the current month + and year. + </desc> + </constructor> + + </constructors> + + <methods> + + <method id="gtk.gtkcalendar.method.clear_marks"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>clear_marks</function></funcdef> + <paramdef>void</paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + + </shortdesc> + <desc> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.display_options"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>display_options</function></funcdef> + <paramdef><enumname>GtkCalendarDisplayOptions</enumname> <parameter>flags</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + + </shortdesc> + <desc> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.freeze"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>freeze</function></funcdef> + <paramdef>void</paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Freezes the display prior to allow updates. + </shortdesc> + <desc> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.get_date"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>get_date</function></funcdef> + <paramdef>void</paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Returns the currently selected date. + </shortdesc> + <desc> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.get_display_options"> + <funcsynopsis> + <funcprototype> + <funcdef><enumname>GtkCalendarDisplayOptions</enumname> <function>get_display_options</function></funcdef> + <paramdef>void</paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + + </shortdesc> + <desc> + <para> + See also: + <function class="GtkCalendar">set_display_options</function> + </para> + </desc> + </method> + + <method id="gtk.gtkcalendar.method.mark_day"> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>mark_day</function></funcdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Places a visual marker on the given day. + </shortdesc> + <desc> + <para> + See also: + <function class="GtkCalendar">select_day</function>, + <function class="GtkCalendar">unmark_day</function> + </para> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.select_day"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>select_day</function></funcdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Determines the day to be selected. + </shortdesc> + <desc> + <para> + See also: + <function class="GtkCalendar">mark_day</function>, + <function class="GtkCalendar">unmark_day</function> + </para> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.select_month"> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>select_month</function></funcdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Determines the month and year to be selected. + </shortdesc> + <desc> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.set_display_options"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>set_display_options</function></funcdef> + <paramdef><enumname>GtkCalendarDisplayOptions</enumname> <parameter>flags</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + + </shortdesc> + <desc> + <para> + See also: + <function class="GtkCalendar">get_display_options</function> + </para> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.thaw"> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>thaw</function></funcdef> + <paramdef>void</paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Thaws the display following freeze. + </shortdesc> + <desc> + + </desc> + </method> + + <method id="gtk.gtkcalendar.method.unmark_day"> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>unmark_day</function></funcdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Removes the visual marker set on a given day. + </shortdesc> + <desc> + <para> + See also: + <function class="GtkCalendar">mark_day</function>, + <function class="GtkCalendar">select_day</function> + </para> + + </desc> + </method> + + </methods> + + <signals> + + <signal id="gtk.gtkcalendar.signal.day-selected"> + <signalname>day-selected</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the given day is selected. + </shortdesc> + <desc> + + </desc> + </signal> + + <signal id="gtk.gtkcalendar.signal.day-selected-double-click"> + <signalname>day-selected-double-click</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the given day is clicked on twice. + </shortdesc> + <desc> + + </desc> + </signal> + + <signal id="gtk.gtkcalendar.signal.month-changed"> + <signalname>month-changed</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the user attempts to change the current month. + </shortdesc> + <desc> + + </desc> + </signal> + + <signal id="gtk.gtkcalendar.signal.next-month"> + <signalname>next-month</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the user chooses to go forward by one month. + </shortdesc> + <desc> + + </desc> + </signal> + + <signal id="gtk.gtkcalendar.signal.next-year"> + <signalname>next-year</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the user chooses to go forward by one year. + </shortdesc> + <desc> + + </desc> + </signal> + + <signal id="gtk.gtkcalendar.signal.prev-month"> + <signalname>prev-month</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the user chooses to go backward by one month. + </shortdesc> + <desc> + + </desc> + </signal> + + <signal id="gtk.gtkcalendar.signal.prev-year"> + <signalname>prev-year</signalname> + <funcsynopsis> + <funcprototype> + <funcdef>void <cbfunction>callback</cbfunction></funcdef> + <paramdef><classname>GtkCalendar</classname> <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <shortdesc> + Emitted when the user chooses to go backward by one year. + </shortdesc> + <desc> + + </desc> + </signal> + + </signals> + +</classentry> http://cvs.php.net/diff.php/php-gtk-doc/manual/en/reference/gtk/gtkentry.xml?r1=1.5&r2=1.6&ty=u Index: php-gtk-doc/manual/en/reference/gtk/gtkentry.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkentry.xml:1.5 php-gtk-doc/manual/en/reference/gtk/gtkentry.xml:1.6 --- php-gtk-doc/manual/en/reference/gtk/gtkentry.xml:1.5 Tue Aug 2 07:01:44 2005 +++ php-gtk-doc/manual/en/reference/gtk/gtkentry.xml Sat Nov 19 05:06:48 2005 @@ -4,10 +4,17 @@ <classtitle>GtkEntry</classtitle> <classparent>GtkWidget</classparent> <shortdesc> - + A single line text entry field. </shortdesc> <desc> - + <para> + <classname>GtkEntry</classname> is a single line text entry widget. + It is generally used when input is required from the user. A fairly + large set of key bindings are supported by default and have the + potential to be edited by the user. If the entered text is longer + than the allocation of the widget, the widget will scroll so that the + cursor position is visible. + </para> </desc> </classmeta> @@ -21,10 +28,27 @@ </funcprototype> </funcsynopsis> <shortdesc> - + Creates a single line text entry widget. </shortdesc> <desc> - + <para> + Creates a widget that will hold a single line of text. You have the + freedom to either set the widget programatically through + <function class="GtkEntry">set_text</function> or have it entered + by the user. + </para> + <example> + <title> + Retrieving text and echoing it using + <classname>GtkEntry</classname> + </title> + <programlisting role="php"> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="&directory.examples;/reference/gtk/gtkentry/constructor.phpw" parse="text"> + <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback> + </xi:include> + </programlisting> + </example> </desc> </constructor> @@ -59,9 +83,9 @@ </shortdesc> <desc> <para> - See also: - <function class="GtkEntry">get_text</function>, - <function class="GtkEntry">prepend_text</function>, + See also: + <function class="GtkEntry">get_text</function>, + <function class="GtkEntry">prepend_text</function>, <function class="GtkEntry">set_text</function> </para> @@ -80,7 +104,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_activates_default</function> </para> @@ -99,7 +123,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_alignment</function> </para> @@ -109,7 +133,7 @@ <method id="gtk.gtkentry.method.get_completion"> <funcsynopsis> <funcprototype> - <funcdef>GtkEntryCompletion <function>get_completion</function></funcdef> + <funcdef><classname>GtkEntryCompletion</classname> <function>get_completion</function></funcdef> <paramdef>void</paramdef> </funcprototype> </funcsynopsis> @@ -118,7 +142,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_completion</function> </para> @@ -137,7 +161,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_has_frame</function> </para> @@ -156,7 +180,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_invisible_char</function> </para> @@ -205,7 +229,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_max_length</function> </para> @@ -220,13 +244,24 @@ </funcprototype> </funcsynopsis> <shortdesc> - + Retrieves the contents of the <classname>GtkEntry</classname> widget. </shortdesc> <desc> <para> - See also: - <function class="GtkEntry">append_text</function>, - <function class="GtkEntry">prepend_text</function>, + Retrieves the text entered into the <classname>GtkEntry</classname> + widget, and also any appended or prepended text that may have been + set using <function class="GtkEntry">set_text</function> but not + displayed. + </para> + <note> + Contrary to rumours, this function is NOT marked as deprecated, + either in the earlier versions of GTK+ used by PHP-GTK or the current + versions. + </note> + <para> + See also: + <function class="GtkEntry">append_text</function>, + <function class="GtkEntry">prepend_text</function>, <function class="GtkEntry">set_text</function> </para> @@ -245,7 +280,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_visibility</function> </para> @@ -264,7 +299,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">set_width_chars</function> </para> @@ -283,9 +318,9 @@ </shortdesc> <desc> <para> - See also: - <function class="GtkEntry">append_text</function>, - <function class="GtkEntry">get_text</function>, + See also: + <function class="GtkEntry">append_text</function>, + <function class="GtkEntry">get_text</function>, <function class="GtkEntry">set_text</function> </para> @@ -320,7 +355,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_activates_default</function> </para> @@ -339,7 +374,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_alignment</function> </para> @@ -350,7 +385,7 @@ <funcsynopsis> <funcprototype> <funcdef>void <function>set_completion</function></funcdef> - <paramdef>GtkEntryCompletion <parameter>completion</parameter></paramdef> + <paramdef><classname>GtkEntryCompletion</classname> <parameter>completion</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -358,7 +393,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_completion</function> </para> @@ -392,7 +427,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_has_frame</function> </para> @@ -411,7 +446,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_invisible_char</function> </para> @@ -430,7 +465,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_max_length</function> </para> @@ -464,9 +499,9 @@ </shortdesc> <desc> <para> - See also: - <function class="GtkEntry">append_text</function>, - <function class="GtkEntry">get_text</function>, + See also: + <function class="GtkEntry">append_text</function>, + <function class="GtkEntry">get_text</function>, <function class="GtkEntry">prepend_text</function> </para> @@ -485,7 +520,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_visibility</function> </para> @@ -504,7 +539,7 @@ </shortdesc> <desc> <para> - See also: + See also: <function class="GtkEntry">get_width_chars</function> </para> @@ -520,7 +555,7 @@ <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -529,13 +564,13 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.backspace"> <signalname>backspace</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -544,13 +579,13 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.copy-clipboard"> <signalname>copy-clipboard</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -559,13 +594,13 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.cut-clipboard"> <signalname>cut-clipboard</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -574,14 +609,14 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.delete-from-cursor"> <signalname>delete-from-cursor</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> - <paramdef>GtkDeleteType <parameter>UNKNOWN</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> + <paramdef><enumname>GtkDeleteType</enumname> <parameter>UNKNOWN</parameter></paramdef> <paramdef>int <parameter>UNKNOWN</parameter></paramdef> </funcprototype> </funcsynopsis> @@ -591,13 +626,13 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.insert-at-cursor"> <signalname>insert-at-cursor</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> <paramdef><!-- was: gchararray -->XXX <parameter>UNKNOWN</parameter></paramdef> </funcprototype> </funcsynopsis> @@ -607,14 +642,14 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.move-cursor"> <signalname>move-cursor</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> - <paramdef>GtkMovementStep <parameter>UNKNOWN</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> + <paramdef><enumname>GtkMovementStep</enumname> <parameter>UNKNOWN</parameter></paramdef> <paramdef>int <parameter>UNKNOWN</parameter></paramdef> <paramdef>bool <parameter>UNKNOWN</parameter></paramdef> </funcprototype> @@ -625,13 +660,13 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.paste-clipboard"> <signalname>paste-clipboard</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -640,14 +675,14 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.populate-popup"> <signalname>populate-popup</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> - <paramdef>GtkMenu <parameter>UNKNOWN</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkMenu</classname> <parameter>UNKNOWN</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -656,13 +691,13 @@ </desc> </signal> - + <signal id="gtk.gtkentry.signal.toggle-overwrite"> <signalname>toggle-overwrite</signalname> <funcsynopsis> <funcprototype> <funcdef>void <cbfunction>callback</cbfunction></funcdef> - <paramdef>GtkEntry <parameter>entry</parameter></paramdef> + <paramdef><classname>GtkEntry</classname> <parameter>entry</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> @@ -671,7 +706,7 @@ </desc> </signal> - + </signals> </classentry> http://cvs.php.net/diff.php/php-gtk-doc/manual/en/reference/gtk/gtkbin.xml?r1=1.2&r2=1.3&ty=u Index: php-gtk-doc/manual/en/reference/gtk/gtkbin.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkbin.xml:1.2 php-gtk-doc/manual/en/reference/gtk/gtkbin.xml:1.3 --- php-gtk-doc/manual/en/reference/gtk/gtkbin.xml:1.2 Tue Aug 2 07:01:44 2005 +++ php-gtk-doc/manual/en/reference/gtk/gtkbin.xml Sat Nov 19 05:06:48 2005 @@ -4,11 +4,30 @@ <classtitle>GtkBin</classtitle> <classparent>GtkContainer</classparent> <shortdesc> - + A container widget with only one child. </shortdesc> <desc> - + <para> + The <classname>GtkBin</classname> widget is a container that is + capable of holding only one child. It is not very useful on its own, + but is often used for deriving subclasses, since it provides code for + needed for handling a single widget child. All widgets derived from + <classname>GtkBin</classname> therefore can only contain one + immediate child, although this child may itself contain multiple + widgets. + </para> + <para> + Since <classname>GtkBin</classname> is an abstract base class, there + is no constructor for it. However, many useful widgets are subclasses + of <classname>GtkBin</classname>, including + <classname>GtkButton</classname>, <classname>GtkFrame</classname>, + <classname>GtkHandleBox</classname> and + <classname>GtkWindow</classname>. You can use + <function class="GtkBin">get_child</function> to get the child + object. + </para> </desc> + </classmeta> <methods> @@ -16,16 +35,21 @@ <method id="gtk.gtkbin.method.get_child"> <funcsynopsis> <funcprototype> - <funcdef>GtkWidget <function>get_child</function></funcdef> + <funcdef><classname>GtkWidget</classname> <function>get_child</function></funcdef> <paramdef>void</paramdef> </funcprototype> </funcsynopsis> <shortdesc> - + Returns the child of the <classname>GtkBin</classname>. </shortdesc> <desc> <para> - See also: + Returns the child of the <classname>GtkBin</classname>, or + <literal>NULL</literal> if the + bin contains no child widget. + </para> + <para> + See also: <propname class="GtkBin">child</propname> </para> @@ -40,13 +64,19 @@ <propname>child</propname> <proptype>GtkWidget</proptype> <shortdesc> + The child widget </shortdesc> <desc> <para> - See also: + This property allows access to the child widget contained by the + <classname>GtkBin</classname> object. It can be treated like any other + <classname>GtkWidget</classname>. If the value of this property is + <literal>NULL</literal>, then GtkBin object does not contain a child widget. + </para> + <para> + See also: <function class="GtkBin">get_child</function> </para> - </desc> </property> http://cvs.php.net/diff.php/php-gtk-doc/manual/en/reference/gtk/gtkarrow.xml?r1=1.2&r2=1.3&ty=u Index: php-gtk-doc/manual/en/reference/gtk/gtkarrow.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkarrow.xml:1.2 php-gtk-doc/manual/en/reference/gtk/gtkarrow.xml:1.3 --- php-gtk-doc/manual/en/reference/gtk/gtkarrow.xml:1.2 Tue Aug 2 07:01:44 2005 +++ php-gtk-doc/manual/en/reference/gtk/gtkarrow.xml Sat Nov 19 05:06:48 2005 @@ -4,10 +4,26 @@ <classtitle>GtkArrow</classtitle> <classparent>GtkMisc</classparent> <shortdesc> - + Displays an arrow pointing in one of the four cardinal directions. </shortdesc> <desc> - + <para> + The <classname>GtkArrow</classname> widget can be used to draw simple + arrows that need to point in one of the four cardinal directions (up, + down, left and right). The Style of the arrow displayed may be + modified to suit your requirements by modifying the values of the + parameters GtkShadowType and GtkArrowType. + </para> + <para> + <classname>GtkArrow</classname> will fill any space alloted to it, + but since it is inherited from <classname>GtkMisc</classname>, + it can be padded and/or aligned, to fill exactly the space the + programmer desires. + </para> + <para> + The direction or style of an arrow can be changed after creation + by using <function class="GtkArrow">set</function>. + </para> </desc> </classmeta> @@ -17,12 +33,13 @@ <funcsynopsis> <funcprototype> <funcdef> <function>GtkArrow</function></funcdef> - <paramdef>GtkArrowType <parameter>arrow_type</parameter></paramdef> - <paramdef>GtkShadowType <parameter>shadow_type</parameter></paramdef> + <paramdef><enumname>GtkArrowType</enumname> <parameter>arrow_type</parameter></paramdef> + <paramdef><enumname>GtkShadowType</enumname> <parameter>shadow_type</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> - + Creates the arrow widget pointing in one of the four cardinal + directions </shortdesc> <desc> @@ -37,18 +54,23 @@ <funcsynopsis> <funcprototype> <funcdef>void <function>set</function></funcdef> - <paramdef>GtkArrowType <parameter>arrow_type</parameter></paramdef> - <paramdef>GtkShadowType <parameter>shadow_type</parameter></paramdef> + <paramdef><enumname>GtkArrowType</enumname> <parameter>arrow_type</parameter></paramdef> + <paramdef><enumname>GtkShadowType</enumname> <parameter>shadow_type</parameter></paramdef> </funcprototype> </funcsynopsis> <shortdesc> - + Sets new parameters for an existing <classname>GtkArrow</classname> </shortdesc> <desc> - + This method redefines the parameters for an existing + <classname>GtkArrow</classname>. Typically, this method is used within + a callback function where the arrow is required to point in another + direction, change its appearance and/or vanish. </desc> </method> </methods> + <!-- FIXME: properties are missing --> + </classentry> http://cvs.php.net/diff.php/php-gtk-doc/manual/en/reference/gtk/gtkenum.xml?r1=1.6&r2=1.7&ty=u Index: php-gtk-doc/manual/en/reference/gtk/gtkenum.xml diff -u php-gtk-doc/manual/en/reference/gtk/gtkenum.xml:1.6 php-gtk-doc/manual/en/reference/gtk/gtkenum.xml:1.7 --- php-gtk-doc/manual/en/reference/gtk/gtkenum.xml:1.6 Sat Oct 22 06:01:58 2005 +++ php-gtk-doc/manual/en/reference/gtk/gtkenum.xml Sat Nov 19 05:06:48 2005 @@ -398,8 +398,8 @@ </enum> - <enum id="gtk.enum.calendar"> - <enumname>GtkCalendar</enumname> + <enum id="gtk.enum.calendardisplayoptions"> + <enumname>GtkCalendarDisplayOptions</enumname> <desc> <para> These options can be used to influence the display and behaviour of a @@ -796,8 +796,8 @@ </enum> - <enum id="gtk.enum.delete"> - <enumname>GtkDelete</enumname> + <enum id="gtk.enum.deletetype"> + <enumname>GtkDeleteType</enumname> <desc> <simpara> http://cvs.php.net/co.php/php-gtk-doc/examples/reference/gtk/gtkentry/constructor.phpw?r=1.1&p=1 Index: php-gtk-doc/examples/reference/gtk/gtkentry/constructor.phpw +++ php-gtk-doc/examples/reference/gtk/gtkentry/constructor.phpw <?php /* Checking for PHP-GTK 2 Module */ if(!class_exists('gtk')) { die('Please load the PHP-GTK 2 module in your php.ini'); } /* Function to retrieve text from GtkEntry and Print it */ function get_input($entry) { $input=$entry->get_text(); echo "$input\r\n"; $entry->grab_focus(); $entry->set_text(""); } /* Setting up the Window Note the usage of connect_simple() instead of deprecated connect_object() */ $window = &new GtkWindow(); $window->set_position(Gtk::WIN_POS_CENTER); $window->connect_simple('destroy', array('gtk', 'main_quit')); /* Adding a box to the Window to allow more than one Child */ $box = &new GtkVBox(); $window->add($box); /* Adding the GtkEntry widget and connecting it to the callback function: get_text() */ $entry = &new GtkEntry(); $entry->connect('activate', 'get_input'); $box->add($entry); /* Adding a GtkButton to the box and use connect_simple() so that it will pass the GtkEntry to the callback function when it is clicked */ $button = &new GtkButton('Click Me to echo input!'); $button->connect_simple('clicked', 'get_input', $entry); $box->add($button); /* Display everything and start the main loop */ $box->show_all(); $window->show_all(); Gtk::main(); ?>
« previous php.gtk.doc (#1653) next »