TSection

Declaration

TSection = class

Visibility

global

Immediate descendants

THtmlSection

Source

commonclasses.pas on line 223

Description

Represents an output section. Each section should correspond to a single syntatic unit (a module, class, routine declaration, ...)..

Members

Name

Type

Visibility

Synopsis

Create

constructor

public

Open

procedure

public

Opens the section for writing.

Open

procedure

public

The same as above, but passes '' as the title.

Close

procedure

public

Closes the section.

WriteText

procedure

public

Writes out text.

WriteText

procedure

public

The same as above but assumes attr = [].

WriteLink

procedure

public

Writes out a link to a section.

WriteHeading

procedure

public

Writes a heading.

NewParagraph

procedure

public

Begins a new paragraph.

NewLine

procedure

public

Begins a new line.

Indent

procedure

public

Makes an indentation.

StartTable

procedure

public

Starts writing a table.

NextCell

procedure

public

Moves to the next cell in the current row in the table being currently writed out.

NextRow

procedure

public

Starts a new row.

FinishTable

procedure

public

Finishes writing a table.

StartList

procedure

public

Starts writing a list.

NextListItem

procedure

public

Starts writing the next item in the current list.

FinishList

procedure

public

Finished writing a list;.

SuppressLineBreaking

procedure

public

Suppresses automatic line breaking (not for all formats).

ResumeLineBreaking

procedure

public

Resumes automatic line breaking (not for all formats).

Name

property

public

TSection

commonclasses



TSection.Create

Declaration

constructor Create(aname : String);

Visibility

public

Source

commonclasses.pas on line 228

Create

TSection

commonclasses


TSection.Open

Declaration

procedure Open(title : String); virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 235

Description

Opens the section for writing. Only one from all sections may be opened at a time. The methods writing to the output may be invoked only after calling Open and before calling Close. title Is the section title. It may be taken into account or completely disregarded.

Open

TSection

commonclasses


TSection.Open

Declaration

procedure Open;

Visibility

public

Source

commonclasses.pas on line 237

Description

The same as above, but passes '' as the title.

Open

TSection

commonclasses


TSection.Close

Declaration

procedure Close; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 240

Description

Closes the section. The section may not be written to any more, nor may it be re-opened earlier.

Close

TSection

commonclasses


TSection.WriteText

Declaration

procedure WriteText(text : String; attr : TTextAttributeSet); virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 245

Description

Writes out text. attr Are the attributes of the text. highlight Is true if the text should be highlighted.

WriteText

TSection

commonclasses


TSection.WriteText

Declaration

procedure WriteText(const text : String);

Visibility

public

Source

commonclasses.pas on line 248

Description

The same as above but assumes attr = [].

WriteText

TSection

commonclasses


TSection.WriteLink

Declaration

procedure WriteLink(descr : String; section : TSection); virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 252

Description

Writes out a link to a section. If section is nil writes descr as a plain text. Uses descr as a label for the link.

WriteLink

TSection

commonclasses


TSection.WriteHeading

Declaration

procedure WriteHeading(const text : String; size : TSize); virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 255

Description

Writes a heading. Size may be a number 1 through 6, where 1 is the largest, 6 the smallest. A heading begins a new paragraph.

WriteHeading

TSection

commonclasses


TSection.NewParagraph

Declaration

procedure NewParagraph; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 258

Description

Begins a new paragraph.

NewParagraph

TSection

commonclasses


TSection.NewLine

Declaration

procedure NewLine; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 260

Description

Begins a new line.

NewLine

TSection

commonclasses


TSection.Indent

Declaration

procedure Indent; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 263

Description

Makes an indentation. For one line only. This should be called just after calling NewLine.

Indent

TSection

commonclasses


TSection.StartTable

Declaration

procedure StartTable(const widths : TIntegerArray; cols : Integer); virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 269

Description

Starts writing a table. Cols is the number of columns. Widths should contain cols entries with the width of each column (in the percentage of the width of the whole table). After calling this routine the next output will be written in the first cell of the table.

StartTable

TSection

commonclasses


TSection.NextCell

Declaration

procedure NextCell; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 274

Description

Moves to the next cell in the current row in the table being currently writed out. If there is no next cell in the current row then does nothing.

NextCell

TSection

commonclasses


TSection.NextRow

Declaration

procedure NextRow; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 276

Description

Starts a new row.

NextRow

TSection

commonclasses


TSection.FinishTable

Declaration

procedure FinishTable; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 279

Description

Finishes writing a table. If the last row contains no data then it is discarded.

FinishTable

TSection

commonclasses


TSection.StartList

Declaration

procedure StartList(numbered : Boolean); virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 282

Description

Starts writing a list. The list is numbered if numbered is true.

StartList

TSection

commonclasses


TSection.NextListItem

Declaration

procedure NextListItem; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 284

Description

Starts writing the next item in the current list.

NextListItem

TSection

commonclasses


TSection.FinishList

Declaration

procedure FinishList; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 286

Description

Finished writing a list;.

FinishList

TSection

commonclasses


TSection.SuppressLineBreaking

Declaration

procedure SuppressLineBreaking; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 288

Description

Suppresses automatic line breaking (not for all formats).

SuppressLineBreaking

TSection

commonclasses


TSection.ResumeLineBreaking

Declaration

procedure ResumeLineBreaking; virtual; abstract;

Visibility

public

Source

commonclasses.pas on line 290

Description

Resumes automatic line breaking (not for all formats).

ResumeLineBreaking

TSection

commonclasses


TSection.Name

Declaration

property Name : String read FName;

Visibility

public

Source

commonclasses.pas on line 291

Name

TSection

commonclasses