Class tcustomrecordband

Description
Hierarchy
Fields
Methods
Properties

Unit

msereport

Declaration

type tcustomrecordband = class(tcustomscalingwidget, idbeditinfo, ireccontrol, iobjectpicker, ireportclient, icaptionframe)

Description

This item has no description. Showing description inherited from tmsecomponent.

Extends the FPC tcomponent with object linking facilities and the like; base of every MSEgui component. This unit, mseclasses, must be added to uses after classes in code that also uses a third-party unit expecting the plain FPC tcomponent (e.g. TPSScript.Create(TComponent)), since MSEgui forks the FPC classes unit.

Hierarchy

Overview

Fields

Protected fstate: recordbandstatesty;

Methods

Protected procedure setfont(const avalue: trepwidgetfont);
Protected function getfont: trepwidgetfont;
Protected function getfontclass: widgetfontclassty; override;
Protected procedure internalcreateframe() override;
Protected procedure registerchildwidget(const child: twidget); override;
Protected procedure unregisterchildwidget(const child: twidget); override;
Protected procedure minclientsizechanged;
Protected procedure objectevent(const sender: tobject; const event: objecteventty); override;
Protected procedure fontchanged; override;
Protected procedure clientrectchanged() override;
Protected procedure inheritedpaint(const acanvas: tcanvas);
Protected procedure parentchanged; override;
Protected function getminbandsize: sizety; virtual;
Protected function calcminscrollsize: sizety; override;
Protected function textarea(): rectty;
Protected procedure render(const acanvas: tcanvas; var empty: boolean); virtual;
Protected procedure init; virtual;
Protected procedure initpage; virtual;
Protected procedure beginrender(const arestart: boolean); virtual;
Protected procedure endrender; virtual;
Protected procedure adddatasets(var adatasets: datasetarty); virtual;
Protected procedure dopaintforeground(const acanvas: tcanvas); override;
Protected procedure doonpaint(const acanvas: tcanvas); override;
Protected procedure doafterpaint(const acanvas: tcanvas); override;
Protected procedure dobeforenextrecord(const adatasource: tdatasource); virtual;
Protected procedure dosyncnextrecord; virtual;
Protected procedure nextrecord(const setflag: boolean = true);
Protected function rendering: boolean;
Protected function bandheight: integer;
Protected procedure dobeforerender(var empty: boolean); virtual;
Protected function bandisvisible(const checklast: boolean): boolean;
Protected function getvisibility: boolean;
Protected procedure updatevisibility; virtual;
Protected function lastbandheight: integer; virtual;
Protected procedure loaded; override;
Protected procedure setppmm(const avalue: real);
Protected procedure clientmouseevent(var info: mouseeventinfoty); override;
Protected function getcursorshape(const sender: tobjectpicker; var ashape: cursorshapety): boolean;
Protected procedure getpickobjects(const sender: tobjectpicker; var aobjects: integerarty);
Protected procedure beginpickmove(const sender: tobjectpicker);
Protected procedure pickthumbtrack(const sender: tobjectpicker);
Protected procedure endpickmove(const sender: tobjectpicker);
Protected procedure cancelpickmove(const sender: tobjectpicker);
Protected procedure paintxorpic(const sender: tobjectpicker; const acanvas: tcanvas);
Public constructor create(aowner: tcomponent); override;
Public destructor destroy; override;
Public procedure paint(const canvas: tcanvas); override;
Public function actualcolor: colorty; override;
Public procedure scale(const ascale: real); override;
Public procedure synctofontheight; override;
Public procedure beginupdate;
Public procedure endupdate;
Public function remainingbands: integer;
Public function reppage: tcustomreportpage;
Public procedure finish;
Public function isfirstrecord: boolean;
Public function islastrecord: boolean;
Public function isfirstofgroup: boolean;
Public function islastofgroup: boolean;
Public procedure restart;
Public procedure resetzebra; virtual;

Properties

