Only some examples and some screenshots and we're mostly done for a first

2003-01-18  Glynn Foster  <glynn.foster@sun.com>

	* help/C/zenity.xml: Only some examples and some screenshots
	and we're mostly done for a first draft.

	* src/calendar.c: Don't set the text if it's NULL.

	* src/main.c: Swap the order of the commandline dialogs so
	that we're alphabetical.

	* src/zenity.glade: Add some default strings.
This commit is contained in:
Glynn Foster 2003-01-18 18:02:14 +00:00 committed by Glynn Foster
parent 10e683c2e7
commit 18760d406d
5 changed files with 385 additions and 78 deletions

View File

@ -1,3 +1,15 @@
2003-01-18 Glynn Foster <glynn.foster@sun.com>
* help/C/zenity.xml: Only some examples and some screenshots
and we're mostly done for a first draft.
* src/calendar.c: Don't set the text if it's NULL.
* src/main.c: Swap the order of the commandline dialogs so
that we're alphabetical.
* src/zenity.glade: Add some default strings.
2003-01-18 Glynn Foster <glynn.foster@sun.com>
* data/Makefile.am, data/zenity.png, src/about.c: Hooray!

View File

@ -86,74 +86,118 @@
<varlistentry>
<term><varname>--calendar</varname></term>
<listitem>
<para>Display a Calendar dialog</para>
<para>Display a Calendar dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--entry</varname></term>
<listitem>
<para>Display a Text Entry dialog</para>
<para>Display a Text Entry dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--error</varname></term>
<listitem>
<para>Display an Error dialog</para>
<para>Display an Error dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--info</varname></term>
<listitem>
<para>Display an Informational dialog</para>
<para>Display an Informational dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--file-selection</varname></term>
<listitem>
<para>Display a File Slection dialog</para>
<para>Display a File Selection dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--list</varname></term>
<listitem>
<para>Display a List dialog</para>
<para>Display a List dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--progress</varname></term>
<listitem>
<para>Display a Progress dialog</para>
<para>Display a Progress dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--question</varname></term>
<listitem>
<para>Display a Question dialog</para>
<para>Display a Question dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--text-info</varname></term>
<listitem>
<para>Display a Text Information dialog</para>
<para>Display a Text Information dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--warning</varname></term>
<listitem>
<para>Display a Warning dialog</para>
<para>Display a Warning dialog.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ==== General Options ====== -->
<sect1 id="zenity-basic-use">
<title>Basic Use</title>
<para>
&app; can only be used to create relatively simple dialogs, but is especially useful
when used in scripts. When a user has completed an action requested of them, and the
dialog closes, &app; prints any text specific to the dialog to standard error and
an exit code is returned. Information about what text is printed to standard error will be
detailed in the individual dialog sections.
</para>
<para>
The following exit codes are observed by &app;:
</para>
<variablelist>
<varlistentry>
<term><varname>0</term>
<listitem>
<para>The user has pressed either 'OK' or 'Close'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>1</term>
<listitem>
<para>The user has pressed either 'Cancel' or closed the dialog through the window functions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>-1</term>
<listitem>
<para>An unexpected error has occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ==== General Options ====== -->
@ -176,72 +220,321 @@
<varlistentry>
<term><varname>--title</varname>=TITLE</term>
<listitem>
<para>Specify the title of a dialog</para>
<para>Specify the title of a dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--window-icon</varname>=ICON_PATH</term>
<listitem>
<para>Specify the icon that should appear in the window frame of the dialog</para>
<para>Specify the icon that should appear in the window frame of the dialog.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ==== Calendar Options ======
<!-- ==== Calendar Options ====== -->
Calendar options
--text=STRING Set the dialog text
--day=INT Set the calendar day
--month=INT Set the calendar month
--year=INT Set the calendar year
--date-format=STRING Set the format for the returned date
<sect1 id="zenity-calendar-options">
<title>Calendar</title>
Text entry options
--text=STRING Set the dialog text
--entry-text=STRING Set the entry text
--hide-text Hide the entry text
<para>
To create a Calendar dialog, use <command>--calendar</command>. &app; will return the
date selected to standard error. The following list of options are also available for
the Calendar dialog:
</para>
Info options
--text=STRING Set the dialog text
<variablelist>
Error options
--text=STRING Set the dialog text
<varlistentry>
<term><varname>--text</varname>=TEXT</term>
<listitem>
<para>Specify the text to appear in the Calendar dialog.</para>
</listitem>
</varlistentry>
File selection options
--filename=FILENAME Set the filename
<varlistentry>
<term><varname>--day</varname>=DAY</term>
<listitem>
<para>Specify the day to be pre-selected in the Calendar dialog. This must be a
number between 1 and 31.
</para>
</listitem>
</varlistentry>
List options
--column=STRING Set the column header
--checklist Use check boxes for first column
--radiolist Use radio buttons for first column
--separator=STRING Set output separator character
<varlistentry>
<term><varname>--month</varname>=MONTH</term>
<listitem>
<para>Specify the day to be pre-selected in the Calendar dialog. This must be
a number between 1 and 12.
</para>
</listitem>
</varlistentry>
Progress options
--text=STRING Set the dialog text
--percentage=INT Set initial percentage
--pulsate Pulsate progress bar
<varlistentry>
<term><varname>--year</varname>=YEAR</term>
<listitem>
<para>Specify the year to be pre-selected in the Calendar dialog.</para>
</listitem>
</varlistentry>
Question options
--text=STRING Set the dialog text
<varlistentry>
<term><varname>--data-format</varname>=FORMAT</term>
<listitem>
<para>Specify the format to be returned from the Calendar dialog after
the selection has been made. This defaults to a format depending
on your locale. The format must be of <command>strftime</command>
style eg. "%A %d/%m%y"</para>
</listitem>
</varlistentry>
Text options
--filename=FILENAME Open file
</variablelist>
Warning options
--text=STRING Set the dialog text
<!-- FIXME: Add an example of a script, including a screenshot -->
Miscellaneous options
--about About zenity
--version Print version
</sect1>
Help options
-?, --help Show this help message
--usage Display brief usage message
<!-- ==== Text Entry Options ====== -->
-->
<sect1 id="zenity-text-entry-options">
<title>Text Entry</title>
<para>
To create a Text Entry dialog, use <command>--text-entry</command>. &app; returns the
contents of the text entry to standard error. The following list of options are also
available for the Text Entry dialog:
</para>
<variablelist>
<varlistentry>
<term><varname>--text</varname>=TEXT</term>
<listitem>
<para>Specify the text to appear in the Text Entry dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--entry-text</varname>=TEXT</term>
<listitem>
<para>Specify the text to appear in the entry field of the Text Entry dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--hide-text</varname></term>
<listitem>
<para>Specify that the text in the entry field of the Text Entry dialog be hidden.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ==== Message Options ====== -->
<sect1 id="zenity-message-options">
<title>Messages</title>
<para>
There are 4 types of message dialogs in &app; - Error, Informational, Question and Warning. To
create an Error dialog, use <command>--error</command>. To create an Informational dialog, use
<command>--info</command>. To create a Question dialog, use <command>--question</command>. To
create a Warning dialog, use <command>--question</command>. The following list of options is
available for the message dialogs.
</para>
<variablelist>
<varlistentry>
<term><varname>--text</varname>=TEXT</term>
<listitem>
<para>Specify the text to appear in the message dialog.</para>
</listitem>
</varlistentry>
</variablelist>
<!-- FIXME: Add an example of a script, including a screenshot -->
</sect1>
<!-- ==== File Selection Options ====== -->
<sect1 id="zenity-file-selection-options">
<title>File Selection</title>
<para>
To create a File Selection dialog, use <command>--file-selection</command>. &app; returns
the file or directory selected to standard error. The following list of options are also
available for the File Selection dialog:
</para>
<variablelist>
<varlistentry>
<term><varname>--filename</varname>=FILENAME</term>
<listitem>
<para>Specify the file or directory to be pre-selected in the File Selection dialog.</para>
</listitem>
</varlistentry>
</variablelist>
<!-- FIXME: Add an example of a script, including a screenshot -->
</sect1>
<!-- ==== List Options ====== -->
<sect1 id="zenity-list-options">
<title>Lists</title>
<para>
To create a List dialog, use <command>--list</command>. &app; returns the entries of
the first columns selected to standard error. If <command>--checklist</command> or
<command>--radiolist</command> is used, then &app; will return the entries of the
second columns selected to standard error. The following list of options are also
available for the File Selection dialog:
</para>
<variablelist>
<varlistentry>
<term><varname>--column</varname>=COLUMN</term>
<listitem>
<para>Specify the column headers to appear in the List dialog. This option must be
called for each column that you want to appear in the dialog.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--checklist</varname></term>
<listitem>
<para>Specify if the first column should contain check boxes in the List dialog.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--radiolist</varname></term>
<listitem>
<para>Specify if the first column should contain radio boxes in the List dialog.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--seperator</varname>=SEPERATOR</term>
<listitem>
<para>Specify what seperator character should be used when the List dialog returns the selected entries. The
default character is '\'. If you want to specify a newline, use '\n'.
</para>
</listitem>
</varlistentry>
</variablelist>
<!-- FIXME: Add an example of a script, including a screenshot -->
</sect1>
<!-- ==== Progress Options ====== -->
<sect1 id="zenity-progress-options">
<title>Progress</title>
<para>
To create a Progress dialog, use <command>--progress</command>. The following list
of options are also available for the Progress dialog:
</para>
<variablelist>
<varlistentry>
<term><varname>--text</varname>=TEXT</term>
<listitem>
<para>Specify the text to appear in the Progress dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--percentage</varname>=PERCENTAGE</term>
<listitem>
<para>Specify the initial percentage that should be set in the Progress dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--pulsate</varname></term>
<listitem>
<para>Specify if the Progress dialog should pulsate until an EOF character is read
from standard input.</para>
</listitem>
</variablelist>
<!-- FIXME: Add an example of a script, including a screenshot -->
</sect1>
<!-- ==== Text Information Options ====== -->
<sect1 id="zenity-text-options">
<title>Text Information</title>
<para>
To create a Text Information dialog, use <command>--text-info</command>. The following list
of options are also available for the Text Information dialog:
</para>
<variablelist>
<varlistentry>
<term><varname>--filename</varname>=FILENAME</term>
<listitem>
<para>Specify the file to be loaded in the Text Information dialog.</para>
</listitem>
</varlistentry>
</variablelist>
<!-- FIXME: Add an example of a script, including a screenshot -->
</sect1>
<!-- ==== Miscellaneous Options ====== -->
<sect1 id="zenity-miscellaneous-options">
<title>Miscellaneous</title>
<para>
The following list of options are also available for &app;:
</para>
<variablelist>
<varlistentry>
<term><varname>--about</varname></term>
<listitem>
<para>Display some information about &app;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--version</varname></term>
<listitem>
<para>Print the version number of &app;.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ================ Application License ================= -->
<sect1 id="license">

