ui.h File Reference

#include "misc.h"
#include "ui_tcltk.h"

Include dependency graph for ui.h:

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

Go to the source code of this file.

Classes
class	UI_List
	An heterogeneous container used to pass a list of values from c++ to UI. More...

Functions
UI_res_t	str_is_prefix (UI_extra_t, UI_handle_t, int argc, const char **argv)
	sc_*() - Execute server side operations Each function usually have subcommands. More...
UI_res_t	str_prefix_len (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_base (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_book (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_clipbase (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_eco (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_filter (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_game (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_info (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_move (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_name (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_report (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_pos (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_search (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_tree (UI_extra_t, UI_handle_t, int argc, const char **argv)
UI_res_t	sc_var (UI_extra_t, UI_handle_t, int argc, const char **argv)
int	UI_Main (int argc, char *argv[], void(*exit)(void *))
	UI_Main() - Init the UI. More...
Progress	UI_CreateProgress (UI_handle_t ti)
	UI_CreateProgress() - create a Progress object. More...
Progress	UI_CreateProgressPosMask (UI_handle_t ti)
UI_res_t	UI_Result (UI_handle_t ti, errorT res)
	UI_Result() - pass the result of an operation from c++ to UI. More...
template<typename T >
UI_res_t	UI_Result (UI_handle_t ti, errorT res, const T &value)

Function Documentation

sc_base()

UI_res_t sc_base	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

Definition at line 913 of file sc_base.cpp.

sc_book()

UI_res_t sc_book	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_clipbase()

UI_res_t sc_clipbase	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_eco()

UI_res_t sc_eco	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_filter()

UI_res_t sc_filter	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

Definition at line 165 of file sc_filter.cpp.

sc_game()

UI_res_t sc_game	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_info()

UI_res_t sc_info	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_move()

UI_res_t sc_move	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_name()

UI_res_t sc_name	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

Definition at line 7426 of file tkscid.cpp.

sc_pos()

UI_res_t sc_pos	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_report()

UI_res_t sc_report	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_search()

UI_res_t sc_search	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_tree()

UI_res_t sc_tree	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_var()

UI_res_t sc_var	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

str_is_prefix()

UI_res_t str_is_prefix	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

sc_*() - Execute server side operations Each function usually have subcommands.

See functions implemenations for more usage info.

str_prefix_len()

UI_res_t str_prefix_len	(	UI_extra_t	,
		UI_handle_t	,
		int	argc,
		const char **	argv
	)

UI_CreateProgress()

Progress UI_CreateProgress ( UI_handle_t  ti )

inline

UI_CreateProgress() - create a Progress object.

With this function c++ code contact the UI to report that the operation asked may take a long time. Then c++ code call Progress::report repeatedly to inform the UI about the percentage of work done and an estimated time to complete the operation. Progress::report will return false if the UI wants to interrupt the operation

Return: a Progress object that represent the server->UI async communication, or an empty Progress() if the UI is not interested in the progress report.

Definition at line 122 of file ui.h.

UI_CreateProgressPosMask()

Progress UI_CreateProgressPosMask ( UI_handle_t  ti )

inline

Definition at line 125 of file ui.h.

UI_Main()

int UI_Main ( int  argc, char *  argv[], void(*)(void *)  exit  )

inline

UI_Main() - Init the UI.

Parameters

exit	clean up function to be called when closing UI

Definition at line 104 of file ui.h.

UI_Result() [1/2]

UI_res_t UI_Result ( UI_handle_t  ti, errorT  res  )

inline

UI_Result() - pass the result of an operation from c++ to UI.

Parameters

res	OK for success or an error code (error.h)
value	a value (or a list of values, see UI_List) to pass to the UI

Typical usage: UI_Result(ti, OK); UI_Result(ti, OK, "string value"); UI_Result(ti, OK, 5);

Definition at line 140 of file ui.h.

UI_Result() [2/2]

template<typename T >

UI_res_t UI_Result ( UI_handle_t  ti, errorT  res, const T &  value  )

inline

Definition at line 144 of file ui.h.