This graph shows which files directly or indirectly include this file:

Data Structures
struct	ns_menu_entry

struct	ns_menu

Enumerations
enum	menu_action { NO_ACTION = 'nsMA' , HELP_OPEN_CONTENTS , HELP_OPEN_GUIDE , HELP_OPEN_INFORMATION , HELP_OPEN_ABOUT , HELP_OPEN_LICENCE , HELP_LAUNCH_INTERACTIVE , HISTORY_SHOW_LOCAL , HISTORY_SHOW_GLOBAL , HOTLIST_ADD_URL , HOTLIST_SHOW , COOKIES_SHOW , COOKIES_DELETE , BROWSER_PAGE , BROWSER_PAGE_INFO , BROWSER_PRINT , BROWSER_NEW_WINDOW , BROWSER_VIEW_SOURCE , BROWSER_OBJECT , BROWSER_OBJECT_INFO , BROWSER_OBJECT_RELOAD , BROWSER_OBJECT_SAVE , BROWSER_OBJECT_EXPORT_SPRITE , BROWSER_OBJECT_SAVE_URL_URI , BROWSER_OBJECT_SAVE_URL_URL , BROWSER_OBJECT_SAVE_URL_TEXT , BROWSER_SAVE , BROWSER_SAVE_COMPLETE , BROWSER_EXPORT_DRAW , BROWSER_EXPORT_TEXT , BROWSER_SAVE_URL_URI , BROWSER_SAVE_URL_URL , BROWSER_SAVE_URL_TEXT , HOTLIST_EXPORT , HISTORY_EXPORT , BROWSER_NAVIGATE_HOME , BROWSER_NAVIGATE_BACK , BROWSER_NAVIGATE_FORWARD , BROWSER_NAVIGATE_UP , BROWSER_NAVIGATE_RELOAD , BROWSER_NAVIGATE_RELOAD_ALL , BROWSER_NAVIGATE_STOP , BROWSER_NAVIGATE_URL , BROWSER_SCALE_VIEW , BROWSER_FIND_TEXT , BROWSER_IMAGES_FOREGROUND , BROWSER_IMAGES_BACKGROUND , BROWSER_BUFFER_ANIMS , BROWSER_BUFFER_ALL , BROWSER_SAVE_VIEW , BROWSER_WINDOW_DEFAULT , BROWSER_WINDOW_STAGGER , BROWSER_WINDOW_COPY , BROWSER_WINDOW_RESET , TREE_NEW_FOLDER , TREE_NEW_LINK , TREE_EXPAND_ALL , TREE_EXPAND_FOLDERS , TREE_EXPAND_LINKS , TREE_COLLAPSE_ALL , TREE_COLLAPSE_FOLDERS , TREE_COLLAPSE_LINKS , TREE_SELECTION , TREE_SELECTION_EDIT , TREE_SELECTION_LAUNCH , TREE_SELECTION_DELETE , TREE_SELECT_ALL , TREE_CLEAR_SELECTION , TOOLBAR_BUTTONS , TOOLBAR_ADDRESS_BAR , TOOLBAR_THROBBER , TOOLBAR_EDIT , CHOICES_SHOW , APPLICATION_QUIT , NO_ACTION , HELP_OPEN_CONTENTS , HELP_OPEN_GUIDE , HELP_OPEN_INFORMATION , HELP_OPEN_CREDITS , HELP_OPEN_LICENCE , HELP_LAUNCH_INTERACTIVE , HISTORY_SHOW_LOCAL , HISTORY_SHOW_GLOBAL , HOTLIST_ADD_URL , HOTLIST_SHOW , COOKIES_SHOW , COOKIES_DELETE , BROWSER_PAGE , BROWSER_PAGE_INFO , BROWSER_PRINT , BROWSER_NEW_WINDOW , BROWSER_VIEW_SOURCE , BROWSER_OBJECT , BROWSER_OBJECT_OBJECT , BROWSER_OBJECT_LINK , BROWSER_OBJECT_INFO , BROWSER_OBJECT_PRINT , BROWSER_OBJECT_RELOAD , BROWSER_LINK_SAVE , BROWSER_LINK_DOWNLOAD , BROWSER_LINK_NEW_WINDOW , BROWSER_OBJECT_SAVE , BROWSER_OBJECT_EXPORT , BROWSER_OBJECT_EXPORT_SPRITE , BROWSER_OBJECT_EXPORT_DRAW , BROWSER_OBJECT_SAVE_URL_URI , BROWSER_OBJECT_SAVE_URL_URL , BROWSER_OBJECT_SAVE_URL_TEXT , BROWSER_SAVE , BROWSER_SAVE_COMPLETE , BROWSER_EXPORT_DRAW , BROWSER_EXPORT_PDF , BROWSER_EXPORT_TEXT , BROWSER_SAVE_URL_URI , BROWSER_SAVE_URL_URL , BROWSER_SAVE_URL_TEXT , BROWSER_LINK_SAVE_URI , BROWSER_LINK_SAVE_URL , BROWSER_LINK_SAVE_TEXT , HOTLIST_EXPORT , HISTORY_EXPORT , BROWSER_SELECTION , BROWSER_SELECTION_SAVE , BROWSER_SELECTION_COPY , BROWSER_SELECTION_CUT , BROWSER_SELECTION_PASTE , BROWSER_SELECTION_CLEAR , BROWSER_SELECTION_ALL , BROWSER_NAVIGATE_HOME , BROWSER_NAVIGATE_BACK , BROWSER_NAVIGATE_FORWARD , BROWSER_NAVIGATE_UP , BROWSER_NAVIGATE_RELOAD , BROWSER_NAVIGATE_RELOAD_ALL , BROWSER_NAVIGATE_STOP , BROWSER_NAVIGATE_URL , BROWSER_SCALE_VIEW , BROWSER_FIND_TEXT , BROWSER_IMAGES_FOREGROUND , BROWSER_IMAGES_BACKGROUND , BROWSER_BUFFER_ANIMS , BROWSER_BUFFER_ALL , BROWSER_SAVE_VIEW , BROWSER_WINDOW_DEFAULT , BROWSER_WINDOW_STAGGER , BROWSER_WINDOW_COPY , BROWSER_WINDOW_RESET , TREE_NEW_FOLDER , TREE_NEW_LINK , TREE_EXPAND_ALL , TREE_EXPAND_FOLDERS , TREE_EXPAND_LINKS , TREE_COLLAPSE_ALL , TREE_COLLAPSE_FOLDERS , TREE_COLLAPSE_LINKS , TREE_SELECTION , TREE_SELECTION_EDIT , TREE_SELECTION_LAUNCH , TREE_SELECTION_DELETE , TREE_SELECT_ALL , TREE_CLEAR_SELECTION , TOOLBAR_BUTTONS , TOOLBAR_ADDRESS_BAR , TOOLBAR_THROBBER , TOOLBAR_EDIT , CHOICES_SHOW , APPLICATION_QUIT }