Public property textframe: int32 read ftextframe write settextframe default 1;
Public property tabs: treptabulators read ftabs write settabs;
Public property font: trepwidgetfont read getfont write setfont stored isfontstored;
Public property datasource: tdatasource read getdatasource write setdatasource;
Public property visidatasource: tdatasource read getvisidatasource write setvisidatasource;
Public property visidatafield: string read getvisidatafield write setvisidatafield;
Public property visigroupfield: string read getvisigroupfield write setvisigroupfield;
Public property options: bandoptionsty read foptions write foptions default [];
Public property optionsshow: bandoptionshowsty read foptionsshow write setoptionsshow default [];
Public property nextband: tcustomrecordband read fnextband write setnextband;
Public property nextbandiflastofarea: tcustomrecordband read fnextbandiflastofarea write setnextbandiflastofarea;
Public property nextbandifempty: tcustomrecordband read fnextbandifempty write setnextbandifempty;
Public property nextbandiflast: tcustomrecordband read fnextbandiflast write setnextbandiflast;
Public property zebra_counter: integer read fzebra_counter write fzebra_counter;
Public property zebra_color: colorty read fzebra_color write fzebra_color default cl_infobackground;
Public property zebra_start: integer read fzebra_start write fzebra_start default 0;
Public property zebra_height: integer read fzebra_height write fzebra_height default 0;
Public property zebra_step: integer read fzebra_step write fzebra_step default 2;
Public property zebra_options: zebraoptionsty read fzebra_options write fzebra_options default [];
Public property onbeforerender: beforerenderrecordeventty read fonbeforerender write fonbeforerender;
Public property onpaint: painteventty read fonpaint write fonpaint;
Public property onafterpaint: painteventty read fonafterpaint write fonafterpaint;
Public property onafterrender: recordbandeventty read fonafterrender write fonafterrender;
Public property onbeforenextrecord: notifyeventty read fonbeforenextrecord write fonbeforenextrecord;
Public property onafternextrecord: notifyeventty read fonafternextrecord write fonafternextrecord;
Published property anchors default defaultbandanchors;
Published property optionswidget default defaultbandoptionswidget;

Description

Fields

Protected fstate: recordbandstatesty;

This item has no description.

Methods

Protected procedure setfont(const avalue: trepwidgetfont);

This item has no description.

Protected function getfont: trepwidgetfont;

This item has no description.

Protected function getfontclass: widgetfontclassty; override;

This item has no description.

Protected procedure internalcreateframe() override;

This item has no description.

Protected procedure registerchildwidget(const child: twidget); override;

This item has no description.

Protected procedure unregisterchildwidget(const child: twidget); override;

This item has no description.

Protected procedure minclientsizechanged;

This item has no description.

Protected procedure objectevent(const sender: tobject; const event: objecteventty); override;

This item has no description.

Protected procedure fontchanged; override;

This item has no description.

Protected procedure clientrectchanged() override;

This item has no description.

Protected procedure inheritedpaint(const acanvas: tcanvas);

This item has no description.

Protected procedure parentchanged; override;

This item has no description.

Protected function getminbandsize: sizety; virtual;

This item has no description.

Protected function calcminscrollsize: sizety; override;

This item has no description.

Protected function textarea(): rectty;

This item has no description.

Protected procedure render(const acanvas: tcanvas; var empty: boolean); virtual;

This item has no description.

Protected procedure init; virtual;

This item has no description.

Protected procedure initpage; virtual;

This item has no description.

Protected procedure beginrender(const arestart: boolean); virtual;

This item has no description.

Protected procedure endrender; virtual;

This item has no description.

Protected procedure adddatasets(var adatasets: datasetarty); virtual;

This item has no description.

Protected procedure dopaintforeground(const acanvas: tcanvas); override;

This item has no description.

Protected procedure doonpaint(const acanvas: tcanvas); override;

This item has no description.

Protected procedure doafterpaint(const acanvas: tcanvas); override;

This item has no description. Showing description inherited from twidget.doafterpaint.

Override doafterpaint to draw over the widget's child widgets, after they have painted.

Protected procedure dobeforenextrecord(const adatasource: tdatasource); virtual;

This item has no description.

Protected procedure dosyncnextrecord; virtual;

This item has no description.

Protected procedure nextrecord(const setflag: boolean = true);

This item has no description.

Protected function rendering: boolean;

This item has no description.

Protected function bandheight: integer;

This item has no description.

Protected procedure dobeforerender(var empty: boolean); virtual;

This item has no description.

Protected function bandisvisible(const checklast: boolean): boolean;

This item has no description.

Protected function getvisibility: boolean;

This item has no description.

Protected procedure updatevisibility; virtual;

This item has no description.

Protected function lastbandheight: integer; virtual;

This item has no description.

Protected procedure loaded; override;

This item has no description.

Protected procedure setppmm(const avalue: real);

This item has no description.

Protected procedure clientmouseevent(var info: mouseeventinfoty); override;

This item has no description.

Protected function getcursorshape(const sender: tobjectpicker; var ashape: cursorshapety): boolean;

This item has no description.

Protected procedure getpickobjects(const sender: tobjectpicker; var aobjects: integerarty);

This item has no description.

Protected procedure beginpickmove(const sender: tobjectpicker);

This item has no description.

Protected procedure pickthumbtrack(const sender: tobjectpicker);

This item has no description.

Protected procedure endpickmove(const sender: tobjectpicker);

This item has no description.

Protected procedure cancelpickmove(const sender: tobjectpicker);

This item has no description.

Protected procedure paintxorpic(const sender: tobjectpicker; const acanvas: tcanvas);

This item has no description.

Public constructor create(aowner: tcomponent); override;

This item has no description.

Public destructor destroy; override;

This item has no description.

Public procedure paint(const canvas: tcanvas); override;

This item has no description. Showing description inherited from twidget.paint.

