Classe TProgressDlg_If

Descrição

Hierarquia

Tipos Aninhados

Campos

Métodos

Propriedades

Unit

mi.rtl.Objects.Consts.ProgressDlg_If

Declaração

type TProgressDlg_If = class(TObjectsConsts)

Descrição

A classe TProgressDlg_If é uma classe abstrata para comunicação com o usuário cujo a implementação deve ser feita nas plataformas: LCL, HTML e JavaScript.
- NOTA
  - Só cria o dialogo se a posição chegar no delta.
- Exemplo do uso de TProgressDlg_If
```
Var
  ProgressDlg_If : TProgressDlg_If;
Begin
  ProgressDlg_If := TProgressDlg_If.Create('Pesquisando registro',Alias,20);

  Repeat
    ProgressDlg_If.IncPosition;
  Until Not next;

  ProgressDlg_If.Free;
end.
```

Hierarquia

TObjectsTypes
TObjectsConsts
TProgressDlg_If

Visão Geral

Tipos Aninhados

	`TCreate_ProgressDlg = Function (Sender: TProgressDlg_If; Var aTitle : AnsiString; Var aobservation : AnsiString; Var aDelta : longint; Var aTotal : longint ):TComponent of object;`
	`TIncPosition = procedure of Object;`
	`TIncPosition_01 = procedure (Const aDelta :longint) Of object;`
	`TRedraw = procedure (a_Total : longint; a_LastPosition : longint; a_TimeCurrent : Longint; a_TimeBegin : Longint; a_TimeForeseen : Longint; a_Percent : SmallInt ) of object;`

Campos

	`Var _TimeCurrent: Longint;`
	`Var _TimeBegin: Longint;`
	`Var _TimeForeseen: Longint;`
	`Var _Percent: SmallInt;`

Métodos

	`procedure Set_Total(aTotal: Longint); Virtual;`
	`procedure Set_Delta(aDelta: Longint); Virtual;`
	`procedure Set_Limit(aLimit: Longint); Virtual;`
	`procedure Set_Title(aTitle: AnsiString); Virtual;`
	`procedure Set_observation(aobservation: AnsiString); Virtual;`
	`Procedure Create_ProgressDlg; overload; Virtual;`
	`Procedure RegisterOnEvents; Virtual;`
	`constructor Create(AOwner: TComponent); Overload; override;`
	`constructor Create(aTitle : AnsiString; aobservation : AnsiString; aDelta, aTotal : longint ); Overload; Virtual;`
	`Destructor Destroy; Override;`
	`procedure IncPosition(Const aDelta :longint); Overload; Virtual;`
	`procedure IncPosition; Overload; Virtual;`
	`Procedure Redraw; Virtual;`
	`procedure SetPerc(const aPosition : longint);`

Propriedades

	`property Total: Longint Read _Total Write Set_Total;`
	`property Delta: Longint Read _Delta Write Set_Delta;`
	`property Limit: Longint Read _Limit Write Set_Limit;`
	`property Title: AnsiString Read _Title Write Set_Title;`
	`property observation: AnsiString Read _observation Write Set_observation;`
	`property onCreate_ProgressDlg: TCreate_ProgressDlg Read _onCreate_ProgressDlg Write _onCreate_ProgressDlg;`
	`property onIncPosition_01: TIncPosition_01 Read _onIncPosition_01 Write _onIncPosition_01;`
	`property onIncPosition: TIncPosition Read _onIncPosition Write _onIncPosition;`
	`property OnRedraw: TRedraw Read _OnRedraw Write _OnRedraw;`

Descrição

Tipos Aninhados

	`TCreate_ProgressDlg = Function (Sender: TProgressDlg_If; Var aTitle : AnsiString; Var aobservation : AnsiString; Var aDelta : longint; Var aTotal : longint ):TComponent of object;`

	`TIncPosition = procedure of Object;`

	`TIncPosition_01 = procedure (Const aDelta :longint) Of object;`

	`TRedraw = procedure (a_Total : longint; a_LastPosition : longint; a_TimeCurrent : Longint; a_TimeBegin : Longint; a_TimeForeseen : Longint; a_Percent : SmallInt ) of object;`
