AW_advice.cxx File Reference

#include "aw_advice.hxx"
#include "aw_window.hxx"
#include "aw_awar.hxx"
#include "aw_msg.hxx"
#include "aw_root.hxx"
#include <arbdb.h>

Include dependency graph for AW_advice.cxx:

Go to the source code of this file.

Macros
#define	AWAR_ADVICE_TMP   "/tmp/advices/"
#define	AWAR_ADVICE_TEXT   AWAR_ADVICE_TMP "text"
#define	AWAR_ADVICE_UNDERSTOOD   AWAR_ADVICE_TMP "understood"
#define	AWAR_ADVICE_DISABLED   "/advices/disabled"
#define	AWAR_ADVICE_SHOWN   "/tmp/advices/shown"

Functions
void	init_Advisor (AW_root *awr)
	has to be called one time (before calling AW_advice) More...
AW_awar *	get_disabled_advices ()
AW_awar *	get_shown_advices ()
int	advice_id_offset (const char *id, const char *idlist)
bool	advice_id_is_set (const char *id, const char *idlist)
void	set_advice_id (const char *id, AW_awar *var)
void	remove_advice_id (const char *id, AW_awar *var)
void	toggle_advice_id (const char *id, AW_awar *var)
bool	advice_disabled (const char *id)
void	disable_advice (const char *id)
bool	advice_currently_shown (const char *id)
void	toggle_advice_shown (const char *id)
static void	advice_close_cb (AW_window *aww, const char *id, AW_Advice_Type type)
static void	advice_hide_and_close_cb (AW_window *aww, const char *id, AW_Advice_Type type)
void	AW_reactivate_all_advices (AW_window *)
	reactivates all advices which were disabled by the user More...
void	AW_advice (const char *message, AW_Advice_Type type, const char *title, const char *corresponding_help)
	Show a message box with an advice for the user. More...

Variables
static bool	initialized = false
static AW_root *	advice_root = NULp

Macro Definition Documentation

#define AWAR_ADVICE_TMP   "/tmp/advices/"

Definition at line 25 of file AW_advice.cxx.

#define AWAR_ADVICE_TEXT   AWAR_ADVICE_TMP "text"

Definition at line 27 of file AW_advice.cxx.

Referenced by AW_advice(), and init_Advisor().

#define AWAR_ADVICE_UNDERSTOOD   AWAR_ADVICE_TMP "understood"

Definition at line 28 of file AW_advice.cxx.

Referenced by advice_close_cb(), advice_hide_and_close_cb(), AW_advice(), and init_Advisor().

#define AWAR_ADVICE_DISABLED   "/advices/disabled"

Definition at line 30 of file AW_advice.cxx.

Referenced by get_disabled_advices().

#define AWAR_ADVICE_SHOWN   "/tmp/advices/shown"

Definition at line 31 of file AW_advice.cxx.

Referenced by get_shown_advices().

Function Documentation

void init_Advisor

(

AW_root *

awr

)

has to be called one time (before calling AW_advice)

Definition at line 41 of file AW_advice.cxx.

References AWAR_ADVICE_TEXT, AWAR_ADVICE_UNDERSTOOD, AW_root::awar_int(), AW_root::awar_string(), and initialized.

Referenced by AWT_create_root().

AW_awar* get_disabled_advices ( )

inline

Definition at line 55 of file AW_advice.cxx.

References AWAR_ADVICE_DISABLED, and AW_root::awar_string().

Referenced by advice_disabled(), AW_reactivate_all_advices(), and disable_advice().

AW_awar* get_shown_advices ( )

inline

Definition at line 56 of file AW_advice.cxx.

References AWAR_ADVICE_SHOWN, and AW_root::awar_string().

Referenced by advice_currently_shown(), and toggle_advice_shown().

int advice_id_offset ( const char *  id, const char *  idlist  )

inline

Definition at line 58 of file AW_advice.cxx.

References GBS_global_string().

Referenced by advice_id_is_set(), and remove_advice_id().

bool advice_id_is_set ( const char *  id, const char *  idlist  )

inline

Definition at line 63 of file AW_advice.cxx.

References advice_id_offset().

Referenced by advice_currently_shown(), advice_disabled(), remove_advice_id(), set_advice_id(), and toggle_advice_id().

void set_advice_id ( const char *  id, AW_awar *  var  )

inline

Definition at line 65 of file AW_advice.cxx.

References advice_id_is_set(), GBS_global_string(), AW_awar::read_char_pntr(), and AW_awar::write_string().

Referenced by disable_advice(), and toggle_advice_id().

void remove_advice_id ( const char *  id, AW_awar *  var  )

inline

