[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /en/package gtk2.xml mail.xml /en/package/gtk2 entrydialog.xml /en/package
From: "Christian Weiske" <cweiske () php ! net>
Date: 2006-06-29 20:32:33
Message-ID: cvscweiske1151613153 () cvsserver
[Download RAW message or body]
cweiske Thu Jun 29 20:32:33 2006 UTC
Added files:
/peardoc/en/package/gtk2 entrydialog.xml
/peardoc/en/package/gtk2/entrydialog/entrydialog --construct.xml
get.xml
gettext.xml
newsimple.xml
run.xml
setdefaultresponse.xml
settext.xml
Modified files:
/peardoc/en/package gtk2.xml mail.xml
Log:
Documentation for Gtk2_EntryDialog.
Also forgot to commit mail.xml so that the Mail_Mbox
docs get visible.
["cweiske-20060629203233.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/gtk2.xml
diff -u peardoc/en/package/gtk2.xml:1.3 peardoc/en/package/gtk2.xml:1.4
--- peardoc/en/package/gtk2.xml:1.3 Fri Feb 17 16:04:31 2006
+++ peardoc/en/package/gtk2.xml Thu Jun 29 20:32:32 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<chapter id="package.gtk2">
@@ -12,6 +12,7 @@
&blankpagehack;
+ &package.gtk2.entrydialog;
&package.gtk2.filedrop;
&package.gtk2.vardump;
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail.xml?r1=1.7&r2=1.8&diff_format=u
Index: peardoc/en/package/mail.xml
diff -u peardoc/en/package/mail.xml:1.7 peardoc/en/package/mail.xml:1.8
--- peardoc/en/package/mail.xml:1.7 Fri Feb 17 16:04:31 2006
+++ peardoc/en/package/mail.xml Thu Jun 29 20:32:32 2006
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<chapter id="package.mail">
<title>Mail</title>
@@ -11,6 +11,7 @@
&package.mail.mail;
&package.mail.mail-imap;
+ &package.mail.mail-mbox;
&package.mail.mail-mime;
&package.mail.mail-queue;
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog.xml
+++ peardoc/en/package/gtk2/entrydialog.xml
<sect1 id="package.gtk2.entrydialog">
<title>Gtk2_EntryDialog</title>
<refentry id="package.gtk2.entrydialog.entrydialog-summary">
<refnamediv>
<refname>
Class Summary
<classname>Gtk2_EntryDialog</classname>
</refname>
<refpurpose>Get text input easily.</refpurpose>
</refnamediv>
<refsect1>
<title>About Gtk2_EntryDialog</title>
<para>
<classname>Gtk2_EntryDialog</classname> provides a dialog with a message
and one single text input field, and some buttons like OK and Cancel.
The class tries to make it as easy as possible to get the text
from the user with only a few lines of code, while keeping the full
power of the <classname>GtkDialog</classname> class.
</para>
<para>
The most easy way to retrieve the text with one line of code is
using the
<link linkend="package.gtk2.entrydialog.entrydialog.get">get()</link>
static method.
</para>
</refsect1>
<refsect1>
<title>
Class Tree for
<classname>Gtk2_EntryDialog</classname>
</title>
<para>
<itemizedlist>
<listitem>
<para>
GtkDialog
<itemizedlist>
<listitem>
<para>
GtkMessageDialog
<itemizedlist>
<listitem>
<para>
Gtk2_EntryDialog
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
&package.gtk2.entrydialog.entrydialog.--construct;
&package.gtk2.entrydialog.entrydialog.newsimple;
&package.gtk2.entrydialog.entrydialog.get;
&package.gtk2.entrydialog.entrydialog.run;
&package.gtk2.entrydialog.entrydialog.gettext;
&package.gtk2.entrydialog.entrydialog.settext;
&package.gtk2.entrydialog.entrydialog.setdefaultresponse;
</sect1>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/--construct.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/--construct.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/--construct.xml
<refentry id="package.gtk2.entrydialog.entrydialog.--construct">
<refnamediv>
<refname>
constructor
<function>Gtk2_EntryDialog</function>
</refname>
<refpurpose>Create a entry dialog instance.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
void constructor
<function>Gtk2_EntryDialog::__construct</function>
</funcdef>
<paramdef>
GtkWindow <parameter>$parent</parameter>
</paramdef>
<paramdef>
GtkDialogFlags <parameter>$flags</parameter>
</paramdef>
<paramdef>
GtkMessageType <parameter>$type</parameter>
</paramdef>
<paramdef>
GtkButtonsType <parameter>$buttons</parameter>
</paramdef>
<paramdef>
string <parameter>$message</parameter>
</paramdef>
<paramdef>
string <parameter>$default</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.--construct.desc">
&title.desc;
<para>
Creates a new entry dialog instance. After creating it, you can
modify it and finally use the
<link linkend="package.gtk2.entrydialog.entrydialog.run">run()</link>
to show it and await the input.
</para>
<para>
You might want to use a more simple constructor, e.g.
<link linkend="package.gtk2.entrydialog.entrydialog.get">get()</link> or
<link linkend="package.gtk2.entrydialog.entrydialog.newsimple">new_simple()</link>
</para>
<programlisting role="php">
<![CDATA[
<?php
require_once 'Gtk2/EntryDialog.php';
$id = new Gtk2_EntryDialog(
null, //parent window
0, //flags (GtkDialogFlags)
Gtk::MESSAGE_QUESTION, //type of message
Gtk::BUTTONS_OK_CANCEL, //which buttons shall be there
'What\'s your name?', //the message
'Don\'t know' //The default text
);
$answer = $id->run();
$id->destroy();
if ($answer == Gtk::RESPONSE_OK) {
echo 'The name is: ';
var_dump($id->get_text());
} else {
echo "You cancelled\r\n";
}
?>
]]>
</programlisting>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.--construct.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
<classname>GtkWindow</classname>
<parameter>$parent</parameter>
</term>
<listitem>
<para>Parent window (can be null).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
GtkDialogFlags
<parameter>$flags</parameter>
</term>
<listitem>
<para>Dialog flags (use 0 as default)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
GtkMessageType
<parameter>$type</parameter>
</term>
<listitem>
<para>Message type (e.g. Gtk::MESSAGE_QUESTION)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
GtkButtonsType
<parameter>$buttons</parameter>
</term>
<listitem>
<para>Buttons to show (e.g. Gtk::BUTTONS_OK)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string;
<parameter>$message</parameter>
</term>
<listitem>
<para>Message to display.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string;
<parameter>$default</parameter>
</term>
<listitem>
<para>Default text for the entry.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/get.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/get.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/get.xml
<refentry id="package.gtk2.entrydialog.entrydialog.get">
<refnamediv>
<refname>
<function>Gtk2_EntryDialog::get</function>
</refname>
<refpurpose>Show the dialog and retrieve the text</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
&type.string;
<function>Gtk2_EntryDialog::get</function>
</funcdef>
<paramdef>
string <parameter>$message</parameter>
</paramdef>
<paramdef>
string <parameter>$default</parameter>
</paramdef>
<paramdef>
GtkWindow <parameter><optional>$parent</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.get.desc">
&title.desc;
<para>
Creates a dialog with the given parameters, runs it, and returns the text
set. If the user cancelled the dialog, this method returns FALSE. In
any other case (even when the text is empty), the a string with the
text is returned.
</para>
<programlisting role="php">
<![CDATA[
<?php
require_once 'Gtk2/EntryDialog.php';
$text = Gtk2_EntryDialog::get(
'What\'s your name?', //the message
'Don\'t know' //The default text
);
if ($text !== false) {
echo 'The name is: ';
var_dump($text);
} else {
echo "You cancelled\r\n";
}
?>
]]>
</programlisting>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.get.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.string;
<parameter>$message</parameter>
</term>
<listitem>
<para>Message to display.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string;
<parameter>$default</parameter>
</term>
<listitem>
<para>Default text for the entry.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<classname>GtkWindow</classname>
<parameter>$parent</parameter>
</term>
<listitem>
<para>Parent window (can be null).</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.get.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
False if the user cancelled input, the text (string) otherwise.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/gettext.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/gettext.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/gettext.xml
<refentry id="package.gtk2.entrydialog.entrydialog.gettext">
<refnamediv>
<refname>
<function>Gtk2_EntryDialog::get_text</function>
</refname>
<refpurpose>Returns the text input by the user.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
string
<function>Gtk2_EntryDialog::get_text</function>
</funcdef>
<paramdef />
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.gettext.desc">
&title.desc;
<para>
Retrieves the text from the entry.
</para>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.gettext.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
The input from the user.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/newsimple.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/newsimple.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/newsimple.xml
<refentry id="package.gtk2.entrydialog.entrydialog.newsimple">
<refnamediv>
<refname>
<function>Gtk2_EntryDialog::new_simple</function>
</refname>
<refpurpose>Simplified constructor with not so much parameters.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
Gtk2_EntryDialog
<function>Gtk2_EntryDialog::new_simple</function>
</funcdef>
<paramdef>
string <parameter>$message</parameter>
</paramdef>
<paramdef>
string <parameter><optional>$default</optional> = null</parameter>
</paramdef>
<paramdef>
GtkWindow <parameter><optional>$parent</optional> = null</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.newsimple.desc">
&title.desc;
<para>
Simplified constructor with not so much parameters.
</para>
<para>
Message type is Gtk::MESSAGE_QUESTION, the flags will be Gtk::DIALOG_MODAL
if the parent is set. Only one button, OK, will be visible.
</para>
<programlisting role="php">
<![CDATA[
<?php
require_once 'Gtk2/EntryDialog.php';
$id = Gtk2_EntryDialog::new_simple(
'What\'s your name?', //the message
'Don\'t know' //The default text
);
$answer = $id->run();
$id->destroy();
if ($answer == Gtk::RESPONSE_OK) {
echo 'The name is: ';
var_dump($id->get_text());
} else {
echo "You cancelled\r\n";
}
?>
]]>
</programlisting>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.newsimple.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.string;
<parameter>$message</parameter>
</term>
<listitem>
<para>Message to display.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
&type.string;
<parameter>$default</parameter>
</term>
<listitem>
<para>Default text for the entry.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<classname>GtkWindow</classname>
<parameter>$parent</parameter>
</term>
<listitem>
<para>Parent window (can be null).</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/run.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/run.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/run.xml
<refentry id="package.gtk2.entrydialog.entrydialog.run">
<refnamediv>
<refname>
<function>Gtk2_EntryDialog::run</function>
</refname>
<refpurpose>Show the dialog and block until a button has been pressed.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
int
<function>Gtk2_EntryDialog::run</function>
</funcdef>
<paramdef />
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.run.desc">
&title.desc;
<para>
Show the dialog and block until a button has been pressed.
</para>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.run.returns">
&title.returns;
<para>
<emphasis>returns</emphasis>
The response id of the pressed button.
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/setdefaultresponse.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/setdefaultresponse.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/setdefaultresponse.xml
<refentry id="package.gtk2.entrydialog.entrydialog.setdefaultresponse">
<refnamediv>
<refname>
<function>Gtk2_EntryDialog::set_default_response</function>
</refname>
<refpurpose>Set the default response.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
void
<function>Gtk2_EntryDialog::set_default_response</function>
</funcdef>
<paramdef>
int
<parameter>$response_id</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.setdefaultresponse.desc">
&title.desc;
<para>
Set the default response.
</para>
<para>
The button with the id will be the default one, allowing you to just press return
to activate it.
</para>
</refsect1>
<refsect1 id="package.gtk2.entrydialog.entrydialog.setdefaultresponse.param">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
int
<parameter>$response_id</parameter>
</term>
<listitem>
<para>Response code</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/gtk2/entrydialog/entrydialog/settext.xml?view=markup&rev=1.1
Index: peardoc/en/package/gtk2/entrydialog/entrydialog/settext.xml
+++ peardoc/en/package/gtk2/entrydialog/entrydialog/settext.xml
<refentry id="package.gtk2.entrydialog.entrydialog.settext">
<refnamediv>
<refname>
<function>Gtk2_EntryDialog::set_text</function>
</refname>
<refpurpose>Sets the text for the entry</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>require_once \
'Gtk2/EntryDialog.php';</funcsynopsisinfo> <funcprototype>
<funcdef>
string
<function>Gtk2_EntryDialog::set_text</function>
</funcdef>
<paramdef>
string <parameter>$text</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.gtk2.entrydialog.entrydialog.settext.desc">
&title.desc;
<para>
Sets the text for the entry.
</para>
</refsect1>
</refentry>
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic