[go: up one dir, main page]

File: gntcheckbox.h

package info (click to toggle)
libgnt 2.14.4-1.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 976 kB
  • sloc: ansic: 14,752; xml: 117; makefile: 10
file content (141 lines) | stat: -rw-r--r-- 3,913 bytes parent folder | download | duplicates (3)
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
/*
 * GNT - The GLib Ncurses Toolkit
 *
 * GNT is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#ifndef GNT_CHECK_BOX_H
#define GNT_CHECK_BOX_H
/**
 * SECTION:gntcheckbox
 * @section_id: libgnt-gntcheckbox
 * @title: GntCheckbox
 * @short_description: A widget that can be toggled
 * @see_also: #GntButton
 */

#include "gnt.h"
#include "gntbutton.h"
#include "gntcolors.h"
#include "gntkeys.h"

#define GNT_TYPE_CHECK_BOX				(gnt_check_box_get_gtype())
#define GNT_CHECK_BOX(obj)				(G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_CHECK_BOX, GntCheckBox))
#define GNT_CHECK_BOX_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_CHECK_BOX, GntCheckBoxClass))
#define GNT_IS_CHECK_BOX(obj)			(G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_CHECK_BOX))
#define GNT_IS_CHECK_BOX_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_CHECK_BOX))
#define GNT_CHECK_BOX_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_CHECK_BOX, GntCheckBoxClass))

#ifndef GNT_DISABLE_DEPRECATED
/**
 * GNT_CHECK_BOX_FLAGS:
 *
 * Deprecated: 2.14.0: This is an internal implementation detail.
 */
#define GNT_CHECK_BOX_FLAGS(obj)				(GNT_CHECK_BOX(obj)->priv.flags)
/**
 * GNT_CHECK_BOX_SET_FLAGS:
 *
 * Deprecated: 2.14.0: This is an internal implementation detail.
 */
#define GNT_CHECK_BOX_SET_FLAGS(obj, flags)		(GNT_CHECK_BOX_FLAGS(obj) |= flags)
/**
 * GNT_CHECK_BOX_UNSET_FLAGS:
 *
 * Deprecated: 2.14.0: This is an internal implementation detail.
 */
#define GNT_CHECK_BOX_UNSET_FLAGS(obj, flags)	(GNT_CHECK_BOX_FLAGS(obj) &= ~(flags))
#endif

typedef struct _GntCheckBox			GntCheckBox;
typedef struct _GntCheckBoxClass		GntCheckBoxClass;
#ifndef GNT_DISABLE_DEPRECATED
/**
 * GntCheckBoxPriv:
 *
 * Deprecated: 2.14.0: This is an internal implementation detail.
 */
typedef struct _GntCheckBoxPriv GntCheckBoxPriv;
#endif

/**
 * GntCheckBox:
 *
 * Access to any fields is deprecated. See inline comments for replacements.
 */
struct _GntCheckBox
{
	GntButton parent;
	gboolean GNTSEAL(checked);
};

struct _GntCheckBoxClass
{
	GntButtonClass parent;

	void (*toggled)(void);

	/*< private >*/
	void (*gnt_reserved1)(void);
	void (*gnt_reserved2)(void);
	void (*gnt_reserved3)(void);
	void (*gnt_reserved4)(void);
};

G_BEGIN_DECLS

/**
 * gnt_check_box_get_gtype:
 *
 * Returns: GType for GntCheckBox
 */
GType gnt_check_box_get_gtype(void);

/**
 * gnt_check_box_new:
 * @text: The text for the checkbox.
 *
 * Create a new checkbox.
 *
 * Returns:  The newly created checkbox.
 */
GntWidget * gnt_check_box_new(const char *text);

/**
 * gnt_check_box_set_checked:
 * @box:   The checkbox.
 * @set:   %TRUE if the checkbox should be selected, %FALSE otherwise.
 *
 * Set whether the checkbox should be checked or not.
 */
void gnt_check_box_set_checked(GntCheckBox *box, gboolean set);

/**
 * gnt_check_box_get_checked:
 * @box:  The checkbox.
 *
 * Return the checked state of the checkbox.
 *
 * Returns:     %TRUE if the checkbox is selected, %FALSE otherwise.
 */
gboolean gnt_check_box_get_checked(GntCheckBox *box);

G_END_DECLS

#endif /* GNT_CHECK_BOX_H */