Definition at line 72 of file AW_advice.cxx.

References advice_id_is_set(), advice_id_offset(), NULp, offset, AW_awar::read_char_pntr(), and AW_awar::write_string().

Referenced by toggle_advice_id().

void toggle_advice_id ( const char *  id, AW_awar *  var  )

inline

Definition at line 91 of file AW_advice.cxx.

References advice_id_is_set(), AW_awar::read_char_pntr(), remove_advice_id(), and set_advice_id().

Referenced by toggle_advice_shown().

bool advice_disabled ( const char *  id )

inline

Definition at line 100 of file AW_advice.cxx.

References advice_id_is_set(), and get_disabled_advices().

Referenced by AW_advice().

void disable_advice ( const char *  id )

inline

Definition at line 101 of file AW_advice.cxx.

References get_disabled_advices(), and set_advice_id().

Referenced by advice_close_cb().

bool advice_currently_shown ( const char *  id )

inline

Definition at line 103 of file AW_advice.cxx.

References advice_id_is_set(), and get_shown_advices().

Referenced by AW_advice().

void toggle_advice_shown ( const char *  id )

inline

Definition at line 104 of file AW_advice.cxx.

References get_shown_advices(), and toggle_advice_id().

Referenced by advice_close_cb(), and AW_advice().

static void advice_close_cb ( AW_window *  aww, const char *  id, AW_Advice_Type  type  )

static

Definition at line 108 of file AW_advice.cxx.

References AW_advice(), AW_ADVICE_TOGGLE, AW_root::awar(), AWAR_ADVICE_UNDERSTOOD, disable_advice(), AW_window::hide(), AW_awar::read_int(), toggle_advice_shown(), and AW_awar::write_int().

Referenced by advice_hide_and_close_cb(), and AW_advice().

static void advice_hide_and_close_cb ( AW_window *  aww, const char *  id, AW_Advice_Type  type  )

static

Definition at line 130 of file AW_advice.cxx.

References advice_close_cb(), AW_root::awar(), AWAR_ADVICE_UNDERSTOOD, and AW_awar::write_int().

Referenced by AW_advice().

void AW_reactivate_all_advices

(

AW_window *

)

reactivates all advices which were disabled by the user

Definition at line 137 of file AW_advice.cxx.

References aw_assert, aw_message(), GBS_global_string(), GBS_string_eval(), get_disabled_advices(), AW_awar::read_string(), and AW_awar::write_string().

Referenced by add_common_property_menu_entries().

void AW_advice	(	const char *	message,
		AW_Advice_Type	type = AW_ADVICE_SIMPLE,
		const char *	title = NULp,
		const char *	corresponding_help = NULp
	)

Show a message box with an advice for the user.

Parameters

message	the text shown to the user
title	window title
type	type of advice
corresponding_help	name of corresponding ARB-helpfile

See also

init_Advisor

Definition at line 160 of file AW_advice.cxx.

References advice_close_cb(), advice_currently_shown(), advice_disabled(), advice_hide_and_close_cb(), AW_ADVICE_HELP, AW_ADVICE_HELP_POPUP, AW_ADVICE_TOGGLE, aw_assert, AW_help_popup(), AW_root::awar(), AWAR_ADVICE_TEXT, AWAR_ADVICE_UNDERSTOOD, GB_checksum(), GBS_global_string(), GBS_global_string_copy(), initialized, makeHelpCallback(), NULp, toggle_advice_shown(), AW_awar::write_int(), and AW_awar::write_string().

Referenced by addid_changed_cb(), advice_close_cb(), aw_question(), color_group_name_changed_cb(), QUERY::copy_selection_list_2_query_box(), ArbImporter::detect_format(), ED4_Edit_String::edit(), NT_move_boot_branch(), popup_new_main_window(), QUERY::search_duplicated_field_content(), and warn_compression_type().

Variable Documentation

bool initialized = false

static

Definition at line 36 of file AW_advice.cxx.

Referenced by AW_advice(), aw_root_init_font(), CalculateRotationMatrix(), create_tester_awars(), ED4_SearchResults::ED4_SearchResults(), gb_make_main_idx(), GB_TYPES_2_name(), getStipplePixmap(), init_Advisor(), init_flag_awars(), init_itemspecific_DBUI_awars(), initXferAwars(), map_viewkeys(), mg_initialize_SAI_selectors(), mg_initialize_species_selectors(), MP_Window::MP_Window(), BaseFrequencies::setup(), SQ_GroupData::SQ_GroupData(), startup_dbserver(), and TTIT_embl2arb().

AW_root* advice_root = NULp

static

Definition at line 37 of file AW_advice.cxx.