O evento `TRedraw` é usado para atualiza a tela.

Campos

	`Var _TimeCurrent: Longint;`

	`Var _TimeBegin: Longint;`

	`Var _TimeForeseen: Longint;`

	`Var _Percent: SmallInt;`

Métodos

	`procedure Set_Total(aTotal: Longint); Virtual;`

	`procedure Set_Delta(aDelta: Longint); Virtual;`

	`procedure Set_Limit(aLimit: Longint); Virtual;`

	`procedure Set_Title(aTitle: AnsiString); Virtual;`

	`procedure Set_observation(aobservation: AnsiString); Virtual;`

	`Procedure Create_ProgressDlg; overload; Virtual;`
A procedure `Create_ProgressDlg` deve ser anulada para implementar a criação do diálogo no pacote visual ou seja: Na interface do usuário que pode ser LCL, Javascript, tv32 etc..

	`Procedure RegisterOnEvents; Virtual;`
A procedure `RegisterOnEvents` deve ser anulada para implementar os eventos desta classe caso a mesma não esteja registrada na IDE

	`constructor Create(AOwner: TComponent); Overload; override;`
O constructor `Create` é necessário porque essa classe pode ser registrada da IDE

	`constructor Create(aTitle : AnsiString; aobservation : AnsiString; aDelta, aTotal : longint ); Overload; Virtual;`
O constructor `Create` é usado para criar a classe sem a IDE

	`Destructor Destroy; Override;`
O destructor `Destroy` é usado para destruir a classe.

	`procedure IncPosition(Const aDelta :longint); Overload; Virtual;`
A propriedade `IncPosition` deve ser anulada na classe visual para incrementar aDelta na posição atual do processamento.

	`procedure IncPosition; Overload; Virtual;`
A propriedade `IncPosition` deve ser anulada na classe visual para incrementar 1 na posição atual do processamento.

	`Procedure Redraw; Virtual;`
A propriedade `Redraw` deve ser anulada para implementar na classe visual para atualizar a tela com a posição atual do processamento.

procedure SetPerc(const aPosition : longint);

A procedure SetPerc é usado para informar ao dialogo a posição atual da contagem.

NOTA
- Calcula o percentual atual do processamento.

Propriedades

	`property Total: Longint Read _Total Write Set_Total;`
A propriedade `Total` é o `total` de elementos previstos na lista ao inicial o dialogo

	`property Delta: Longint Read _Delta Write Set_Delta;`
A propriedade `Delta` informado ao dialogo o intervalo no qual o dialogo precisa ser criado para que o usuário veja a previsão de termino.

	`property Limit: Longint Read _Limit Write Set_Limit;`
A propriedade `Limit` é o numero de linhas do controle que está sendo visualizado.

	`property Title: AnsiString Read _Title Write Set_Title;`
A propriedade `Title` é usado no título do dialogo indicando a tarefa que está sendo executada.

	`property observation: AnsiString Read _observation Write Set_observation;`
A propriedade `observation` é usado na barra de status do dialogo indicando qual o atalho aborta a operação

	`property onCreate_ProgressDlg: TCreate_ProgressDlg Read _onCreate_ProgressDlg Write _onCreate_ProgressDlg;`
A propriedade `onCreate_ProgressDlg` deve ser implementado no pacote visual ou seja: Na interface do usuário que pode ser LCL, Javascript, tv32 etc..

	`property onIncPosition_01: TIncPosition_01 Read _onIncPosition_01 Write _onIncPosition_01;`
A propriedade `onIncPosition_01` deve ser implementada na classe visual para incrementar aDelta na posição atual do processamento.

	`property onIncPosition: TIncPosition Read _onIncPosition Write _onIncPosition;`
A propriedade `onIncPosition` deve ser implementada na classe visual para incrementar 1 na posição atual do processamento.

	`property OnRedraw: TRedraw Read _OnRedraw Write _OnRedraw;`
A propriedade `OnRedraw` deve ser implementada na classe visual para atualizar a tela com a posição atual do processamento.

Gerado por PasDoc 0.16.0.