1term::ansi::code::macros(n)    Terminal control    term::ansi::code::macros(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       term::ansi::code::macros - Macro sequences
9

SYNOPSIS

11       package require Tcl  8.4
12
13       package require textutil::repeat
14
15       package require textutil::tabify
16
17       package require term::ansi::code::macros  ?0.1?
18
19       ::term::ansi::code::macros::names
20
21       ::term::ansi::code::macros::import ?ns? ?arg...?
22
23       ::term::ansi::code::macros::menu menu
24
25       ::term::ansi::code::macros::frame string
26
27______________________________________________________________________________
28

DESCRIPTION

30       This  package  provides higher level control sequences for more complex
31       shapes.
32

API

34   INTROSPECTION
35       ::term::ansi::code::macros::names
36              This command is for introspection. It returns as  its  result  a
37              list containing the names of all attribute commands.
38
39       ::term::ansi::code::macros::import ?ns? ?arg...?
40              This  command  imports  some  or all attribute commands into the
41              namespace ns. This is by default the namespace macros. Note that
42              this  is  relative  namespace name, placing the imported command
43              into a child of the current namespace. By default  all  commands
44              are imported, this can howver be restricted by listing the names
45              of the wanted commands after the namespace argument.
46
47   SEQUENCES
48       ::term::ansi::code::macros::menu menu
49              The description of a menu is converted into a formatted  rectan‐
50              gular  block  of  text,  with  the menu command characters high‐
51              lighted using bold red text.  The  result  is  returned  as  the
52              result of the command.
53
54              The  description,  menu, is a dictionary mapping from menu label
55              to command character.
56
57       ::term::ansi::code::macros::frame string
58              The paragraph of text contained in the  string  is  padded  with
59              spaces at the right margin, after normalizing internal tabs, and
60              then put into a  frame  made  of  box-graphics.  The  result  is
61              returned as the result of the command.
62

BUGS, IDEAS, FEEDBACK

64       This  document,  and the package it describes, will undoubtedly contain
65       bugs and other problems.  Please report such in the  category  term  of
66       the  Tcllib  Trackers  [http://core.tcl.tk/tcllib/reportlist].   Please
67       also report any ideas for enhancements you may have for either  package
68       and/or documentation.
69
70       When proposing code changes, please provide unified diffs, i.e the out‐
71       put of diff -u.
72
73       Note further that  attachments  are  strongly  preferred  over  inlined
74       patches.  Attachments  can  be  made  by  going to the Edit form of the
75       ticket immediately after its creation, and  then  using  the  left-most
76       button in the secondary navigation bar.
77

KEYWORDS

79       ansi, control, frame, menu, terminal
80

CATEGORY

82       Terminal control
83

85       Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>
86
87
88
89
90tcllib                                0.1          term::ansi::code::macros(n)
Impressum