toggle.h
4.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
* "Software pw3270, desenvolvido com base nos códigos fontes do WC3270 e X3270
* (Paul Mattes Paul.Mattes@usa.net), de emulação de terminal 3270 para acesso a
* aplicativos mainframe. Registro no INPI sob o nome G3270. Registro no INPI sob o nome G3270.
*
* Copyright (C) <2008> <Banco do Brasil S.A.>
*
* Este programa é software livre. Você pode redistribuí-lo e/ou modificá-lo sob
* os termos da GPL v.2 - Licença Pública Geral GNU, conforme publicado pela
* Free Software Foundation.
*
* Este programa é distribuído na expectativa de ser útil, mas SEM QUALQUER
* GARANTIA; sem mesmo a garantia implícita de COMERCIALIZAÇÃO ou de ADEQUAÇÃO
* A QUALQUER PROPÓSITO EM PARTICULAR. Consulte a Licença Pública Geral GNU para
* obter mais detalhes.
*
* Você deve ter recebido uma cópia da Licença Pública Geral GNU junto com este
* programa; se não, escreva para a Free Software Foundation, Inc., 51 Franklin
* St, Fifth Floor, Boston, MA 02110-1301 USA
*
* Este programa está nomeado como - e possui - linhas de código.
*
* Contatos:
*
* perry.werneck@gmail.com (Alexandre Perry de Souza Werneck)
* erico.mendonca@gmail.com (Erico Mascarenhas Mendonça)
*
*/
#ifndef LIB3270_TOGGLE_H_INCLUDED
#define LIB3270_TOGGLE_H_INCLUDED 1
#include <lib3270.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct _lib3270_toggle_entry
{
LIB3270_TOGGLE id; ///< @brief Toggle ID.
const char * name; ///< @brief Toggle name.
const char def; ///< @brief Default value.
const char * key; ///< @brief Default key (or NULL if no default).
const char * icon; ///< @brief Icon name (from https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html)
const char * label; ///< @brief Button label (or NULL).
const char * summary; ///< @brief Short description (or NULL).
const char * description; ///< @brief Toggle description.
} LIB3270_TOGGLE_ENTRY;
/**
* @brief Get the toggle description table.
*
*/
LIB3270_EXPORT const LIB3270_TOGGLE_ENTRY * lib3270_get_toggle_list();
/**
* @brief get toggle state.
*
* @param hSession Session handle.
* @param ix Toggle id.
*
* @return 0 if the toggle is disabled, non zero if enabled.
*
*/
LIB3270_EXPORT unsigned char lib3270_get_toggle(const H3270 *hSession, LIB3270_TOGGLE ix);
/**
* @brief Set toggle state.
*
* @param hSession Session handle.
* @param ix Toggle id.
* @param value New toggle state (non zero for true).
*
* @returns 0 if the toggle is already at the state, 1 if the toggle was changed; < 0 on error (sets errno).
*
* @retval -EINVAL Invalid toggle id.
*
*/
LIB3270_EXPORT int lib3270_set_toggle(H3270 *hSession, LIB3270_TOGGLE ix, int value);
/**
* @brief Translate a string toggle name to the corresponding value.
*
* @param name Toggle name.
*
* @return Toggle ID or negative if it's invalid.
*
*/
LIB3270_EXPORT LIB3270_TOGGLE lib3270_get_toggle_id(const char *name);
/**
* @brief Get the toggle name as string.
*
* @param id Toggle id
*
* @return Constant string with the toggle name or "" if invalid.
*
*/
LIB3270_EXPORT const char * lib3270_get_toggle_name(LIB3270_TOGGLE ix);
/**
* @brief Get a long description of the toggle.
*
* @return Constant string with the toggle description.
*
*/
LIB3270_EXPORT const char * lib3270_get_toggle_description(LIB3270_TOGGLE ix);
/**
* @brief Get a summary description of the toggle (for menus).
*
* @return Constant string with the toggle summary.
*
*/
LIB3270_EXPORT const char * lib3270_get_toggle_summary(LIB3270_TOGGLE ix);
/**
* @brief Get a short description of the toggle (for buttons).
*
* @return Constant string with the toggle label.
*
*/
LIB3270_EXPORT const char * lib3270_get_toggle_label(LIB3270_TOGGLE ix);
/**
* @brief Revert toggle status.
*
* @param hSession Session handle.
* @param ix Toggle id.
*
* @returns 0 if the toggle is already at the state, 1 if the toggle was changed; < 0 on error (sets errno).
*
* @retval -EINVAL Invalid toggle id.
*/
LIB3270_EXPORT int lib3270_toggle(H3270 *hSession, LIB3270_TOGGLE ix);
LIB3270_EXPORT const void * lib3270_register_toggle_listener(H3270 *hSession, LIB3270_TOGGLE tx, void (*func)(H3270 *, LIB3270_TOGGLE, char, void *),void *data);
LIB3270_EXPORT int lib3270_unregister_toggle_listener(H3270 *hSession, LIB3270_TOGGLE tx, const void *id);
#ifdef __cplusplus
}
#endif
#endif /* LIB3270_TOGGLE_H_INCLUDED */