Mercurial > hg > openttd
changeset 13433:e35149436284 draft
(svn r17942) -Documentation: Add a few doxygen comments to the dropdown code.
| author | alberth <alberth@openttd.org> |
|---|---|
| date | Sun, 01 Nov 2009 20:50:00 +0000 |
| parents | e8ec1469192b |
| children | 241713c5c665 |
| files | src/widgets/dropdown.cpp |
| diffstat | 1 files changed, 11 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/widgets/dropdown.cpp +++ b/src/widgets/dropdown.cpp @@ -87,7 +87,7 @@ WindowNumber parent_wnd_num; ///< Parent window number. byte parent_button; ///< Parent widget number where the window is dropped from. DropDownList *list; - int selected_index; + int selected_index; ///< Index of the selected item in the list. byte click_delay; bool drag_mode; bool instant_close; @@ -380,6 +380,16 @@ dw->instant_close = instant_close; } +/** Show a dropdown menu window near a widget of the parent window. + * The result code of the items is their index in the #strings list. + * @param w Parent window that wants the dropdown menu. + * @param strings Menu list, end with #INVALID_STRING_ID + * @param selected Index of initial selected item. + * @param button Button widget number of the parent window #w that wants the dropdown menu. + * @param disabled_mask Bitmask for diabled items (items with their bit set are not copied to the dropdown list). + * @param hidden_mask Bitmask for hidden items (items with their bit set are displayed, but not selectable in the dropdown list). + * @param width Width of the dropdown menu. If \c 0, use the width of parent widget #button. + */ void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width) { uint result = 0;