Class TRichView (unit RichView)

Inherits from

TRVScroller

------------------------------------------------------------------

Constructors


constructor Create(AOwner: TComponent);

==================================================================


Functions

procedure Add(s: String;StyleNo:Integer);

-------------------------------------

procedure AddBreak;

-------------------------------------

procedure AddBullet (imgNo: Integer; lst: TImageList; fromnewline: Boolean);

-------------------------------------

procedure AddCenterLine(s: String;StyleNo:Integer);

-------------------------------------

function AddCheckPoint: Integer;

-------------------------------------

procedure AddControl(ctrl: TControl; center: Boolean);

-------------------------------------

procedure AddFromNewLine(s: String;StyleNo:Integer);

-------------------------------------

procedure AddHotSpot(imgNo: Integer; lst: TImageList; fromnewline: Boolean);

-------------------------------------

function AddNamedCheckPoint(CpName: String): Integer;

returns cp #

-------------------------------------


procedure AddPicture(gr: TGraphic);

-------------------------------------

procedure AddText(s: String;StyleNo:Integer);

-------------------------------------

procedure AddTextFromNewLine(s: String;StyleNo:Integer);

-------------------------------------

procedure AppendFrom(Source: TRichView);

-------------------------------------

procedure Clear;

-------------------------------------

procedure DeleteLines(FirstLine, Count: Integer);

------------------------------------------------------------------

procedure DeleteSection(CpName: String);

------------------------------------------------------------------

destructor Destroy;

-------------------------------------

procedure Format;

-------------------------------------

procedure FormatTail;

-------------------------------------

function GetCheckPointY(no: Integer): Integer;

returns cp #

-------------------------------------


function GetJumpPointY(no: Integer): Integer;

-------------------------------------

function GetLastCP: Integer;

-------------------------------------

function GetMaxPictureWidth: Integer;

-------------------------------------

procedure Paint;

-------------------------------------

function SaveHTML(FileName, Title, ImagesPrefix: String; Options: TRVSaveOptions):Boolean;


function SavePicture(DocumentSaveFormat: TRVSaveFormat; Path: String; gr: TGraphic): String;

use this only inside OnSaveComponentToFile event handler:

function SaveText(FileName: String; LineWidth: Integer):Boolean;


procedure AdjustChildrenCoords;

-------------------------------------

procedure AdjustJumpsCoords;

-------------------------------------

procedure ClearTemporal;

-------------------------------------

procedure DrawBack(DC: HDC; Rect: TRect; Width,Height:Integer);

-------------------------------------

function FindClickedWord(var clickedword: String; var StyleNo: Integer): Boolean;

------------------------------------------------------------------

procedure FormatLine(no: Integer; var x,baseline,prevdesc,prevabove:Integer; Canvas: TCanvas; var sad: TScreenAndDevice);

-------------------------------------

procedure Format_(OnlyResized:Boolean; depth: Integer; Canvas: TCanvas; OnlyTail: Boolean);

-------------------------------------

function GetFirstVisible(TopLine: Integer): Integer;

-------------------------------------

function GetNextFileName(Path: String): String;


procedure SetBackBitmap(Value: TBitmap);

-------------------------------------

procedure SetBackgroundStyle(Value: TBackgroundStyle);

-------------------------------------

procedure SetVSmallStep(Value: Integer);

-------------------------------------

procedure ShareLinesFrom(Source: TRichView);

-------------------------------------

procedure DblClick;

------------------------------------------------------------------

function FindItemAtPos(X,Y: Integer): Integer;

-------------------------------------

function GetLineCount: Integer;

------------------------------------------------------------------

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);

-------------------------------------

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);

-------------------------------------

procedure WMEraseBkgnd(var Message: TWMEraseBkgnd);

-------------------------------------

procedure WMMouseMove(var Message: TWMMouseMove);

-------------------------------------

procedure WMSize(var Message: TWMSize);

-------------------------------------

Properties

property BackgroundBitmap : TBitmap


