Options has 5 comma-separated fields:
1. if it contains a 'i' and/or a 'b' the content (not the label) is rendered in italic and/or bold.
2. link: if set to a menuaction string or an array with get-params (via the content-arry), a link to that methode = app.class.method is put around the label
3. if set URLs in the content get activated
4. name of form-element the label is for: gives focus to that element if the label gets clicked
5. target for the link, eg. _blank
6. widthxheight if a popup should be used for the link, eg. 600x400
7. titlextitle for the link

Options has 3 comma-separated fields:
xml: size: the length in chars of the input-field
xml: maxlength: the maximum length of the input
xml: validator: perl regular expression to validate the input (kommas are allowed in the expression)

Options has 3 comma-separated fields:
xml: min: minimum value, default none, empty values are Ok, as long as needed is not set
xml: max: maximum value, default none, empty values are Ok, as long as needed is not set
xml: size: the length in chars of the input-field, default 5

Options has 4 comma-separated fields:
xml: min: minimum value, default none, empty values are Ok, as long as needed is not set
xml: max: maximum value, default none, empty values are Ok, as long as needed is not set
xml: size: the length in chars of the input-field, default 5 xml: precision: precision of the float number, default maximum

Options has 2 comma-separated fields:
xml: cols: the width of the field in chars
xml: rows: the number of rows

Options has 5 comma-separated fields:
xml: mode: {ascii|simple|extended|advanced}
xml: height: height of htmlarea
xml: width: width of htmlarea
xml: toolbar: {true|false} show toolbar
xml: base_href: if passed activates the browser for images at the path (relative to the docroot

Multiple checkboxes can have an identical name ending with [], in that case the value will be an array with the set_value's of the checked boxes. You can use a button with a custom javascript onclick action of eg. "toggle_all(this.form,form::name('nm[rows][checkbox][]')); return false;" and a set_value of "$row_cont[id]" to toggle all checkboxes in the lines of a nextmatch widget. The form::name( ) function translate the name used in the template into the name used in the form. If the button is an image-button, check needed to render it as button and not as image with link, which has no this.form property!

needed: if set and the user has JavaScript enabled the button is renderd as a link around the label and a hidden input to set id if the link is clicked.
Options xml: image, ro_image: Image to use instead of a Button with a label. There will be no button around the image. If a ro_image is given (separated by a comma in the editors options) it will be used if the button is set readonly (else the button is no rendered at all) . onclick: specify some java-script to be called if the button gets pressed/clicked:
a) general javascript: "window.close();"
b) confirmation: "return window.confirm('');" (message get run through lang()!)
c) popup: app.class.func&id=$cont[id],target(default _blank),width (default 600),height (default 450) You can use $cont[] or $row_cont[] (note no quotes!) to pass further information to the popup via the content array.)

multiselect: options > 1
<listbox rows="#"/>

Examples for predefined selectboxes:

<listbox type="select-cat" rows="5"/>

<menulist>
  <menupopup type="select-account" options="All,both,2"/>
</menulist>

1. in $content["options-$name"]
2. or in an separate array only for select-box-options under the index name, this array is passed to the exec or show function of the etemplate-class

xml: rows: only for <listbox>: number of rows to show

xml options: only for <menupopup/>: textual label for a first Row, e.g. 'All' or 'None' (id will be ''), additional attr see sub-types

xml: type: can be set to get several predefined select-contents, in that case you dont need to set the content as descripted above (if set it too its in front of the predefined rows):
select-cat:
Select an eGW category, determined by the options-field:
,{no_global_cats},{extra_style_multiselct},{cat_app(default:current app)}
select-account:
Select a user and/or group, determined by the options-field:
,{accounts(default)|groups|both},{''(phpgw-default)|0(only lid)|1(only names)|2(both)}
select-percent, select-priority, select-access, select-country, select-state:
as you expect by the name
select-year, select-month, select-day:
options for year: ,start,end (start and end can be a number of years from now or if > 100 a absolut year)
select-number:
Select a number out of a range specified by the options-field:
,{start (default=1)},{end (incl., default=10)},{decrement (default={padding zeros}1)},{suffix}.
Example with padding zeros: options=',0,59,05' will give values: 00, 05, 10, ..., 55 (like you would use it for minutes in a time-field). The suffix get's added to the label of each option.
select-dow:
Select one or multiple weekdays, keys are as defined in MCAL_M_... (1=Sun, 2=Mon, 4=Tue, ...)
select-app:
Select an application, availible options: ,{''=user enabled(default)|installed|all)}

