lazarus/lcl/interfacebase.pp

341 lines
11 KiB
ObjectPascal

{
/***************************************************************************
InterfaceBase.pp
----------------
Initial Revision : Fri Jul 23 20:00:00 PDT 1999
***************************************************************************/
*****************************************************************************
* *
* This file is part of the Lazarus Component Library (LCL) *
* *
* See the file COPYING.modifiedLGPL.txt, included in this distribution, *
* for details about the copyright. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* *
*****************************************************************************
}
unit InterfaceBase;
{$mode objfpc}
{$LONGSTRINGS ON}
interface
{$ifdef Trace}
{$ASSERTIONS ON}
{$endif}
uses
Types, Classes, SysUtils, Math, LCLStrConsts, LCLType, LCLProc, LMessages,
GraphType, GraphMath, Themes;
type
PEventHandler = type Pointer;
PProcessEventHandler = type Pointer;
PPipeEventHandler = type Pointer;
PSocketEventHandler = type Pointer;
TChildExitReason = (cerExit, cerSignal);
TPipeReason = (prDataAvailable, prBroken, prCanWrite);
TPipeReasons = set of TPipeReason;
TApplicationMainLoop = procedure of object;
TWaitHandleEvent = procedure(AData: PtrInt; AFlags: dword) of object;
TChildExitEvent = procedure(AData: PtrInt; AReason: TChildExitReason; AInfo: dword) of object;
TPipeEvent = procedure(AData: PtrInt; AReasons: TPipeReasons) of object;
TSocketEvent = procedure(AData: PtrInt; AFlags: dword) of object;
TLCLWndMethod = procedure(var TheMessage: TLMessage) of Object;
TLCLPlatform = (
lpGtk,
lpGtk2,
lpWin32,
lpWinCE,
lpCarbon,
lpQT,
lpfpGUI,
lpNoGUI,
lpCocoa,
lpAndroid,
lpCustomDrawn
);
TLCLPlatforms = set of TLCLPlatform;
TLCLCapability = (
lcAsyncProcess, // Support for async process
lcCanDrawOutsideOnPaint, // Support for drawing outside OnPaint event of an control
lcNeedMininimizeAppWithMainForm,
// When main form is minimized, then minimize also app
lcApplicationTitle, // Can change application title in runtime
lcApplicationWindow, // Application has a special root window
lcFormIcon, // Forms have icon
lcModalWindow, // native modal windows support
lcDragDockStartOnTitleClick,// ability to start drag/dock events on title bar click
lcAntialiasingEnabledByDefault,
// is amDontCare = amOn for the widgetset
lcLMHelpSupport, // support for LM_HELP command
lcReceivesLMClearCutCopyPasteReliably // In Carbon we do not receive LM_CLEAR, CUT, COPY, PASTE, etc reliably, and this affects DB controls. See bug http://bugs.freepascal.org/view.php?id=20394
);
{ TDialogButton }
TDialogButton = class(TCollectionItem)
private
FCaption: string;
FModalResult: LongInt;
function GetCancel: Boolean;
function GetDefault: Boolean;
procedure SetCancel(const AValue: Boolean);
procedure SetDefault(const AValue: Boolean);
protected
function GetDisplayName: string; override;
procedure SetCaption(const AValue: string); virtual;
public
constructor Create(ACollection: TCollection); override;
property Caption: string read FCaption write SetCaption;
property Cancel: Boolean read GetCancel write SetCancel;
property Default: Boolean read GetDefault write SetDefault;
property ModalResult: LongInt read FModalResult write FModalResult;
end;
{ TDialogButtons }
TDialogButtons = class(TCollection)
protected
FCancelButton: TDialogButton;
FDefaultButton: TDialogButton;
function GetItem(Index: Integer): TDialogButton;
procedure SetCancelButton(const AValue: TDialogButton); virtual;
procedure SetDefaultButton(const Value: TDialogButton); virtual;
procedure SetItem(Index: Integer; const Value: TDialogButton);
public
destructor Destroy; override;
function Add: TDialogButton;
function FindButton(AModalResult: LongInt): TDialogButton;
function FindButton(Order: array of LongInt): TDialogButton;
property DefaultButton: TDialogButton read FDefaultButton write SetDefaultButton;
property CancelButton: TDialogButton read FCancelButton write SetCancelButton;
property Items[Index: Integer]: TDialogButton read GetItem write SetItem; default;
end;
type
TWSTimerProc = procedure of object;
{ TWidgetSet }
TWidgetSet = class(TObject)
protected
FThemeServices: TThemeServices;
procedure PassCmdLineOptions; virtual;
function CreateThemeServices: TThemeServices; virtual;
function GetAppHandle: THandle; virtual;
procedure SetAppHandle(const AValue: THandle); virtual;
public
constructor Create; virtual;
procedure BeforeDestruction;override;
procedure AppInit(var ScreenInfo: TScreenInfo); virtual; abstract;
procedure AppRun(const ALoop: TApplicationMainLoop); virtual;
procedure AppWaitMessage; virtual; abstract;
procedure AppProcessMessages; virtual; abstract;
procedure AppTerminate; virtual; abstract;
procedure AppMinimize; virtual; abstract;
procedure AppRestore; virtual; abstract;
procedure AppBringToFront; virtual; abstract;
procedure AppSetIcon(const Small, Big: HICON); virtual;
procedure AppSetTitle(const ATitle: string); virtual;
procedure AppSetVisible(const AVisible: Boolean); virtual;
function AppRemoveStayOnTopFlags(const ASystemTopAlso: Boolean = False): Boolean; virtual;
function AppRestoreStayOnTopFlags(const ASystemTopAlso: Boolean = False): Boolean; virtual;
procedure AppSetMainFormOnTaskBar(const DoSet: Boolean); virtual;
function LCLPlatform: TLCLPlatform; virtual; abstract;
function GetLCLCapability(ACapability: TLCLCapability): PtrUInt; virtual;
procedure DebugLogLn(const s: string); virtual;
procedure DebugLog(const s: string); virtual;
function DCGetPixel(CanvasHandle: HDC; X, Y: integer): TGraphicsColor; virtual; abstract;
procedure DCSetPixel(CanvasHandle: HDC; X, Y: integer; AColor: TGraphicsColor); virtual; abstract;
procedure DCRedraw(CanvasHandle: HDC); virtual; abstract;
procedure DCSetAntialiasing(CanvasHandle: HDC; AEnabled: Boolean); virtual;
procedure SetDesigning(AComponent: TComponent); virtual; abstract;
function InitStockFont(AFont: TObject; AStockFont: TStockFont): Boolean; virtual;
function IsHelpKey(Key: Word; Shift: TShiftState): Boolean; virtual;
// create and destroy
function CreateTimer(Interval: integer; TimerProc: TWSTimerProc): THandle; virtual; abstract;
function DestroyTimer(TimerHandle: THandle): boolean; virtual; abstract;
property AppHandle: THandle read GetAppHandle write SetAppHandle;
{$DEFINE IF_BASE_MEMBER}
{$I winapih.inc}
{$I lclintfh.inc}
{$UNDEF IF_BASE_MEMBER}
property ThemeServices: TThemeServices read FThemeServices;
end;
TWidgetSetClass = class of TWidgetSet;
const
LCLPlatformDirNames: array[TLCLPlatform] of string = (
'gtk',
'gtk2',
'win32',
'wince',
'carbon',
'qt',
'fpgui',
'nogui',
'cocoa',
'android',
'customdrawn'
);
{ Constants for the routine TWidgetSet.GetLCLCapability }
LCL_CAPABILITY_NO = 0;
LCL_CAPABILITY_YES = 1;
type
EInterfaceException = class(Exception);
EInterfaceError = class(EInterfaceException);
EInterfaceCritical = class(EInterfaceException);
EInterfaceWarning = class(EInterfaceException);
type
TInputDialogFunction = function (const InputCaption, InputPrompt : String;
MaskInput : Boolean; var Value : String) : Boolean;
TPromptDialogFunction = function(const DialogCaption, DialogMessage : String;
DialogType : longint; Buttons : PLongint;
ButtonCount, DefaultIndex, EscapeResult : Longint;
UseDefaultPos: boolean;
X, Y : Longint) : Longint;
TQuestionDialogFunction = function(const aCaption, aMsg: string;
DlgType: LongInt; Buttons: TDialogButtons; HelpCtx: Longint): LongInt;
var
InputDialogFunction: TInputDialogFunction = nil;
PromptDialogFunction: TPromptDialogFunction = nil;
QuestionDialogFunction: TQuestionDialogFunction = nil;
var
WidgetSet: TWidgetSet = nil;
implementation
{ TDialogButtons }
procedure TDialogButtons.SetCancelButton(const AValue: TDialogButton);
begin
FCancelButton := AValue;
end;
function TDialogButtons.GetItem(Index: Integer): TDialogButton;
begin
Result := TDialogButton(inherited GetItem(Index));
end;
procedure TDialogButtons.SetDefaultButton(const Value: TDialogButton);
begin
FDefaultButton := Value;
end;
procedure TDialogButtons.SetItem(Index: Integer; const Value: TDialogButton);
begin
inherited SetItem(Index, Value);
end;
destructor TDialogButtons.Destroy;
begin
inherited Destroy;
end;
function TDialogButtons.Add: TDialogButton;
begin
Result := TDialogButton(inherited Add);
end;
function TDialogButtons.FindButton(AModalResult: LongInt): TDialogButton;
var
i: Integer;
begin
for i := 0 to Count - 1 do
if Items[i].ModalResult = AModalResult then
Exit(Items[i]);
Result := nil;
end;
function TDialogButtons.FindButton(Order: array of LongInt): TDialogButton;
var
i: Integer;
begin
for i := Low(Order) to High(Order) do
begin
Result := FindButton(Order[i]);
if Result <> nil then
Exit;
end;
Result := nil;
end;
{ TDialogButton }
procedure TDialogButton.SetCaption(const AValue: string);
begin
FCaption := AValue;
end;
function TDialogButton.GetDefault: Boolean;
begin
Result := TDialogButtons(Collection).DefaultButton = Self;
end;
function TDialogButton.GetCancel: Boolean;
begin
Result := TDialogButtons(Collection).CancelButton = Self;
end;
procedure TDialogButton.SetCancel(const AValue: Boolean);
begin
if AValue then
TDialogButtons(Collection).CancelButton := Self
else
TDialogButtons(Collection).CancelButton := nil;
end;
procedure TDialogButton.SetDefault(const AValue: Boolean);
begin
if AValue then
TDialogButtons(Collection).DefaultButton := Self
else
TDialogButtons(Collection).DefaultButton := nil;
end;
function TDialogButton.GetDisplayName: string;
begin
Result := FCaption;
end;
constructor TDialogButton.Create(ACollection: TCollection);
begin
inherited Create(ACollection);
FCaption := '';
FModalResult := 0;
end;
{$I interfacebase.inc}
{$I intfbasewinapi.inc}
{$I intfbaselcl.inc}
end.