From 6a07c8409b97ff0231475de4cae7569b5b5d2313 Mon Sep 17 00:00:00 2001 From: "Ignacio R. Morelle" Date: Mon, 29 Nov 2010 20:42:54 +0000 Subject: [PATCH] GUI2: Document tsimple_item_selector --- src/gui/dialogs/simple_item_selector.cpp | 31 ++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/src/gui/dialogs/simple_item_selector.cpp b/src/gui/dialogs/simple_item_selector.cpp index 30f3ee550b1..6bf329f4d72 100644 --- a/src/gui/dialogs/simple_item_selector.cpp +++ b/src/gui/dialogs/simple_item_selector.cpp @@ -30,6 +30,37 @@ namespace gui2 { +/*WIKI + * @page = GUIWindowDefinitionWML + * @order = 2_simple_item_selector + * + * == Simple item selector == + * + * A simple one-column listbox with OK and Cancel buttons. + * + * @begin{table}[dialog_widgets] + * + * title & & label & m & + * Dialog title label. $ + * + * message & & label & m & + * Text label displaying a description or instructions. $ + * + * listbox & & listbox & m & + * Listbox displaying user choices. $ + * + * -item & & control & m & + * Widget which shows a listbox item label. $ + * + * ok & & button & m & + * OK button. $ + * + * cancel & & button & m & + * Cancel button. $ + * + * @end{table} + */ + REGISTER_WINDOW(simple_item_selector) tsimple_item_selector::tsimple_item_selector(const std::string& title, const std::string& message, list_type const& items, bool title_uses_markup, bool message_uses_markup)