FBB::Indent - Configurable text indentation
Contents
Bobcat
Bobcat is an acronym of `Brokken’s Own Base Classes And Templates’.
Bobcat Project Files
o https://fbb-git.gitlab.io/bobcat/: gitlab project page;
Debian Bobcat project files:
o libbobcat6: debian package containing the shared library, changelog and copyright note;
o libbobcat-dev: debian package containing the static library, headers, manual pages, and developer
info;
Bugs
None Reported.
Copyright
This is free software, distributed under the terms of the GNU General Public License (GPL).
Description
FBB::Indent and its various manipulators offer text-indentation. Text inserted into streams is indented
over a fully configurable amount using a set of manipulators and (static) member functions.
Example
using namespace std;
using namespace FBB;
int main()
{
cout << indentinc << "Not indented" <<
nlindent << "Indenting with 4 blanks\n";
Indent::clear();
cout << "No indentation\n";
}
Files
bobcat/indent - defines the class interface
Inherits From
-
Manipulators
The following manipulators (which are not part of the FBB::Indent, class, but are defined in the FBB
namespace) can be inserted into the FBB::Indent object:
o FBB::decindent:
This manipulator will first call Indent::dec. Then FBB::indent is called. The effect will be that
the indentation level is reduced just before the indentation is inserted.
o FBB::incindent:
This manipulator will first call Indent::inc. Then FBB::indent is called. The effect will be that
the indentation level is incremented just before the indentation is inserted.
o FBB::indent:
This manipulator will insert the currently defined number of indentation blanks into the ostream
for which it it called.
o FBB::indentdec:
This manipulator will first call FBB::indent, Then Indent::dec is called. The effect will be that
the indentation is inserted first, immediately followed by a reduction of the indentation level.
o FBB::indentinc:
This manipulator will first call FBB::indent, Then Indent::inc is called. The effect will be that
the indentation is inserted first, immediately followed by a increment of the indentation level.
o FBB::nlindent:
This manipulator will insert a newline character (\n). Then FBB::indent is called, indenting the
next line over the currently defined number of blanks.
Name
FBB::Indent - Configurable text indentation
Namespace
FBB
All constructors, members, operators and manipulators, mentioned in this man-page, are defined in the
namespace FBB.
See Also
bobcat(7)
Static Member Functions
o voidclear():
Resets the indentation level to zero. The indent manipulator will have no visible effect after
calling this member.
o voiddec():
Reduces the indentation level by the current increment (4 by default). The indentation level is
never reduces to a negative value.
o voidinc():
Increments the indentation level by the current increment (4 by default).
o voidsetInc(size_tinc):
Defines the increment value used with the dec and inc members.
o voidsetWidth(size_twidth):
Defines the indentation to a specific value width.
Synopsis
#include<bobcat/indent>
