Home > freetb4matlab > zenity > zenity_list.m

zenity_list

PURPOSE ^

% Displays a graphical list of data.

SYNOPSIS ^

function s = zenity_list(title, columns, data, varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn  {Function File} @var{s} = zenity_list(@var{title}, @var{columns}, @var{data}, @var{options1}, ...)
% Displays a graphical list of data.
% The variable @var{title} sets the title of the list. The variable
% @var{columns} must be a cell array of strings of length N containing the headers
% of the list. The variable @var{data} must be cell array of strings of
% length NxM containing the data of the list.
%
% The code
% @example
% zenity_list('Age versus Height', @{'Age', 'Height'@}, 
% @{'10', '20'; '120cm', '180cm'@})
% @end example
% produces a list of the data. The user can select a row in the table, and it's
% first value will be returned by the function when the user closes the window.
%
% It's possible to alter the behaviour of the list window by passing more than
% three arguments to the funtion. Theese optional string arguments can be
% @table @samp
% @item checklist
% The first row in the list will be a check box. The first value of each data row
% must be either 'TRUE' or 'FALSE'.
% @item radiolist
% The first row in the list will be a radio list. The first value of each data row
% must be either 'TRUE' or 'FALSE'.
% @item editable
% The values of the list will be editable by the user.
% @item A numeric value
% The value returned by the function will be the value of this column
% of the user selected row.
% @item all
% The value returned by the function will be the entire row selected by the user.
% @end table
%
% @seealso{zenity_calendar, zenity_progress, zenity_entry, zenity_message,
% zenity_text_info, zenity_file_selection, zenity_notification}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Fri 22-May-2009 15:13:00 by m2html © 2003