FBB::Align(3) Class used to align elements in Table objects

SYNOPSIS

#include <bobcat/align>

Linking option: -lbobcat

DESCRIPTION

This class defines the objects used by the FBB::Table to define the alignment of its columns and/or elements.

NAMESPACE

FBB
All constructors, members, operators and manipulators, mentioned in this man-page, are defined in the namespace FBB.

INHERITS FROM

-

ADDITIONAL TYPEDEF

The type FBB::Manipulator can be used as a shorthand for

        std::ios_base &(*)(std::ios_base &)
            
which is the prototype of a standard io-manipulator like std::left.

CONSTRUCTORS

  • Align(size_t column = 0, Manipulator manip = std::right):
    This constructor defines the alignment of column [column] of a Table object. When it is used, it is the responsibility of the programmer to ensure that the indicated Table column exists. This constructor can also be used as a default constructor, defining a default right-alignment.
  • Align(int row, size_t column, Manipulator manip):
    This constructor defines the alignment of element [row][column] of a Table object. When it is used, it is the responsibility of the programmer to ensure that the indicated Table element exists.
  • Align(Manipulator manip):
    This constructor is used to initialize the object with a specified alignment type. The copy constructor is available.

OVERLOADED OPERATORS

o
operator size_t() const:
Returns the value representing a requested width of an element in a Table object.

MEMBER FUNCTIONS

  • size_t col() const:
    Returns the object's column index.
  • bool hasRow() const:
    Returns true if the object's member returns a sensible value.
  • size_t const:
    Returns the object's row index.
  • Manipulator manip() const:
    Returns the Manipulator stored in the object.
  • void setWidth(size_t width):
    Assigns a value to the field-width stored in the object.
  • void setManip(Manipulator manip):
    Changes the object's currently stored Manipulator.

MANIPULATORS

The following manipulator (which is not part of the FBB::Align, class), is defined in the FBB namespace. It can be stored in Align objects and is used by Table objects:
  • FBB::center:

EXAMPLE

See the table(3bobcat) man-page.

FILES

bobcat/align - defines the class interface

BUGS

None Reported.

DISTRIBUTION FILES

  • bobcat_4.02.00-x.dsc: detached signature;
  • bobcat_4.02.00-x.tar.gz: source archive;
  • bobcat_4.02.00-x_i386.changes: change log;
  • libbobcat1_4.02.00-x_*.deb: debian package holding the libraries;
  • libbobcat1-dev_4.02.00-x_*.deb: debian package holding the libraries, headers and manual pages;
  • http://sourceforge.net/projects/bobcat: public archive location;

BOBCAT

Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.

COPYRIGHT

This is free software, distributed under the terms of the GNU General Public License (GPL).

AUTHOR

Frank B. Brokken ([email protected]).