Functions
void	ro_gui_menu_init (void)
	Create menu structures. More...

void	ro_gui_menu_create (wimp_menu *menu, int x, int y, wimp_w w)
	Display a menu. More...

void	ro_gui_menu_destroy (void)
	Forcibly close any menu or transient dialogue box that is currently open. More...

void	ro_gui_popup_menu (wimp_menu *menu, wimp_w w, wimp_i i)
	Display a pop-up menu next to the specified icon. More...

void	ro_gui_menu_window_changed (wimp_w from, wimp_w to)
	Allow the current menu window to change, if the window is deleted and recreated while a menu is active on an Adjust-click. More...

void	ro_gui_menu_selection (wimp_selection *selection)
	Handle menu selection. More...

void	ro_gui_menu_warning (wimp_message_menu_warning *warning)
	Handle Message_MenuWarning. More...

void	ro_gui_menu_message_deleted (wimp_message_menus_deleted *deleted)
	Handle Message_MenusDeleted, removing our current record of an open menu if it matches the deleted menu handle. More...

void	ro_gui_menu_refresh (wimp_menu *menu)
	Update the current menu by sending it a Menu Prepare event through wimp_event and then reopening it if the contents has changed. More...

void	ro_gui_menu_init_structure (wimp_menu *menu, int entries)
	Initialise the basic state of a menu structure so all entries are indirected text with no flags, no submenu. More...

