summaryrefslogtreecommitdiff
path: root/man/tickit_pen_has_attr.3
blob: 7680d97e97eeef1de80e667eb61a597532908fc3 (plain)
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
.TH TICKIT_PEN_HAS_ATTR 3
.SH NAME
tickit_pen_has_attr \- test if a pen has a given attribute
.SH SYNOPSIS
.EX
.B #include <tickit.h>
.sp
.BI "bool tickit_pen_has_attr(TickitPen *" pen ", TickitPenAttr " attr );
.BI "bool tickit_pen_nondefault_attr(TickitPen *" pen ", TickitPenAttr " attr );
.EE
.sp
Link with \fI\-ltickit\fP.
.SH DESCRIPTION
\fBtickit_pen_has_attr\fP() tests whether a pen instance has a given attribute defined on it. It returns true if the corresponding \fBtickit_pen_set_*_attr\fP() function has been called since construction, or the last time it was cleared. This is true even if the attribute has been set to its default value.
.PP
\fBtickit_pen_nondefault_attr\fP() tests whether a pen instance has a given attribute defined with a non-default value. It returns true if the attribute is set to a value that is not the default, or false if the attribute is absent, or set to the default value for that attribute type.
.SH "RETURN VALUE"
\fBtickit_pen_has_attr\fP() and \fBtickit_pen_nondefault_attr\fP() return a boolean.
.SH "SEE ALSO"
.BR tickit_pen_new (3),
.BR tickit_pen_set_bool_attr (3),
.BR tickit_pen_set_int_attr (3),
.BR tickit_pen_set_colour_attr (3),
.BR tickit_pen_clear_attr (3),
.BR tickit_pen (7),
.BR tickit (7)