File: lm.yo

package info (click to toggle)
bobcat 6.02.02-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 13,960 kB
  • sloc: cpp: 18,954; fortran: 5,617; makefile: 2,787; sh: 659; perl: 401; ansic: 26
file content (81 lines) | stat: -rw-r--r-- 2,404 bytes parent folder | download | duplicates (3)
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
includefile(include/header)

COMMENT(manpage, section, releasedate, archive, short name)
manpage(FBB::lm)(3bobcat)(_CurYrs_)(libbobcat-dev__CurVers_)
                    (OFoldStream manipulator)

manpagename(FBB::lm)(Manipulator setting left margins of OFoldStream objects)

manpagesynopsis()
    bf(#include <bobcat/ofoldstream>) or nl()
    bf(#include <bobcat/ofoldbuf>) nl()
    Linking option: tt(-lbobcat)

manpagedescription()

The tt(lm) class implements a manipulator that can be inserted into
tt(OFoldStream) objects to set the stream's left margin to a requested
value.

Depending on the tab-setting of the tt(OFoldStream) the inserted value
represents the number of blank space characters or the number of
tab-characters that will be used for the left margin.

The request will be processed at the next newline character or tt(std::flush)
or tt(std::endl) manipulator that is inserted into the stream. If a line is
still once an tt(lm) object and a tt(flush) manipulator are inserted into the
stream then the new left margin will be effective at the next word inserted
into that line (cf., the example section below).

A em(bad_cast) exception is thrown when the manipulator is inserted into an
tt(ostream) that is not using a tt(OFoldBuf) buffer.

includefile(include/namespace)

manpagesection(INHERITS FROM)
    -

manpagesection(CONSTRUCTOR)
    itemization(
    itb(lm(size_t newValue))
    )

    Copy and move constructors (and assignment operators) are available.

manpagesection(MEMBER FUNCTIONS)

    itemization(
    itb(std::ostream &modify(std::ostream &out) const)
        This member is normally not directly called from
user-programs. Instead, it is called by the insertion operator when inserting
the tt(lm) manipulator.
    )

manpagesection(EXAMPLE)
        verb(
    #include <iostream>
    #include <bobcat/ofoldstream>

    using namespace std;
    using namespace FBB;

    int main()
    {
        OFoldStream out(cout, 0, 80);
        out << "hello world (left margin is 0)" << lm(4) << "\n"
               "this uses a 4 character wide left margin\n" <<
               lm(0) << flush << "at column 0 again\n";
    }
        )

manpagefiles()
    em(bobcat/lm) - defines the class interface

manpageseealso()
    bf(bobcat)(7), bf(manipulators)(3bobcat), bf(mlm)(3bobcat),
    bf(ofoldstream)(3bobcat)

manpagebugs()
    None Reported.

includefile(include/trailer)