property BackgroundStyle : TBackgroundStyle


property Delimiters : String


property FirstJumpNo : Integer

Published declarations

property LeftMargin : Integer


property MaxTextWidth : Integer


property MinTextWidth : Integer


property RightMargin : Integer


property Style : TRVStyle


property LineCount : Integer


property VSmallStep : Integer


Events

event OnJump : TJumpEvent


event OnRVDblClick : TRVDblClickEvent


event OnRVMouseMove : TRVMouseMoveEvent


event OnRVRightClick : TRVRightClickEvent


event OnSaveComponentToFile : TRVSaveComponentToFileEvent


event OnURLNeeded : TRVURLNeededEvent


Variables

DisplayOptions : TRVDisplayOptions;

Public declarations

FClientTextWidth : Boolean;


checkpoints : TStringList;


drawlines : TStringList;

Protected declarations

FStyle : TRVStyle;


imgSaveNo : Integer;


imgSavePrefix : String;


jumps : TStringList;


LastJumpDowned : Integer;


LastJumpMovedAbove : Integer;


LastLineFormatted : Integer;


lines : TStringList;


nJmps : Integer;


SaveOptions : TRVSaveOptions;


ShareContents : Boolean;


skipformatting : Boolean;


TextHeight : Integer;


TextWidth : Integer;


XClicked : Integer;


YClicked : Integer;


FBackBitmap : TBitmap;


FBackgroundStyle : TBackgroundStyle;


FDelimiters : String;

Private declarations

FFirstJumpNo : Integer;


FLeftMargin : Integer;


FMaxTextWidth : Integer;


FMinTextWidth : Integer;


FOnJump : TJumpEvent;


FOnRVDblClick : TRVDblClickEvent;


FOnRVMouseMove : TRVMouseMoveEvent;


FOnRVRightClick : TRVRightClickEvent;


FOnSaveComponentToFile : TRVSaveComponentToFileEvent;


FOnURLNeeded : TRVURLNeededEvent;


FRightMargin : Integer;


OldHeight : Integer;


OldWidth : Integer;



Constructors


constructor Create(AOwner: TComponent);

==================================================================


Functions


procedure Add(s: String;StyleNo:Integer);

-------------------------------------


procedure AddBreak;

-------------------------------------


procedure AddBullet (imgNo: Integer; lst: TImageList; fromnewline: Boolean);

-------------------------------------


procedure AddCenterLine(s: String;StyleNo:Integer);

-------------------------------------


function AddCheckPoint: Integer;

-------------------------------------


procedure AddControl(ctrl: TControl; center: Boolean);

-------------------------------------


procedure AddFromNewLine(s: String;StyleNo:Integer);

-------------------------------------


procedure AddHotSpot(imgNo: Integer; lst: TImageList; fromnewline: Boolean);

-------------------------------------


function AddNamedCheckPoint(CpName: String): Integer;

returns cp #

-------------------------------------


procedure AddPicture(gr: TGraphic);

-------------------------------------


procedure AddText(s: String;StyleNo:Integer);

-------------------------------------


procedure AddTextFromNewLine(s: String;StyleNo:Integer);

-------------------------------------


procedure AppendFrom(Source: TRichView);

-------------------------------------


procedure Clear;

-------------------------------------


procedure DeleteLines(FirstLine, Count: Integer);

------------------------------------------------------------------


procedure DeleteSection(CpName: String);

------------------------------------------------------------------


destructor Destroy;

-------------------------------------


procedure Format;

-------------------------------------


procedure FormatTail;

-------------------------------------


function GetCheckPointY(no: Integer): Integer;

returns cp #

-------------------------------------


function GetJumpPointY(no: Integer): Integer;

-------------------------------------


function GetLastCP: Integer;

-------------------------------------


function GetMaxPictureWidth: Integer;

-------------------------------------


procedure Paint;

-------------------------------------


function SaveHTML(FileName, Title, ImagesPrefix: String; Options: TRVSaveOptions):Boolean;


