.TH "FBB::Align" "3bobcat" "2005\-2020" "libbobcat\-dev_5\&.07\&.00" "Table Element Alignment"

.PP 
.SH "NAME"
FBB::Align \- Class used to align elements in Table objects
.PP 
.SH "SYNOPSIS"
\fB#include <bobcat/align>\fP
.br 

.PP 
Linking option: \fI\-lbobcat\fP 
.PP 
.SH "DESCRIPTION"
This class defines objects used by the class \fBFBB::Table\fP to define
the alignment of its columns and/or elements\&.
.PP 
.SH "NAMESPACE"
\fBFBB\fP
.br 
All constructors, members, operators and manipulators, mentioned in this
man\-page, are defined in the namespace \fBFBB\fP\&.
.PP 
.SH "INHERITS FROM"
\-
.PP 
.SH "ADDITIONAL TYPEDEF"

.PP 
The type \fBFBB::Manipulator\fP can be used as a shorthand for 
.nf 

        std::ios_base &(*)(std::ios_base &)
            
.fi 
which is the prototype of standard io\-manipulators like \fIstd::left\fP\&.
.PP 
.SH "CONSTRUCTORS"
.IP o 
\fBAlign(size_t column = 0, Manipulator manip = std::right)\fP:
.br 
This constructor defines how the content of column `\fIcolumn\fP\(cq\& of a
\fBTable\fP object are aligned\&. When used, it is the responsibility of the
programmer to ensure that the table\(cq\&s column exists\&. This
constructor can also be used as a default constructor, by default using
right\-alignment\&.
.IP 
.IP o 
\fBAlign(int row, size_t column, Manipulator manip)\fP:
.br 
This constructor defines the alignment of element \fI[row][column]\fP
of a \fBTable\fP object\&. When it is used, it is the responsibility of the
programmer to ensure that the table\(cq\&s element exists\&.
.IP 
.IP o 
\fBAlign(Manipulator manip)\fP:
.br 
This constructor is used to initialize the object with the address of
an existing io\-manipulator function\&.

.PP 
Copy and move constructors (and assignment operators) are available\&.
.PP 
.SH "OVERLOADED OPERATORS"

.PP 
.IP o 
\fBoperator size_t() const\fP:
.br 
Returns the value representing a requested width of an element in a
\fBTable\fP object\&.

.PP 
.SH "MEMBER FUNCTIONS"
.IP o 
\fBsize_t col() const\fP:
.br 
Returns the object\(cq\&s column index\&.
.IP o 
\fBbool hasRow() const\fP:
.br 
Returns \fItrue\fP if the object\(cq\&s \fB\fP member returns a sensible
value\&. 
.IP o 
\fBsize_t row() const\fP:
.br 
Returns the object\(cq\&s row index\&.
.IP o 
\fBManipulator manip() const\fP:
.br 
Returns the \fBManipulator\fP stored in the object\&.
.IP 
.IP o 
\fBvoid setWidth(size_t width)\fP:
.br 
Defines the field\-width of element(s) of a \fITable\fP object to which
the \fBAlign\fP object is applied\&.
.IP 
.IP o 
\fBvoid setManip(Manipulator manip)\fP:
.br 
Changes the object\(cq\&s currently stored \fBManipulator\fP\&.

.PP 
.SH "MANIPULATORS"
The following manipulator (\fInot\fP part of the \fBFBB::Align\fP,
class but defined in the \fBFBB\fP namespace) can be stored in 
\fBAlign\fP objects through, e\&.g\&., \fIsetManip\fP:
.IP o 
\fBFBB::center\fP:
.br 

.PP 
.SH "EXAMPLE"
See the \fBtable\fP(3bobcat) man\-page\&.
.PP 
.SH "FILES"
\fIbobcat/align\fP \- defines the class interface
.PP 
.SH "SEE ALSO"
\fBbobcat\fP(7),  \fBmanipulator\fP(3bobcat), \fBtable\fP(3bobcat)
.PP 
.SH "BUGS"
None Reported\&.
.PP 
.SH "BOBCAT PROJECT FILES"

.PP 
.IP o 
\fIhttps://fbb\-git\&.gitlab\&.io/bobcat/\fP: gitlab project page;
.IP o 
\fIbobcat_5\&.07\&.00\-x\&.dsc\fP: detached signature;
.IP o 
\fIbobcat_5\&.07\&.00\-x\&.tar\&.gz\fP: source archive;
.IP o 
\fIbobcat_5\&.07\&.00\-x_i386\&.changes\fP: change log;
.IP o 
\fIlibbobcat1_5\&.07\&.00\-x_*\&.deb\fP: debian package containing the
libraries;
.IP o 
\fIlibbobcat1\-dev_5\&.07\&.00\-x_*\&.deb\fP: debian package containing the
libraries, headers and manual pages;

.PP 
.SH "BOBCAT"
Bobcat is an acronym of `Brokken\(cq\&s Own Base Classes And Templates\(cq\&\&.
.PP 
.SH "COPYRIGHT"
This is free software, distributed under the terms of the 
GNU General Public License (GPL)\&.
.PP 
.SH "AUTHOR"
Frank B\&. Brokken (\fBf\&.b\&.brokken@rug\&.nl\fP)\&.
.PP