const char *	ro_gui_menu_find_menu_entry_key (wimp_menu menu, const char translated)
	Finds the key associated with a menu entry translation. More...

wimp_menu *	ro_gui_menu_define_menu (const struct ns_menu *menu)
	Creates a wimp_menu and adds it to the list to handle actions for. More...

void	ro_gui_menu_set_entry_shaded (wimp_menu *menu, menu_action action, bool shaded)
	Sets an action within a menu as having a specific ticked status. More...

void	ro_gui_menu_set_entry_ticked (wimp_menu *menu, menu_action action, bool ticked)
	Sets an action within a menu as having a specific ticked status. More...

Variables
wimp_menu *	image_quality_menu
	The available menus. More...

wimp_menu *	proxy_type_menu

wimp_menu *	languages_menu

wimp_menu *	current_menu
	The current menu being worked with (may not be open) More...

Enumeration Type Documentation

◆ menu_action

enum menu_action

Enumerator
NO_ACTION
HELP_OPEN_CONTENTS
HELP_OPEN_GUIDE
HELP_OPEN_INFORMATION
HELP_OPEN_ABOUT
HELP_OPEN_LICENCE
HELP_LAUNCH_INTERACTIVE
HISTORY_SHOW_LOCAL
HISTORY_SHOW_GLOBAL
HOTLIST_ADD_URL
HOTLIST_SHOW
COOKIES_SHOW
COOKIES_DELETE
BROWSER_PAGE
BROWSER_PAGE_INFO
BROWSER_PRINT
BROWSER_NEW_WINDOW
BROWSER_VIEW_SOURCE
BROWSER_OBJECT
BROWSER_OBJECT_INFO
BROWSER_OBJECT_RELOAD
BROWSER_OBJECT_SAVE
BROWSER_OBJECT_EXPORT_SPRITE
BROWSER_OBJECT_SAVE_URL_URI
BROWSER_OBJECT_SAVE_URL_URL
BROWSER_OBJECT_SAVE_URL_TEXT
BROWSER_SAVE
BROWSER_SAVE_COMPLETE
BROWSER_EXPORT_DRAW
BROWSER_EXPORT_TEXT
BROWSER_SAVE_URL_URI
BROWSER_SAVE_URL_URL
BROWSER_SAVE_URL_TEXT
HOTLIST_EXPORT
HISTORY_EXPORT
BROWSER_NAVIGATE_HOME
BROWSER_NAVIGATE_BACK
BROWSER_NAVIGATE_FORWARD
BROWSER_NAVIGATE_UP
BROWSER_NAVIGATE_RELOAD
BROWSER_NAVIGATE_RELOAD_ALL
BROWSER_NAVIGATE_STOP
BROWSER_NAVIGATE_URL
BROWSER_SCALE_VIEW
BROWSER_FIND_TEXT
BROWSER_IMAGES_FOREGROUND
BROWSER_IMAGES_BACKGROUND
BROWSER_BUFFER_ANIMS
BROWSER_BUFFER_ALL
BROWSER_SAVE_VIEW
BROWSER_WINDOW_DEFAULT
BROWSER_WINDOW_STAGGER
BROWSER_WINDOW_COPY
BROWSER_WINDOW_RESET
TREE_NEW_FOLDER
TREE_NEW_LINK
TREE_EXPAND_ALL
TREE_EXPAND_FOLDERS
TREE_EXPAND_LINKS
TREE_COLLAPSE_ALL
TREE_COLLAPSE_FOLDERS
TREE_COLLAPSE_LINKS
TREE_SELECTION
TREE_SELECTION_EDIT
TREE_SELECTION_LAUNCH
TREE_SELECTION_DELETE
TREE_SELECT_ALL
TREE_CLEAR_SELECTION
TOOLBAR_BUTTONS
TOOLBAR_ADDRESS_BAR
TOOLBAR_THROBBER
TOOLBAR_EDIT
CHOICES_SHOW
APPLICATION_QUIT
NO_ACTION
HELP_OPEN_CONTENTS
HELP_OPEN_GUIDE
HELP_OPEN_INFORMATION
HELP_OPEN_CREDITS
HELP_OPEN_LICENCE
HELP_LAUNCH_INTERACTIVE
HISTORY_SHOW_LOCAL
HISTORY_SHOW_GLOBAL
HOTLIST_ADD_URL
HOTLIST_SHOW
COOKIES_SHOW
COOKIES_DELETE
BROWSER_PAGE
BROWSER_PAGE_INFO
BROWSER_PRINT
BROWSER_NEW_WINDOW
BROWSER_VIEW_SOURCE
BROWSER_OBJECT
BROWSER_OBJECT_OBJECT
BROWSER_OBJECT_LINK
BROWSER_OBJECT_INFO
BROWSER_OBJECT_PRINT
BROWSER_OBJECT_RELOAD
BROWSER_LINK_SAVE
BROWSER_LINK_DOWNLOAD
BROWSER_LINK_NEW_WINDOW
BROWSER_OBJECT_SAVE
BROWSER_OBJECT_EXPORT
BROWSER_OBJECT_EXPORT_SPRITE
BROWSER_OBJECT_EXPORT_DRAW
BROWSER_OBJECT_SAVE_URL_URI
BROWSER_OBJECT_SAVE_URL_URL
BROWSER_OBJECT_SAVE_URL_TEXT
BROWSER_SAVE
BROWSER_SAVE_COMPLETE
BROWSER_EXPORT_DRAW
BROWSER_EXPORT_PDF
BROWSER_EXPORT_TEXT
BROWSER_SAVE_URL_URI
BROWSER_SAVE_URL_URL
BROWSER_SAVE_URL_TEXT
BROWSER_LINK_SAVE_URI
BROWSER_LINK_SAVE_URL
BROWSER_LINK_SAVE_TEXT
HOTLIST_EXPORT
HISTORY_EXPORT
BROWSER_SELECTION
BROWSER_SELECTION_SAVE
BROWSER_SELECTION_COPY
BROWSER_SELECTION_CUT
BROWSER_SELECTION_PASTE
BROWSER_SELECTION_CLEAR
BROWSER_SELECTION_ALL
BROWSER_NAVIGATE_HOME
BROWSER_NAVIGATE_BACK
BROWSER_NAVIGATE_FORWARD
BROWSER_NAVIGATE_UP
BROWSER_NAVIGATE_RELOAD
BROWSER_NAVIGATE_RELOAD_ALL
BROWSER_NAVIGATE_STOP
BROWSER_NAVIGATE_URL
BROWSER_SCALE_VIEW
BROWSER_FIND_TEXT
BROWSER_IMAGES_FOREGROUND
BROWSER_IMAGES_BACKGROUND
BROWSER_BUFFER_ANIMS
BROWSER_BUFFER_ALL
BROWSER_SAVE_VIEW
BROWSER_WINDOW_DEFAULT
BROWSER_WINDOW_STAGGER
BROWSER_WINDOW_COPY
BROWSER_WINDOW_RESET
TREE_NEW_FOLDER
TREE_NEW_LINK
TREE_EXPAND_ALL
TREE_EXPAND_FOLDERS
TREE_EXPAND_LINKS
TREE_COLLAPSE_ALL
TREE_COLLAPSE_FOLDERS
TREE_COLLAPSE_LINKS
TREE_SELECTION
TREE_SELECTION_EDIT
TREE_SELECTION_LAUNCH
TREE_SELECTION_DELETE
TREE_SELECT_ALL
TREE_CLEAR_SELECTION
TOOLBAR_BUTTONS
TOOLBAR_ADDRESS_BAR
TOOLBAR_THROBBER
TOOLBAR_EDIT
CHOICES_SHOW
APPLICATION_QUIT