function SavePicture(DocumentSaveFormat: TRVSaveFormat; Path: String; gr: TGraphic): String;

use this only inside OnSaveComponentToFile event handler:


function SaveText(FileName: String; LineWidth: Integer):Boolean;


procedure AdjustChildrenCoords;

-------------------------------------


procedure AdjustJumpsCoords;

-------------------------------------


procedure ClearTemporal;

-------------------------------------


procedure DrawBack(DC: HDC; Rect: TRect; Width,Height:Integer);

-------------------------------------


function FindClickedWord(var clickedword: String; var StyleNo: Integer): Boolean;

------------------------------------------------------------------


procedure FormatLine(no: Integer; var x,baseline,prevdesc,prevabove:Integer; Canvas: TCanvas; var sad: TScreenAndDevice);

-------------------------------------


procedure Format_(OnlyResized:Boolean; depth: Integer; Canvas: TCanvas; OnlyTail: Boolean);

-------------------------------------


function GetFirstVisible(TopLine: Integer): Integer;

-------------------------------------


function GetNextFileName(Path: String): String;


procedure SetBackBitmap(Value: TBitmap);

-------------------------------------


procedure SetBackgroundStyle(Value: TBackgroundStyle);

-------------------------------------


procedure SetVSmallStep(Value: Integer);

-------------------------------------


procedure ShareLinesFrom(Source: TRichView);

-------------------------------------


procedure DblClick;

------------------------------------------------------------------


function FindItemAtPos(X,Y: Integer): Integer;

-------------------------------------


function GetLineCount: Integer;

------------------------------------------------------------------


procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);

-------------------------------------


procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);

-------------------------------------


procedure WMEraseBkgnd(var Message: TWMEraseBkgnd);

-------------------------------------


procedure WMMouseMove(var Message: TWMMouseMove);

-------------------------------------


procedure WMSize(var Message: TWMSize);

-------------------------------------


Properties


property BackgroundBitmap : TBitmap


property BackgroundStyle : TBackgroundStyle


property Delimiters : String


property FirstJumpNo : Integer

Published declarations


property LeftMargin : Integer


property MaxTextWidth : Integer


property MinTextWidth : Integer


property RightMargin : Integer


property Style : TRVStyle


property LineCount : Integer


property VSmallStep : Integer


Events


event OnJump : TJumpEvent


event OnRVDblClick : TRVDblClickEvent


event OnRVMouseMove : TRVMouseMoveEvent


event OnRVRightClick : TRVRightClickEvent


event OnSaveComponentToFile : TRVSaveComponentToFileEvent


event OnURLNeeded : TRVURLNeededEvent


Variables


DisplayOptions : TRVDisplayOptions;

Public declarations


FClientTextWidth : Boolean;


checkpoints : TStringList;


drawlines : TStringList;

Protected declarations


FStyle : TRVStyle;


imgSaveNo : Integer;


imgSavePrefix : String;


jumps : TStringList;


LastJumpDowned : Integer;


LastJumpMovedAbove : Integer;


LastLineFormatted : Integer;


lines : TStringList;


nJmps : Integer;


SaveOptions : TRVSaveOptions;


ShareContents : Boolean;


skipformatting : Boolean;


TextHeight : Integer;


TextWidth : Integer;


XClicked : Integer;


YClicked : Integer;


FBackBitmap : TBitmap;


FBackgroundStyle : TBackgroundStyle;


FDelimiters : String;

Private declarations


FFirstJumpNo : Integer;


FLeftMargin : Integer;


FMaxTextWidth : Integer;


FMinTextWidth : Integer;


FOnJump : TJumpEvent;


FOnRVDblClick : TRVDblClickEvent;


FOnRVMouseMove : TRVMouseMoveEvent;


FOnRVRightClick : TRVRightClickEvent;


FOnSaveComponentToFile : TRVSaveComponentToFileEvent;


FOnURLNeeded : TRVURLNeededEvent;


FRightMargin : Integer;


OldHeight : Integer;


OldWidth : Integer;