invalidate (called automatically, e.g. by setcaption) adds the widget's client area to its window's update region; once the main event queue is empty, the update regions of all windows are painted, widget by widget, bottom-up in z-order, by paint. If the widget's color is not cl_transparent, the area is first filled with that color; then, if active, frame is painted (filling its own client area with colorclient if that is not cl_transparent), then, if active, face; the widget's own content (e.g. a caption) is painted last, on top of that background. When code changes a widget's widgetrect directly rather than through a property that does it automatically, it must invalidate the old widgetrect before the change and the new one after, so both the vacated and the newly covered area get repainted.

Public function actualcolor: colorty; override;

This item has no description.

Public procedure scale(const ascale: real); override;

This item has no description.

Public procedure synctofontheight; override;

This item has no description.

Public procedure beginupdate;

This item has no description.

Public procedure endupdate;

This item has no description.

Public function remainingbands: integer;

This item has no description.

Public function reppage: tcustomreportpage;

This item has no description.

Public procedure finish;

This item has no description.

Public function isfirstrecord: boolean;

This item has no description.

Public function islastrecord: boolean;

This item has no description.

Public function isfirstofgroup: boolean;

This item has no description.

Public function islastofgroup: boolean;

This item has no description.

Public procedure restart;

This item has no description.

Public procedure resetzebra; virtual;

This item has no description.

Properties

Public property textframe: int32 read ftextframe write settextframe default 1;

This item has no description.

Public property tabs: treptabulators read ftabs write settabs;

This item has no description.

Public property font: trepwidgetfont read getfont write setfont stored isfontstored;

This item has no description.

Public property datasource: tdatasource read getdatasource write setdatasource;

This item has no description.

Public property visidatasource: tdatasource read getvisidatasource write setvisidatasource;

This item has no description.

Public property visidatafield: string read getvisidatafield write setvisidatafield;

This item has no description.

Public property visigroupfield: string read getvisigroupfield write setvisigroupfield;

This item has no description.

Public property options: bandoptionsty read foptions write foptions default [];

This item has no description.

Public property optionsshow: bandoptionshowsty read foptionsshow write setoptionsshow default [];

Groups the band's bo_show*/bo_hide* visibility flags (e.g. relative to top-of-page), kept in their own property since the 32-flag limit of a single set was reached by options.

Public property nextband: tcustomrecordband read fnextband write setnextband;

This item has no description.

Public property nextbandiflastofarea: tcustomrecordband read fnextbandiflastofarea write setnextbandiflastofarea;

This item has no description.

Public property nextbandifempty: tcustomrecordband read fnextbandifempty write setnextbandifempty;

This item has no description.

Public property nextbandiflast: tcustomrecordband read fnextbandiflast write setnextbandiflast;

This item has no description.

Public property zebra_counter: integer read fzebra_counter write fzebra_counter;

This item has no description.

Public property zebra_color: colorty read fzebra_color write fzebra_color default cl_infobackground;

This item has no description.

Public property zebra_start: integer read fzebra_start write fzebra_start default 0;

This item has no description.

Public property zebra_height: integer read fzebra_height write fzebra_height default 0;

This item has no description.

Public property zebra_step: integer read fzebra_step write fzebra_step default 2;

This item has no description.

Public property zebra_options: zebraoptionsty read fzebra_options write fzebra_options default [];

This item has no description.

Public property onbeforerender: beforerenderrecordeventty read fonbeforerender write fonbeforerender;

Called before the band is rendered — but if the band does not fit on the current page, rendering is aborted and retried on a new page, so onbeforerender can fire more than once for the same record. Use onpaint or onafterpaint instead (or embed the band in a trecordgroup) for code that must run exactly once per rendered record, e.g. incrementing a counter.

Public property onpaint: painteventty read fonpaint write fonpaint;

This item has no description.

Public property onafterpaint: painteventty read fonafterpaint write fonafterpaint;

This item has no description.

Public property onafterrender: recordbandeventty read fonafterrender write fonafterrender;

This item has no description.

Public property onbeforenextrecord: notifyeventty read fonbeforenextrecord write fonbeforenextrecord;

This item has no description.

Public property onafternextrecord: notifyeventty read fonafternextrecord write fonafternextrecord;

This item has no description.

Published property anchors default defaultbandanchors;

This item has no description. Showing description inherited from twidget.anchors.

Controls how the widget's position and size follow the resizing of its parent, independently for each edge (an_left, an_top, an_right, an_bottom): with both edges of a dimension False, position is 0 and size always equals the parent's paint area (as with Delphi's Align = alClient); with only the leading edge True, the leading position and the size are constant; with only the trailing edge True, the trailing edge follows the parent's trailing edge and the size stays constant; with both edges True, the leading position is constant and the size is synchronized with the parent's size. Setting anchors to [] makes the widget fill the parent's paint area on both axes.

Published property optionswidget default defaultbandoptionswidget;

This item has no description.

Generated by PasDoc 1.0.4.