Definition at line 26 of file menus.h.

Function Documentation

◆ ro_gui_menu_create()

void ro_gui_menu_create	(	wimp_menu *	menu,
		int	x,
		int	y,
		wimp_w	w
	)

Display a menu.

Parameters

*menu	Pointer to the menu to be displayed.
x	The x position.
y	The y position.
w	The window that the menu belongs to.

Definition at line 211 of file menus.c.

References current_menu, current_menu_icon, current_menu_open, current_menu_window, menu_definition::menu, NSLOG, ro_gui_menu_closed(), ro_gui_menu_find_menu(), ro_gui_menu_translate(), and ro_warn_user().

Referenced by gui_window_create_form_select_menu(), ro_gui_menu_selection(), ro_gui_popup_menu(), and ro_gui_wimp_event_process_window_menu_click().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ro_gui_menu_define_menu()

wimp_menu * ro_gui_menu_define_menu ( const struct ns_menu * menu )

Creates a wimp_menu and adds it to the list to handle actions for.

Parameters

menu	The data to create the menu with

Returns: The menu created, or NULL on failure

Definition at line 510 of file menus.c.

References die(), menu_definition::menu, menu_definition::next, ro_gui_menu_define_menu_add(), ro_gui_menu_definitions, and ro_gui_menu_translate().

