help.c File Reference

Interactive help (implementation). More...

#include <oslib/wimp.h>
#include <oslib/help.h>
#include <oslib/taskmanager.h>
#include "utils/nsoption.h"
#include "utils/log.h"
#include "utils/messages.h"
#include "utils/utf8.h"
#include "netsurf/mouse.h"
#include "netsurf/window.h"
#include "riscos/help.h"
#include "riscos/wimp_event.h"
#include "riscos/hotlist.h"
#include "riscos/global_history.h"
#include "riscos/cookies.h"
#include "riscos/wimp.h"
#include "riscos/iconbar.h"
#include "riscos/window.h"
#include "riscos/ucstables.h"
#include "riscos/gui.h"

Include dependency graph for help.c:

Go to the source code of this file.

Functions
static void	ro_gui_interactive_help_broadcast (wimp_message *message, char *token)
	Broadcasts a help reply. More...
void	ro_gui_interactive_help_request (wimp_message *message)
	Attempts to process an interactive help message request. More...
bool	ro_gui_interactive_help_available (void)
	Checks if interactive help is running. More...
void	ro_gui_interactive_help_start (void)
	Launches interactive help. More...

Variables
static os_t	help_time = 0

Detailed Description

Interactive help (implementation).

Definition in file help.c.

Function Documentation

ro_gui_interactive_help_available()

bool ro_gui_interactive_help_available

(

void

)

Checks if interactive help is running.

Returns

non-zero if interactive help is available, or 0 if not available

Definition at line 285 of file help.c.

References help_time, NSLOG, and ro_warn_user().

Referenced by ro_gui_interactive_help_start(), ro_gui_window_menu_prepare(), and ro_gui_window_menu_select().

Here is the call graph for this function:

Here is the caller graph for this function:

ro_gui_interactive_help_broadcast()

static void ro_gui_interactive_help_broadcast ( wimp_message *  message, char *  token  )

static

Broadcasts a help reply.

Parameters

message	the original request message
token	the token to look up

Definition at line 217 of file help.c.

References messages_get(), NSERROR_BAD_ENCODING, NSERROR_OK, NSLOG, ro_warn_user(), and utf8_to_local_encoding().

Referenced by ro_gui_interactive_help_request().

Here is the call graph for this function:

Here is the caller graph for this function:

ro_gui_interactive_help_request()

void ro_gui_interactive_help_request

(

wimp_message *

message

)

Attempts to process an interactive help message request.

Parameters

message

the request message

Definition at line 89 of file help.c.

References current_menu, help_time, NSLOG, nsoption_bool, ro_gui_cookies_check_menu(), ro_gui_cookies_check_window(), ro_gui_get_icon_shaded_state(), ro_gui_global_history_check_menu(), ro_gui_global_history_check_window(), ro_gui_hotlist_check_menu(), ro_gui_hotlist_check_window(), ro_gui_iconbar_check_menu(), ro_gui_interactive_help_broadcast(), ro_gui_wimp_event_get_help_prefix(), ro_gui_wimp_event_get_help_suffix(), ro_gui_window_check_menu(), ro_gui_window_lookup(), and ro_warn_user().

Referenced by gui_init().

Here is the call graph for this function:

Here is the caller graph for this function:

ro_gui_interactive_help_start()

void ro_gui_interactive_help_start

(

void

)

Launches interactive help.

Definition at line 327 of file help.c.

References help_time, NSLOG, ro_gui_interactive_help_available(), and ro_warn_user().

Referenced by ro_gui_window_menu_select().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

help_time

os_t help_time = 0

static

Definition at line 81 of file help.c.

Referenced by ro_gui_interactive_help_available(), ro_gui_interactive_help_request(), and ro_gui_interactive_help_start().