Componentes.Terceros.jvcl/official/3.39/run/JvProgressForm.pas
2010-01-18 16:55:50 +00:00

334 lines
10 KiB
ObjectPascal

{-----------------------------------------------------------------------------
The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL/MPL-1.1.html
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either expressed or implied. See the License for
the specific language governing rights and limitations under the License.
The Original Code is: JvProgressComponent.PAS, released on 2003-03-31.
The Initial Developer of the Original Code is Peter Thörnqvist.
Portions created by Peter Thörnqvist are Copyright (c) 2003 Peter Thörnqvist.
All Rights Reserved.
Contributor(s):
You may retrieve the latest version of this file at the Project JEDI's JVCL home page,
located at http://jvcl.delphi-jedi.org
Known Issues:
Description:
- This form is used by JvProgressDialog.pas
-----------------------------------------------------------------------------}
// $Id: JvProgressForm.pas 12461 2009-08-14 17:21:33Z obones $
unit JvProgressForm;
{$I jvcl.inc}
interface
uses
{$IFDEF UNITVERSIONING}
JclUnitVersioning,
{$ENDIF UNITVERSIONING}
SysUtils, Classes,
Windows, Graphics, Controls, Forms, StdCtrls, ExtCtrls, ComCtrls, ActnList,
JvComponent, JvConsts;
type
TJvPrivateProgressUpdate = procedure(Sender: TObject;
var AMin, AMax, APosition, AInterval: Integer;
var ACaption, ALabel: string; AnImage: TPicture;
var AContinue: Boolean) of object;
TfrmProgress = class(TJvForm)
pbProgress: TProgressBar;
imProgress: TImage;
lblStatus: TLabel;
btnCancel: TButton;
tmProgress: TTimer;
ActionList1: TActionList;
Action1: TAction;
procedure tmProgressTimer(Sender: TObject);
procedure btnCancelClick(Sender: TObject);
procedure FormPaint(Sender: TObject);
procedure Action1Execute(Sender: TObject);
private
FOnProgress: TJvPrivateProgressUpdate;
FOnCancel: TNotifyEvent;
FCancelled, FCanClose: Boolean;
function DoProgress: Boolean;
procedure DoCancel;
procedure AdjustComponents;
procedure RemoveCaption;
procedure AddCaption;
public
class function Execute(const ACaption, ALabel: string;
AImage: TPicture = nil; ATransparent: Boolean = False;
AMin: Integer = 0; AMax: Integer = 100; APosition: Integer = 0;
AInterval: Integer = 200; ShowCancel: Boolean = False; Smooth: Boolean = False;
AOnProgress: TJvPrivateProgressUpdate = nil;
AOnCancel: TNotifyEvent = nil): Boolean; overload;
class function Execute(Frm: TfrmProgress; const ACaption, ALabel: string;
AImage: TPicture = nil; ATransparent: Boolean = False;
AMin: Integer = 0; AMax: Integer = 100; APosition: Integer = 0;
AInterval: Integer = 200; ShowCancel: Boolean = False; Smooth: Boolean = False;
AOnProgress: TJvPrivateProgressUpdate = nil;
AOnCancel: TNotifyEvent = nil): Boolean; overload;
{$IFDEF SUPPORTS_DEPRECATED}
deprecated {$IFDEF SUPPORTS_DEPRECATED_DETAILS}'Use Execute(ACaption...) instead'{$ENDIF};
{$ENDIF SUPPORTS_DEPRECATED}
procedure Init(const ACaption, ALabel: string;
AImage: TPicture = nil; ATransparent: Boolean = False;
AMin: Integer = 0; AMax: Integer = 100; APosition: Integer = 0;
AInterval: Integer = 200; ShowCancel: Boolean = False; Smooth: Boolean = False;
AOnProgress: TJvPrivateProgressUpdate = nil;
AOnCancel: TNotifyEvent = nil);
function ShowModal: Integer; override;
end;
{$IFDEF UNITVERSIONING}
const
UnitVersioning: TUnitVersionInfo = (
RCSfile: '$URL: https://jvcl.svn.sourceforge.net/svnroot/jvcl/tags/JVCL3_39/run/JvProgressForm.pas $';
Revision: '$Revision: 12461 $';
Date: '$Date: 2009-08-14 19:21:33 +0200 (ven., 14 août 2009) $';
LogPath: 'JVCL\run'
);
{$ENDIF UNITVERSIONING}
implementation
uses
Consts;
{$R *.dfm}
class function TfrmProgress.Execute(const ACaption, ALabel: string;
AImage: TPicture; ATransparent: Boolean; AMin, AMax, APosition, AInterval: Integer;
ShowCancel, Smooth: Boolean; AOnProgress: TJvPrivateProgressUpdate; AOnCancel: TNotifyEvent): Boolean;
var
Frm: TfrmProgress;
begin
Frm := Self.Create(nil);
try
Frm.Init(ACaption, ALabel, AImage, ATransparent, AMin, AMax, APosition, AInterval,
ShowCancel, Smooth, AOnProgress, AOnCancel);
Result := Frm.ShowModal <> mrCancel
finally
Frm.Free;
end;
end;
class function TfrmProgress.Execute(Frm: TfrmProgress; const ACaption, ALabel: string;
AImage: TPicture; ATransparent: Boolean; AMin, AMax, APosition, AInterval: Integer;
ShowCancel, Smooth: Boolean; AOnProgress: TJvPrivateProgressUpdate; AOnCancel: TNotifyEvent): Boolean;
var
DoModal: Boolean;
begin
if Frm = nil then
begin
Frm := Self.Create(nil);
DoModal := True;
end
else
DoModal := False;
try
Frm.Init(ACaption, ALabel, AImage, ATransparent, AMin, AMax, APosition, AInterval,
ShowCancel, Smooth, AOnProgress, AOnCancel);
if DoModal then
Result := Frm.ShowModal <> mrCancel
else
begin
Result := False;
Frm.Show;
end;
finally
if DoModal then
Frm.Free;
end;
end;
procedure TfrmProgress.Init(const ACaption, ALabel: string;
AImage: TPicture; ATransparent: Boolean; AMin, AMax, APosition, AInterval: Integer;
ShowCancel, Smooth: Boolean; AOnProgress: TJvPrivateProgressUpdate; AOnCancel: TNotifyEvent);
begin
Caption := ACaption;
lblStatus.Caption := ALabel;
pbProgress.Min := AMin;
pbProgress.Max := AMax;
pbProgress.Position := APosition;
pbProgress.Smooth := Smooth;
FOnProgress := AOnProgress;
imProgress.Picture := AImage;
imProgress.Transparent := ATransparent;
tmProgress.Interval := AInterval;
tmProgress.Enabled := AInterval > 0;
btnCancel.Visible := ShowCancel;
FCanClose := ShowCancel;
btnCancel.Caption := SCancelButton;
FOnCancel := AOnCancel;
AdjustComponents;
end;
function TfrmProgress.DoProgress: Boolean;
var
AMin, AMax, APosition, AInterval: Integer;
ACaption, ALabel: string;
begin
Result := False;
if FCancelled then
Exit;
Result := True;
tmProgress.Enabled := False;
if Assigned(FOnProgress) then
begin
AMin := pbProgress.Min;
AMax := pbProgress.Max;
APosition := pbProgress.Position;
AInterval := tmProgress.Interval;
ACaption := Caption;
ALabel := lblStatus.Caption;
FOnProgress(Self, AMin, AMax, APosition, AInterval, ACaption, ALabel, imProgress.Picture, Result);
pbProgress.Min := AMin;
pbProgress.Max := AMax;
pbProgress.Position := APosition;
tmProgress.Interval := AInterval;
tmProgress.Enabled := AInterval > 0;
Caption := ACaption;
lblStatus.Caption := ALabel;
AdjustComponents;
Update;
end;
if not tmProgress.Enabled or not Result then
begin
ModalResult := mrCancel;
Close;
end;
end;
procedure TfrmProgress.AddCaption;
var
WindowLong: Cardinal;
begin
WindowLong := GetWindowLong(Handle, GWL_STYLE);
if WindowLong and WS_CAPTION = 0 then
begin
SetWindowLong(Handle, GWL_STYLE, WindowLong or WS_CAPTION);
BorderStyle := bsToolWindow;
Height := Height + GetSystemMetrics(SM_CYCAPTION);
Top := Top + GetSystemMetrics(SM_CYCAPTION);
Update;
end;
end;
procedure TfrmProgress.RemoveCaption;
var
WindowLong: Cardinal;
begin
WindowLong := GetWindowLong(Handle, GWL_STYLE);
if WindowLong and WS_CAPTION = WS_CAPTION then
begin
BorderStyle := bsDialog;
SetWindowLong(Handle, GWL_STYLE, WindowLong and not WS_CAPTION);
Height := Height - GetSystemMetrics(SM_CYCAPTION);
Top := Top - GetSystemMetrics(SM_CYCAPTION);
Update;
end;
end;
function TfrmProgress.ShowModal: Integer;
begin
// (p3) put topmost but only if not debugging
{$WARNINGS OFF}
if DebugHook = 0 then
{$WARNINGS ON}
SetWindowPos(Handle, HWND_TOPMOST, 0, 0, 0, 0, SWP_NOMOVE or SWP_NOSIZE);
if not tmProgress.Enabled then
DoProgress; // call at least once
Result := inherited ShowModal;
end;
procedure TfrmProgress.tmProgressTimer(Sender: TObject);
begin
if not FCancelled and not DoProgress or not tmProgress.Enabled then
begin
ModalResult := mrOk;
Close;
end;
end;
procedure TfrmProgress.btnCancelClick(Sender: TObject);
begin
FCancelled := True;
DoCancel;
end;
procedure TfrmProgress.AdjustComponents;
var
Offset: Integer;
begin
if Caption = '' then
RemoveCaption
else
AddCaption;
if (imProgress.Picture = nil) or (imProgress.Picture.Graphic = nil) or
imProgress.Picture.Graphic.Empty then
Offset := 12
else
begin
Offset := imProgress.Top + imProgress.Height + 12;
if ClientWidth - imProgress.Left * 2 < imProgress.Width then
ClientWidth := imProgress.Width + imProgress.Left * 2;
end;
lblStatus.Top := Offset;
Offset := lblStatus.Top + lblStatus.Height + 8;
pbProgress.Top := Offset;
Offset := pbProgress.Top + pbProgress.Height + 16;
if btnCancel.Visible then
begin
btnCancel.Top := pbProgress.Top + pbProgress.Height + 16;
Offset := btnCancel.Top + btnCancel.Height + 16;
end;
ClientHeight := Offset;
end;
procedure TfrmProgress.DoCancel;
begin
if Assigned(FOnCancel) then
FOnCancel(Self);
ModalResult := mrCancel;
Close;
end;
procedure TfrmProgress.FormPaint(Sender: TObject);
begin
if (imProgress.Picture.Graphic <> nil) and not imProgress.Picture.Graphic.Empty then
Canvas.Draw(imProgress.Left, imProgress.Top, imProgress.Picture.Graphic);
end;
procedure TfrmProgress.Action1Execute(Sender: TObject);
begin
if FCanClose then
DoCancel;
end;
{$IFDEF UNITVERSIONING}
initialization
RegisterUnitVersion(HInstance, UnitVersioning);
finalization
UnregisterUnitVersion(HInstance);
{$ENDIF UNITVERSIONING}
end.