View File

@ -64,6 +64,8 @@ zenity_calendar (ZenityData *data, ZenityCalendarData *cal_data)
zenity_util_set_window_icon (dialog, ZENITY_IMAGE_FULLPATH ("zenity-calendar.png"));
text = glade_xml_get_widget (glade_dialog, "zenity_calendar_text");
if (cal_data->dialog_text)
gtk_label_set_text (GTK_LABEL (text), cal_data->dialog_text);
calendar = glade_xml_get_widget (glade_dialog, "zenity_calendar");

View File

@ -136,15 +136,6 @@ struct poptOption options[] = {
N_("Display error dialog"),
NULL
},
{
"info",
'\0',
POPT_ARG_NONE,
NULL,
OPTION_INFO,
N_("Display info dialog"),
NULL
},
{
"file-selection",
'\0',
@ -154,6 +145,15 @@ struct poptOption options[] = {
N_("Display file selection dialog"),
NULL
},
{
"info",
'\0',
POPT_ARG_NONE,
NULL,
OPTION_INFO,
N_("Display info dialog"),
NULL
},
{
"list",
'\0',
@ -610,15 +610,6 @@ struct poptOption application_options[] = {
N_("Text entry options"),
NULL
},
{
NULL,
'\0',
POPT_ARG_INCLUDE_TABLE,
info_options,
0,
N_("Info options"),
NULL
},
{
NULL,
'\0',
@ -637,6 +628,15 @@ struct poptOption application_options[] = {
N_("File selection options"),
NULL
},
{
NULL,
'\0',
POPT_ARG_INCLUDE_TABLE,
info_options,
0,
N_("Info options"),
NULL
},
{
NULL,
'\0',

View File

@ -74,7 +74,7 @@
<child>
<widget class="GtkLabel" id="zenity_calendar_text">
<property name="visible">True</property>
<property name="label" translatable="yes">Select a date from below</property>
<property name="label" translatable="yes">Select a date from below.</property>
<property name="use_underline">False</property>
<property name="use_markup">True</property>
<property name="justify">GTK_JUSTIFY_LEFT</property>