Referenced by ro_cookie_init(), ro_global_history_init(), ro_gui_iconbar_initialise(), ro_gui_menu_init(), ro_gui_window_initialise(), ro_hotlist_init(), and ro_toolbar_init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ro_gui_menu_destroy()

void ro_gui_menu_destroy ( void )

Forcibly close any menu or transient dialogue box that is currently open.

Definition at line 288 of file menus.c.

References current_menu, NSLOG, ro_gui_menu_closed(), and ro_warn_user().

Referenced by gui_window_create_form_select_menu(), gui_window_destroy(), ro_gui_wimp_event_keypress(), ro_gui_wimp_event_mouse_click(), ro_gui_wimp_event_ok_click(), ro_gui_window_prepare_form_select_menu(), and ro_print_cleanup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ro_gui_menu_find_menu_entry_key()

const char * ro_gui_menu_find_menu_entry_key	(	wimp_menu *	menu,
		const char *	translated
	)

Finds the key associated with a menu entry translation.

Parameters

menu	the menu to search
translated	the translated text

Returns: the original message key, or NULL if one could not be found

Definition at line 735 of file menus.c.

References menu_definition::entries, menu_definition_entry::entry_key, menu_definition::menu, menu_definition_entry::menu_entry, menu_definition_entry::next, and ro_gui_menu_find_menu().

Referenced by ro_gui_options_language_ok().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ro_gui_menu_init()

void ro_gui_menu_init ( void )

Create menu structures.

Definition at line 116 of file menus.c.

References image_quality_menu, languages_menu, NO_ACTION, proxy_type_menu, ro_gui_menu_define_menu(), and ro_gui_url_suggest_init().

Referenced by gui_init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ro_gui_menu_init_structure()

void ro_gui_menu_init_structure	(	wimp_menu *	menu,
		int	entries
	)

Initialise the basic state of a menu structure so all entries are indirected text with no flags, no submenu.

Definition at line 682 of file menus.c.

References DEFAULT_FLAGS.

Referenced by ro_gui_menu_define_menu_add(), ro_gui_options_fonts_init_menu(), ro_gui_search_init(), ro_gui_window_prepare_form_select_menu(), and wimp_MENU().

Here is the caller graph for this function:

◆ ro_gui_menu_message_deleted()

void ro_gui_menu_message_deleted ( wimp_message_menus_deleted * deleted )

Handle Message_MenusDeleted, removing our current record of an open menu if it matches the deleted menu handle.

Parameters

*deleted The message block.

Definition at line 442 of file menus.c.

References current_menu, and ro_gui_menu_closed().

Referenced by ro_gui_user_message().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ro_gui_menu_refresh()

void ro_gui_menu_refresh ( wimp_menu * menu )

Update the current menu by sending it a Menu Prepare event through wimp_event and then reopening it if the contents has changed.

Parameters

*menu The menu to refresh: if 0, the current menu will be refreshed regardless, otherwise it will be refreshed only if it matches the supplied handle.

Definition at line 475 of file menus.c.

References current_menu, current_menu_icon, current_menu_open, current_menu_window, NSLOG, ro_gui_menu_get_checksum(), ro_gui_wimp_event_prepare_menu(), and ro_warn_user().

Referenced by gui_window_new_content(), gui_window_start_throbber(), and gui_window_stop_throbber().

Here is the call graph for this function:

Here is the caller graph for this function: