NetSurf
Macros | Functions
hotlist.h File Reference

Hotlist (interface). More...

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

Go to the source code of this file.

Macros

#define message_HOTLIST_ADD_URL   0x4af81
 
#define message_HOTLIST_CHANGED   0x4af82
 

Functions

void ro_gui_hotlist_initialise (void)
 initialise the hotlist window template ready for subsequent use. More...
 
nserror ro_gui_hotlist_present (void)
 make the cookie window visible. More...
 
nserror ro_gui_hotlist_finalise (void)
 Free any resources allocated for the cookie window. More...
 
bool ro_gui_hotlist_check_window (wimp_w window)
 
bool ro_gui_hotlist_check_menu (wimp_menu *menu)
 
void ro_gui_hotlist_add_page (struct nsurl *url)
 Add a URL to the hotlist. More...
 
void ro_gui_hotlist_add_cleanup (void)
 Clean up RMA storage used by the Message_HotlistAddURL protocol. More...
 
void ro_gui_hotlist_remove_page (struct nsurl *url)
 Remove a URL from the hotlist. More...
 
bool ro_gui_hotlist_has_page (struct nsurl *url)
 Report whether the hotlist contains a given URL. More...
 

Detailed Description

Hotlist (interface).

Definition in file hotlist.h.

Macro Definition Documentation

◆ message_HOTLIST_ADD_URL

#define message_HOTLIST_ADD_URL   0x4af81

Definition at line 30 of file hotlist.h.

◆ message_HOTLIST_CHANGED

#define message_HOTLIST_CHANGED   0x4af82

Definition at line 34 of file hotlist.h.

Function Documentation

◆ ro_gui_hotlist_add_cleanup()

void ro_gui_hotlist_add_cleanup ( void  )

Clean up RMA storage used by the Message_HotlistAddURL protocol.

Definition at line 731 of file hotlist.c.

References hotlist_title, and hotlist_url.

Referenced by ro_gui_hotlist_add_page(), ro_gui_hotlist_addurl_bounce(), ro_gui_hotlist_scheduled_callback(), and ro_gui_user_message().

Here is the caller graph for this function:

◆ ro_gui_hotlist_add_page()

void ro_gui_hotlist_add_page ( struct nsurl url)

Add a URL to the hotlist.

This will be passed on to the core hotlist, then Message_HotlistAddURL will broadcast to any bookmark applications via the Hotlist Protocol.

Parameters
*urlThe URL to be added.

Definition at line 668 of file hotlist.c.

References ro_hotlist_message_hotlist_addurl::appname, hotlist_add_url(), hotlist_title, hotlist_url, message_HOTLIST_ADD_URL, nsoption_bool, nsurl_access(), nsurl_length(), riscos_schedule(), ro_gui_hotlist_add_cleanup(), ro_gui_hotlist_addurl_bounce(), ro_gui_hotlist_scheduled_callback(), ro_message_send_message(), ro_hotlist_message_hotlist_addurl::title, url_data::title, ro_hotlist_message_hotlist_addurl::url, and urldb_get_url_data().

Referenced by ro_gui_window_action_add_bookmark().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ro_gui_hotlist_check_menu()

bool ro_gui_hotlist_check_menu ( wimp_menu *  menu)

Definition at line 619 of file hotlist.c.

References hotlist_window, and ro_hotlist_window::menu.

Referenced by ro_gui_interactive_help_request().

Here is the caller graph for this function:

◆ ro_gui_hotlist_check_window()

bool ro_gui_hotlist_check_window ( wimp_w  window)

Definition at line 608 of file hotlist.c.

References ro_hotlist_window::core, hotlist_window, and ro_corewindow::wh.

Referenced by ro_gui_interactive_help_request().

Here is the caller graph for this function:

◆ ro_gui_hotlist_finalise()

nserror ro_gui_hotlist_finalise ( void  )

Free any resources allocated for the cookie window.

Returns
NSERROR_OK on success else appropriate error code on faliure.

Definition at line 587 of file hotlist.c.

References ro_hotlist_window::core, hotlist_fini(), hotlist_window, NSERROR_OK, and ro_corewindow_fini().

Referenced by gui_quit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ro_gui_hotlist_has_page()

bool ro_gui_hotlist_has_page ( struct nsurl url)

Report whether the hotlist contains a given URL.

This will be passed on to the core hotlist, unless we're configured to use an external hotlist in which case we always report false.

Parameters
urlThe URL to be tested.
Returns
true if the hotlist contains the URL; else false.

Definition at line 827 of file hotlist.c.

References hotlist_has_url(), nsoption_bool, and ro_hotlist_message_hotlist_addurl::url.

Referenced by ro_gui_url_bar_set_url(), ro_gui_url_bar_test_for_text_field_keypress(), and ro_gui_url_bar_update_hotlist().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ro_gui_hotlist_initialise()

void ro_gui_hotlist_initialise ( void  )

initialise the hotlist window template ready for subsequent use.

Definition at line 580 of file hotlist.c.

References dialog_hotlist_template, and ro_gui_dialog_load_template().

Referenced by ro_gui_dialog_init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ro_gui_hotlist_present()

nserror ro_gui_hotlist_present ( void  )

make the cookie window visible.

Returns
NSERROR_OK on success else appropriate error code on faliure.

Definition at line 540 of file hotlist.c.

References ro_hotlist_window::core, hotlist_window, NSERROR_OK, NSLOG, nsoption_bool, nsoption_charp, ro_gui_dialog_open_top(), ro_hotlist_init(), ro_warn_user(), ro_corewindow::toolbar, and ro_corewindow::wh.

Referenced by ro_gui_iconbar_click(), ro_gui_iconbar_menu_select(), ro_gui_window_handle_local_keypress(), ro_gui_window_menu_select(), and ro_gui_window_toolbar_click().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ro_gui_hotlist_remove_page()

void ro_gui_hotlist_remove_page ( struct nsurl url)

Remove a URL from the hotlist.

This will be passed on to the core hotlist, unless we're configured to use external hotlists in which case we ignore it.

Parameters
*urlThe URL to be removed.

Definition at line 790 of file hotlist.c.

References hotlist_delete_url, hotlist_has_url(), hotlist_query, hotlist_remove_url(), messages_get(), nsoption_bool, nsurl_ref(), nsurl_unref(), query_close(), QUERY_INVALID, query_user(), remove_funcs, ro_toolbar_update_all_hotlists(), and ro_hotlist_message_hotlist_addurl::url.

Referenced by ro_gui_window_action_remove_bookmark().

Here is the call graph for this function:
Here is the caller graph for this function: