~leonerd/libtickit/trunk

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
.TH TICKIT_RECT_INIT_SIZED 3
.SH NAME
tickit_rect_init_sized, tickit_rect_init_bounded \- initialise a rectangle struct
.SH SYNOPSIS
.EX
.B #include <tickit.h>
.sp
.BI "void tickit_rect_init_sized(TickitRect *" rect ", int " top ", int " left ,
.BI "    int " lines ", int " cols );
.BI "void tickit_rect_init_bounded(TickitRect *" rect ", int " top ", int " left ,
.BI "    int " bottom ", int " right );
.EE
.sp
Link with \fI\-ltickit\fP.
.SH DESCRIPTION
\fBtickit_rect_init_sized\fP() initialises a \fBTickitRect\fP structure to contain the given top left corner and size. It is equivalent to just initialising the four fields individually, but is included in the API for completeness.
.PP
\fBtickit_rect_init_bounded\fP() initialises a \fBTickitRect\fP structure to contain the given top left and bottom right bounds.
.SH "RETURN VALUE"
Neither function returns a value.
.SH "SEE ALSO"
.BR tickit_rect_bottom (3),
.BR tickit_rect_right (3),
.BR tickit_rect (7),
.BR tickit (7)