summaryrefslogtreecommitdiff
path: root/src/gui/fpg_customgrid.pas
blob: 980403749c01b2d70339a3b5335d0ac3164090e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
{
    fpGUI  -  Free Pascal GUI Toolkit

    Copyright (C) 2006 - 2010 See the file AUTHORS.txt, included in this
    distribution, for details of the copyright.

    See the file COPYING.modifiedLGPL, included in this distribution,
    for details about redistributing fpGUI.

    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.

    Description:
      Defines a Custom Grid control and basic Column class.
}

unit fpg_customgrid;

{$mode objfpc}{$H+}

{
  TODO:
    * Column text alignment needs to be implemented. Currently always Centre.
}

{.$Define DEBUG}

interface

uses
  Classes,
  SysUtils,
  fpg_base,
  fpg_main,
  fpg_basegrid;
  
type

  // data object for grid columns
  TfpgGridColumn = class(TObject)
  private
    FAlignment: TAlignment;
    FLayout: TLayout;
    FHMargin: Integer;
    FTitle: string;
    FWidth: integer;
    FBackgroundColor: TfpgColor;
    FTextColor: TfpgColor;
  public
    constructor Create; virtual;
    property    Width: integer read FWidth write FWidth;
    property    Title: string read FTitle write FTitle;
    property    Alignment: TAlignment read FAlignment write FAlignment;
    property    Layout: TLayout read FLayout write FLayout;
    property    BackgroundColor: TfpgColor read FBackgroundColor write FBackgroundColor;
    property    HMargin: Integer read FHMargin write FHMargin;
    property    TextColor: TfpgColor read FTextColor write FTextColor;
  end;
  
  
  TfpgCustomGrid = class(TfpgBaseGrid)
  protected
    FRowCount: Integer;
    FColumns: TFPList;
    procedure   HandleSetFocus; override;
    procedure   SetTextColor(const AValue: TfpgColor); override;
    procedure   SetBackgroundColor(const AValue: TfpgColor); override;
    function    GetColumns(AIndex: integer): TfpgGridColumn; virtual;
    procedure   DoDeleteColumn(ACol: integer); virtual;
    procedure   DoSetRowCount(AValue: integer); virtual;
    procedure   DoAfterAddColumn(ACol: integer); virtual;
    function    DoCreateColumnClass: TfpgGridColumn; virtual;
    function    GetColumnCount: Integer; override;
    procedure   SetColumnCount(const AValue: Integer); virtual;
    function    GetRowCount: Integer; override;
    procedure   SetRowCount(const AValue: Integer); virtual;
    function    GetColumnWidth(ACol: Integer): integer; override;
    procedure   SetColumnWidth(ACol: Integer; const AValue: integer); override;
    function    GetColumnBackgroundColor(ACol: Integer): TfpgColor; override;
    procedure   SetColumnBackgroundColor(ACol: Integer; const AValue: TfpgColor); override;
    function    GetColumnTextColor(ACol: Integer): TfpgColor; override;
    procedure   SetColumnTextColor(ACol: Integer; const AValue: TfpgColor); override;
    function    GetHeaderText(ACol: Integer): string; override;
    property    RowCount: Integer read GetRowCount write SetRowCount;
    property    ColumnCount: Integer read GetColumnCount write SetColumnCount;
    property    Columns[AIndex: integer]: TfpgGridColumn read GetColumns;
//    property AlternateColor: TColor read FAlternateColor write SetAlternateColor stored IsAltColorStored;
  public
    constructor Create(AOwner: TComponent); override;
    destructor  Destroy; override;
    function    AddColumn(ATitle: string; AWidth: integer): TfpgGridColumn; virtual;
    procedure   DeleteColumn(AIndex: integer); virtual;
    procedure   DeleteRow(AIndex: integer); virtual;
    procedure   MoveColumn(oldindex, newindex: integer); virtual;
  end;
  
  
implementation

{ TfpgGridColumn }

constructor TfpgGridColumn.Create;
begin
  Width     := 65;
  Title     := '';
  Alignment := taLeftJustify;
  Layout := tlCenter;
  HMargin := 2;
end;

{ TfpgCustomGrid }

function TfpgCustomGrid.GetRowCount: Integer;
begin
  Result := FRowCount;
end;

procedure TfpgCustomGrid.HandleSetFocus;
begin
  inherited HandleSetFocus;
  if (GetRowCount > 0) and (FocusRow = -1) then
  begin
    FocusRow := 0;
    FocusCol := 0;
//    Repaint;
    Update;
  end;
end;

procedure TfpgCustomGrid.SetTextColor(const AValue: TfpgColor);
var
  i: integer;
begin
  inherited SetTextColor(AValue);
  for i := 0 to ColumnCount-1 do
  begin
    TfpgGridColumn(FColumns.Items[i]).TextColor := AValue;
  end;
//  Repaint;
  Update;
end;

procedure TfpgCustomGrid.SetBackgroundColor(const AValue: TfpgColor);
var
  i: integer;
begin
  inherited SetBackgroundColor(AValue);
  for i := 0 to ColumnCount-1 do
  begin
    TfpgGridColumn(FColumns.Items[i]).BackgroundColor := AValue;
  end;
  RePaint;
end;

function TfpgCustomGrid.GetColumns(AIndex: integer): TfpgGridColumn;
begin
  if (AIndex < 0) or (AIndex > FColumns.Count-1) then
    Result := nil
  else
    Result := TfpgGridColumn(FColumns[AIndex]);
end;

procedure TfpgCustomGrid.DoDeleteColumn(ACol: integer);
begin
  TfpgGridColumn(FColumns.Items[ACol]).Free;
  FColumns.Delete(ACol);
end;

procedure TfpgCustomGrid.DoSetRowCount(AValue: integer);
begin
  // do nothing yet
end;

procedure TfpgCustomGrid.DoAfterAddColumn(ACol: integer);
begin
  // do nothing yet
  // update empty cells in descendants
end;

function TfpgCustomGrid.DoCreateColumnClass: TfpgGridColumn;
begin
  Result := TfpgGridColumn.Create;
end;

function TfpgCustomGrid.GetColumnCount: Integer;
begin
  Result := FColumns.Count;
end;

procedure TfpgCustomGrid.SetColumnCount(const AValue: Integer);
var
  n: Integer;
begin
  n := FColumns.Count;
  if (n = AValue) or (AValue < 0) then
    Exit; //==>

  if n < AValue then
  begin
    // adding columns
    while n < AValue do
    begin
      AddColumn('', DefaultColWidth);
      inc(n);
    end;
  end
  else
  begin
    // removing columns
    while n > AValue do
    begin
      DoDeleteColumn(n-1);
      dec(n);
    end;
  end;
  
  // graemeg 2008-07-18: I believe after all the repaint and event fixes
  //   this check is not required anymore.
  //if csUpdating in ComponentState then
    //Exit;
  Update;
  //UpdateScrollBars;
  //RePaint;

end;

procedure TfpgCustomGrid.SetRowCount(const AValue: Integer);
begin
  if FRowCount = AValue then
    Exit; //==>
  BeginUpdate;
  try
    FRowCount := AValue;
    if FocusRow > FRowCount-1 then
      FocusRow := FRowCount-1;
    DoSetRowCount(AValue);  // could be implemented by descendants
  finally
    EndUpdate;
  end;
end;

function TfpgCustomGrid.GetColumnWidth(ACol: Integer): integer;
begin
  if (ACol >= 0) and (ACol < ColumnCount) then
    Result := TfpgGridColumn(FColumns[ACol]).Width
  else
    result := DefaultColWidth;
end;

procedure TfpgCustomGrid.SetColumnWidth(ACol: Integer; const AValue: integer);
var
  lCol: TfpgGridColumn;
begin
  lCol := TfpgGridColumn(FColumns[ACol]);
  
  if lCol.Width <> AValue then
  begin
    if AValue < 1 then
      lCol.Width := 1
    else
      lCol.Width := AValue;
    Update;
    //UpdateScrollBars;
    //Repaint;
  end;
end;

function TfpgCustomGrid.GetColumnBackgroundColor(ACol: Integer): TfpgColor;
begin
  if (ACol >= 0) and (ACol < ColumnCount) then
    Result := TfpgGridColumn(FColumns[ACol]).FBackgroundColor
  else
    Result := BackgroundColor;
end;

procedure TfpgCustomGrid.SetColumnBackgroundColor(ACol: Integer; const AValue: TfpgColor);
var
  lCol: TfpgGridColumn;
begin
  lCol := TfpgGridColumn(FColumns[ACol]);

  if lCol.FBackgroundColor <> AValue then
  begin
    lCol.FBackgroundColor := AValue;
    Update;
    //Repaint;
  end;
end;

function TfpgCustomGrid.GetColumnTextColor(ACol: Integer): TfpgColor;
begin
  if (ACol >= 0) and (ACol < ColumnCount) then
    Result := TfpgGridColumn(FColumns[ACol]).FTextColor
  else
    result := TextColor;
end;

procedure TfpgCustomGrid.SetColumnTextColor(ACol: Integer; const AValue: TfpgColor);
var
  lCol: TfpgGridColumn;
begin
  lCol := TfpgGridColumn(FColumns[ACol]);

  if lCol.FTextColor <> AValue then
  begin
    lCol.FTextColor := AValue;
//    UpdateScrollBars;
    Repaint;
  end;
end;

function TfpgCustomGrid.GetHeaderText(ACol: Integer): string;
begin
  Result := TfpgGridColumn(FColumns[ACol]).Title;
end;

constructor TfpgCustomGrid.Create(AOwner: TComponent);
begin
  FColumns := TFPList.Create;
  inherited Create(AOwner);
  ColumnCount := 0;
  RowCount    := 0;
end;

destructor TfpgCustomGrid.Destroy;
var
  i: integer;
begin
  for i := FColumns.Count-1 downto 0 do
  begin
    TfpgGridColumn(FColumns.Items[i]).Free;
  end;
  FColumns.Free;
  inherited Destroy;
end;

function TfpgCustomGrid.AddColumn(ATitle: string; AWidth: integer): TfpgGridColumn;
var
  i: integer;
begin
  Result := DoCreateColumnClass;
  Result.Title := ATitle;
  Result.Width := AWidth;
  Result.Backgroundcolor := clBoxcolor;
  Result.TextColor := TextColor;
  i := FColumns.Add(Result);
  DoAfterAddColumn(i);  // update empty cells in descendants
  
  //if csUpdating in ComponentState then
    //Exit; //==>
  Update;
  //UpdateScrollBars;
  //RePaint;
end;

procedure TfpgCustomGrid.DeleteColumn(AIndex: integer);
var
  c: TfpgGridColumn;
begin
  c := Columns[AIndex];
  if c <> nil then
  begin
    DoDeleteColumn(AIndex);
    if HasHandle then
      Update;
  end;
end;

procedure TfpgCustomGrid.DeleteRow(AIndex: integer);
begin
  if (AIndex < 0) or (AIndex > FRowCount-1) then
    Exit;
  { This is just some sanity checking. Actual row deletion must occur in
    descendant classed. See TfpgStringGrid for an example. }
end;

procedure TfpgCustomGrid.MoveColumn(oldindex, newindex: integer);
begin
  FColumns.Move(oldindex, newindex);
  if HasHandle then
    Update;
end;

end.