<date type="date-time"/>

<date type="date-timeonly" options="H:i"/>

<date type="date-houronly"/>

<date type="date-duration"/>

Duration a floating point input with an optional selectbox for the unit (hours or days)
Options: [duration-storage-format] [,[duration-display][,hours_per_day]]
duration-storage-format: 'h' = hours (float), 'd' = days (float), default minutes (integer)
duration-display: 'd' = days, 'h' = hours, 'dh' = days or hours with selectbox, optional '%' allows to enter a percentage
hours_per_day: conversation between hours and (working) day, default 8 hours_per_day: conversation between hours and (working) day, default 8

<hbox span="all">
  <widget ...>
  <widget ...>
</hbox>

<box orient="horizontal">
  <widget ...>
  <widget ...>
</box>

Options in the editor: the number of cells in the box (does NOT need to be set in xml).
orient: horizontal, vertical or none (means h/vbox as expected and no table for boxes) cellpadding,cellspacing: known table-options keepEmpty: if true, empty cells (lines or rows) are kept, otherwise they are completly removed

Options in the editor: the number of cells in the box (does NOT need to be set in xml).
orient: horizontal, vertical or none (defaults to vertical) options: cellpadding,cellspacing of the table

The following fields / attributes are in the Editor and internaly in the class separeted by '|', in the xml/xul-file the are attributes of each tab- or grid-tag:
Label xml: label: the labels of the tabs eg. 'Tab 1|Tab 2|Tab 3'
Help xml: statustext: of the tabs
Name xml: id: the names/ids of the eTemplates/grid's to fill the bodies of the tabs, if the name contains no '.', it will be prefixed with the name of the template the widget is in plus a '.'

Name xml: id: optional name of the manual page (as index into $content or direct). If no manual page is given, the link included the referer as _GET param.

The indexes of the custom fields in content are prefixed with a hash (#).

Options xml: options: name of the template to display the rows
Name xml: id: index into the content-array, it need to be pre-set with some information for the nextmatch widget and it returns its content with it:

$content[$id] = array(		// I = value set by the app, 0 = value on return / output
	'get_rows'       =>	// I  method/callback to request the data for the rows eg. 'notes.bo.get_rows'
	'filter_label'   =>	// I  label for filter    (optional)
	'filter_help'    =>	// I  help-msg for filter (optional)
	'no_filter'      => True// I  disable the 1. filter
	'no_filter2'     => True// I  disable the 2. filter (params are the same as for filter)
	'no_cat'         => True// I  disable the cat-selectbox
	'cat_app'        =>     // I  application the cat's should be from, default app in get_rows
	'template'       =>	// I  template to use for the rows, if not set via options
	'header_left'    =>	// I  template to show left of the range-value, left-aligned (optional)
	'header_right'   =>	// I  template to show right of the range-value, right-aligned (optional)
	'bottom_too'     => True// I  show the nextmatch-line (arrows, filters, search, ...) again after the rows
	'never_hide'     => True// I  never hide the nextmatch-line if less then maxmatch entrie
	'lettersearch'   => True// I  show a lettersearch
	'searchletter'   =>	// I0 active letter of the lettersearch or false for [all]
	'start'          =>	// IO position in list
	'num_rows'       =>	// IO number of rows to show, defaults to maxmatches from the general prefs
	'cat_id'         =>	// IO category, if not 'no_cat' => True
	'search'         =>	// IO search pattern
	'order'          =>	// IO name of the column to sort after (optional for the sortheaders)
	'sort'           =>	// IO direction of the sort: 'ASC' or 'DESC'
	'col_filter'     =>	// IO array of column-name value pairs (optional for the filterheaders)
	'filter'         =>	// IO filter, if not 'no_filter' => True
	'filter_no_lang' => True// I  set no_lang for filter (=dont translate the options)
	'filter_onchange'=> 'this.form.submit();'// I onChange action for filter, default: this.form.submit();
	'filter2'        =>	// IO filter2, if not 'no_filter2' => True
	'filter2_no_lang'=> True// I  set no_lang for filter2 (=dont translate the options)
	'filter2_onchange'=> 'this.form.submit();'// I onChange action for filter, default: this.form.submit();
	'rows'           =>	//  O content set by callback
	'total'          =>	//  O the total number of entries
	'sel_options'    =>	//  O additional or changed sel_options set by the callback and merged into $tmpl->sel_options
	'no_columnselection' => // I  turns off the columnselection completly, turned on by default
	'columnselection-pref' => // I  name of the preference (plus 'nextmatch-' prefix), default = template-name
	'default_cols'   => 	// I  columns to use if there's no user or default pref (! as first char uses all but the named columns), default all columns
	'options-selectcols' => // I  array with name/label pairs for the column-selection, this gets autodetected by default.
					A name => false hides the column from the column-selection.
					To completely hide a column, you need to use the Grid column attributes - disabled in eTemplate, and have your get_rows function
					set a key that matches.
					For example, if your column name is private_phone, use the eTemplate editor to set column disabled to @no_private_phone,
					and have your get_rows function set $rows['no_private_phone'] = true (or some calculated condition).
					
	'return'         =>     // IO allows to return something from the get_rows function if $query is a var-param!
	'csv_fields'     =>	// I  false=disable csv export, true or unset=enable it with auto-detected fieldnames,
					or array with name=>label or name=>array('label'=>label,'type'=>type) pairs (type is a eT widget-type)
);

/*
 * example: the get_rows function from notes.bo.get_rows (has to be in public_functions !)
 */
function get_rows($query,&$rows,&$readonlys)
{
	$rows = $this->read($query['start'],$query['search'],$query['filter'],$query['cat_id']);
	if (!is_array($rows))
	{
		$rows = array( );
	}
	$readonlys = array( );	// set readonlys to enable/disable our edit/delete-buttons
	while (list($n,$note) = each($rows))
	{
		if (!$this->check_perms($this->grants[$note['owner_id']],PHPGW_ACL_EDIT))
		{
			$readonlys["edit[$note[id]]"] = True;
		}
		if (!$this->check_perms($this->grants[$note['owner_id']],PHPGW_ACL_DELETE))
		{
			$readonlys["delete[$note[id]]"] = True;
		}
	}
	return $this->total_records;
}

/*
 * Example how the nextmatch-widget is used in notes.ui.index:
 */
function index($content = 0)
{
	if (!is_array($content))
	{
		$content = array('nm' => $this->session_data); // restore settings from the session
	}
	if (isset($content['nm']['rows']))		// one of the buttons in the rows is pressed
	{
		$this->session_data = $values['nm'];	// save the settings in the session
		unset($this->session_data['rows']);	// we dont want to save the content of the rows
		$this->save_sessiondata();

		if (isset($values['nm']['rows']['edit']))
		{
			list($id) = each($values['nm']['rows']['edit']);
			return $this->edit($id);
		}
		elseif (isset($values['nm']['rows']['delete']))
		{
			list($id) = each($values['nm']['rows']['delete']);
			return $this->delete($id);
		}
	}
	$values['nm']['options-filter'] = array (	// set up the data for our filter
		'all'			=> 'Show all',
		'public'		=> 'Only yours',
		'private'	=> 'Private'
	);
	$values['nm']['get_rows'] = 'notes.bo.get_rows';
	$values['nm']['no_filter2'] = True;		// disable the 2. filter

	$this->tpl->read('notes.index');
	$this->tpl->exec('notes.ui.index',$values);
}

Nextmatch-
FilterHeader

Nextmatch-
Custom FilterHeader

Nextmatch-
AccountFilter

<nextmatch type="nextmatch-filterheader" id="col-name"/>

<nextmatch type="nextmatch-customfilter" id="col-name" options="select-precent"/>

<nextmatch type="nextmatch-accountfilter" id="col-name"/>

nextmatch-
filterheader

nextmatch-
customfilter

nextmatch-
accountfilter

nextmatch-
header

nextmatch-sortheader
Widget to be placed as a colum-header in the headerline of a nextmatch-template. It allows, by clicking on it, to order the lines of the nextmatch after a certain column. The column-name is given as name (xml:id) the label is show as a link of button (no javascript). One can specify a default sorting: options={DESC|ASC} (default=ASC), to be used when the header is clicked for the first time. Consecutive click on the header change the sorting direction, indicated by a little up- or down-arrow. As a second comma-separated parameter one can specify an extra label for the column-selection.

nextmatch-filterheader
Widget to allow to show only certain row, which match a selected filter-value. The column-name is given as name (xml:id), the options of the displayed selectbox need to be set as for an ordinary selectbox (eg. in the options parameter to the uietemplate::exec function). If no extra-label is given in options, lang('all') will be used for the empty value, which means no filter activ. An (optional) label can be given and is also used for the column-selection.

nextmatch-customfilter
The custom filterheader allows to use other (select-)widgets to filter by them. They have to be specified as the first parameter in the comma-separated options attribute. In all other aspects it is identical to the filterheader.

nextmatch-accountfilter
The Accountfilter allows to select users (via the prefered user-selection-method) to filter by them. It's identical to a nextmatch-customfilter with options="select-account".

nextmatch-header
Just a header-label for a nextmatch column. It names the column for the column for the column-selection (in difference to the label). The name is used to hide the column (with a 'no_' prefix) and as the name for the preference. A different label for the column-selection preference can be specified via the option field.

Note: All four widgets interoperate with the nextmatch-widget which passes the set values as part if the query-parameter to its get_rows function, they are not returned in the rows sub-array.

<link type="link-list" id="name"/>

<link type="link-string" id="name"/>

link-list

link-string

eGroupWare has a linking system that lets you link two records from different apps together.

For example, you can link the addressbook entry of the person you're meeting with to the meeting on your calendar, or an infolog entry for the phone call you made to postpone the meeting.

To display links in your own application, you should use the LinkList group of widgets.

link-list
Widget to shows the links to an entry and a Unlink Button for each link.

It needs an array with two entries. If you name the LinkList widget 'links', you need:

$data['links']['to_app'] = 'myapp';
$data['links']['to_id'] = $record_id;

This will display links where the $record_id record of myapp is one side of the link. Make sure that both variables are properly defined before the form template gets executed.

link-to
Widget to make a links to other entries of link-aware apps and to attach files.

Note: Both Widgets can be used on the same template with the same name. They share the content of the variable with that name, which contains just the id of the entry in the current app.

link-string
Comma-separated list of link-titles with a link to its view-method, value is like the return of bolink::get_links().

In your setup.inc.php, you need to point $setup_info['myapp']['hooks']['search_link'] to a function that will return an array:

return array(
'query' =>      'myapp.bo_myapp.link_query', 
	// A function that takes a search string
	// and returns a list of matching records
'title' =>      'myapp.bo_myapp.link_title', 
	// A function that takes an id from one side
	// of a link and returns a string for that entry
'view'  =>      array('menuaction'=>'myapp.ui_myapp.link_view'),
	// Function to view a link, may be an existing view function
'view_id'       =>      'link_id', 
	// name of the id variable provided to the view function above
'add'   =>      array('menuaction' => 'myapp.ui_myapp.new_entry'), 
	// Function to add a new entry
);

Also, make sure that the declared methods are implemented and methods from the UI class are listed in its $public_methods attribute:

class ui_myapp {
	var $public_methods = array(
		'view' => true,
		'add' => true
	);
...
}

The Ajax Select is a Combo Box. It lets the user type anything they want, and choose from a list of options that are presented below. The user is not limited to the choices, but there is some checking done. If what they type returns several results, and they don't choose one, for example. You can reject any values you don't like in your UI code. It is best used where you might normally want to use a selectbox but your list of data is too large. You can have several on one page, but the name must be different for each.

Options can be found under the "AJAX Select options" section of the pop-up.

Data Source: the list options, can be any function that can provide data for a nextmatch widget.

Title Source: When an option from the list is selected, the text in the search function is replaced with the result of this function. The ID Field is passed. link_title() functions work well.

ID Field: Data Source is expected to return an array as for a nextmatch, with several columns. This is the key of the column you actually want returned for a value.

Result row template: (Optional) You can provide a custom eTemplate to use for the list options. It should be constructed similarly to a row template for a nextmatch, and will be repeated for each option.

Link: (Optional) If the field is read-only, and Link is provided, the widget will turn into a link. Link should look like: perp_ap.ui_perp_supplier.edit&supplier_id=${cont[supplier_id]} where ID Field is supplier_id.

Icon: (Optional) An icon placed to the left of the search box, to help indicate what the user is searching (addresses, suppliers, etc.). It will be automatically resized.