Class tcanvas

Unit

msegraphics

Declaration

type tcanvas = class(tpersistent)

Description

Hierarchy

• TObject
• tpersistent
• tcanvas

Overview

Fields

	fuser: tobject;
	fintf: pointer;
	fstate: canvasstatesty;
	fvaluepo: canvasvaluespoty;
	fdrawinfo: drawinfoty;
	gcfonthandle1: fontnumty;
	afonthandle1: fontnumty;
	ffont: tfont;
	target: tobject;
	drawinfopo: pointer;

Methods

	function getgdifuncs: pgdifunctionaty; virtual;
	procedure registergclink(const dest: tcanvas);
	procedure unregistergclink(const dest: tcanvas);
	procedure gcdestroyed(const sender: tcanvas); virtual;
	procedure setppmm(avalue: real); virtual;
	function getfitrect: rectty; virtual;
	procedure valuechanged(value: canvasstatety); inline;
	procedure valueschanged(values: canvasstatesty); inline;
	procedure initgcvalues; virtual;
	procedure initgcstate; virtual;
	procedure finalizegcstate; virtual;
	procedure checkrect(const rect: rectty);
	procedure checkgcstate(state: canvasstatesty); virtual;
	procedure checkregionstate;
	function defaultcliprect: rectty; virtual;
	function lock: boolean; virtual;
	procedure unlock; virtual;
	procedure doflush;
	procedure gdi(const func: gdifuncty); virtual;
	procedure init;
	procedure beforeread;
	procedure afterread;
	procedure internalcopyarea(asource: tcanvas; const asourcerect: rectty; const adestrect: rectty; acopymode: rasteropty; atransparentcolor: colorty; amask: tsimplebitmap; const amaskpos: pointty; aalignment: alignmentsty; const atileorigin: pointty; const aopacity: colorty);
	procedure setcliporigin(const Value: pointty);
	function getgchandle: ptruint;
	function getcanvasimage(const abgr: boolean = false): imagety;
	function getimage(const bgr: boolean): maskedimagety;
	procedure fillarc(const def: rectty; const startang,extentang: real; const acolor: colorty; const pieslice: boolean);
	procedure getarcinfo(out startpo,endpo: pointty);
	procedure internaldrawtext(var info); virtual;
	function createfont: tcanvasfont; virtual;
	procedure drawfontline(const startpoint,endpoint: pointty);
	procedure nextpage; virtual;
	function getcontextinfopo: pointer; virtual;
	procedure updatesize(const asize: sizety); virtual;
	procedure movewindowrect(const adist: pointty; const arect: rectty);
	procedure defineproperties(filer: tfiler); override;
	constructor create(const user: tobject; const intf: icanvas); virtual;
	destructor destroy; override;
	class function getclassgdifuncs: pgdifunctionaty; virtual;
	procedure updatewindowoptions(var aoptions: internalwindowoptionsty); virtual;
	function creategc(const apaintdevice: paintdevicety; const akind: gckindty; var gc: gcty; const aprintername: msestring = ''): gdierrorty;
	procedure linktopaintdevice(apaintdevice: paintdevicety; const gc: gcty; const cliporigin: pointty); virtual;
	procedure fitppmm(const asize: sizety);
	function size: sizety;
	function highresdevice: boolean;
	procedure initflags(const dest: tcanvas); virtual;
	procedure unlink;
	procedure initdrawinfo(var adrawinfo: drawinfoty);
	function active: boolean;
	procedure reset; virtual;
	function save: integer;
	function restore(index: integer = -1): integer;
	procedure resetpaintedflag;
	procedure endpaint;
	procedure move(const dist: pointty);
	procedure remove(const dist: pointty);
	procedure copyarea(const asource: tcanvas; const asourcerect: rectty; const adestpoint: pointty; const acopymode: rasteropty = rop_copy; const atransparentcolor: colorty = cl_default; const aopacity: colorty = cl_none); overload;
	procedure copyarea(const asource: tcanvas; const asourcerect: rectty; const adestrect: rectty; const alignment: alignmentsty = []; const acopymode: rasteropty = rop_copy; const atransparentcolor: colorty = cl_default; const aopacity: colorty = cl_none); overload;
	procedure drawpoint(const point: pointty; const acolor: colorty = cl_default);
	procedure drawpoints(const apoints: array of pointty; const acolor: colorty = cl_default; first: integer = 0; acount: integer = -1);
	procedure drawline(const startpoint,endpoint: pointty; const acolor: colorty = cl_default);
	procedure drawline(const startpoint: pointty; const length: sizety; const acolor: colorty = cl_default);
	procedure drawlinesegments(const apoints: array of segmentty; const acolor: colorty = cl_default);
	procedure drawlines(const apoints: array of pointty; const aclosed: boolean = false; const acolor: colorty = cl_default; const first: integer = 0; const acount: integer = -1); overload;
	procedure drawlines(const apoints: array of pointty; const abreaks: array of integer; const aclosed: boolean = false; const acolor: colorty = cl_default; const first: integer = 0; const acount: integer = -1); overload;
	procedure drawvect(const startpoint: pointty; const direction: graphicdirectionty; const length: integer; const acolor: colorty = cl_default); overload;
	procedure drawvect(const startpoint: pointty; const direction: graphicdirectionty; const length: integer; out endpoint: pointty; const acolor: colorty = cl_default); overload;
	procedure drawrect(const arect: rectty; const acolor: colorty = cl_default);
	procedure drawcross(const arect: rectty; const acolor: colorty = cl_default; const alignment: alignmentsty = [al_xcentered,al_ycentered]);
	procedure drawellipse(const def: rectty; const acolor: colorty = cl_default);
	procedure drawellipse1(const def: rectty; const acolor: colorty = cl_default);
	procedure drawcircle(const center: pointty; const radius: integer; const acolor: colorty = cl_default);
	procedure drawarc(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default); overload;
	procedure drawarc1(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default);
	procedure drawarc(const center: pointty; const radius: integer; const startang,extentang: real; const acolor: colorty = cl_default); overload;
	procedure fillrect(const arect: rectty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);
	procedure fillellipse(const def: rectty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);
	procedure fillellipse1(const def: rectty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);
	procedure fillcircle(const center: pointty; const radius: integer; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);
	procedure fillarcchord(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;
	procedure fillarcchord1(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);
	procedure fillarcchord(const center: pointty; const radius: integer; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;
	procedure fillarcpieslice(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;
	procedure fillarcpieslice1(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;
	procedure fillarcpieslice(const center: pointty; const radius: integer; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;
	procedure fillpolygon(const apoints: array of pointty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);
	procedure drawframe(const arect: rectty; awidth: integer = -1; const acolor: colorty = cl_default; const hiddenedges: edgesty = []); overload;
	procedure drawframe(const arect: rectty; awidth: framety; const acolor: colorty = cl_default; const hiddenedges: edgesty = []); overload;
	procedure drawxorframe(const arect: rectty; const awidth: integer = -1; const abrush: tsimplebitmap = nil); overload;
	procedure drawxorframe(const po1: pointty; const po2: pointty; const awidth: integer = -1; const abrush: tsimplebitmap = nil); overload;
	procedure fillxorrect(const arect: rectty; const abrush: tsimplebitmap = nil); overload;
	procedure fillxorrect(const start: pointty; const length: integer; const direction: graphicdirectionty; const awidth: integer = 0; const abrush: tsimplebitmap = nil); overload;
	procedure drawstring(const atext: msestring; const apos: pointty; const afont: tfont = nil; const grayed: boolean = false; const arotation: real = 0); overload;
	procedure drawstring(const atext: pmsechar; const acount: integer; const apos: pointty; const afont: tfont = nil; const grayed: boolean = false; const arotation: real = 0); overload;
	function getstringwidth(const atext: msestring; const afont: tfont = nil): integer; overload;
	function getstringwidth(const atext: pmsechar; const acount: integer; const afont: tfont = nil): integer; overload;
	function getfontmetrics(const achar: ucs4char; const afont: tfont = nil): fontmetricsty;
	function getfontmetrics(const achar: msechar; const afont: tfont = nil): fontmetricsty;
	procedure resetclipregion;
	procedure setcliprect(const rect: rectty);
	procedure addcliprect(const rect: rectty);
	procedure addclipframe(const frame: rectty; inflate: integer);
	procedure subcliprect(const rect: rectty);
	procedure subclipframe(const frame: rectty; inflate: integer);
	procedure intersectcliprect(const rect: rectty);
	procedure intersectclipframe(const frame: rectty; inflate: integer);
	procedure addclipregion(const region: regionty);
	procedure subclipregion(const region: regionty);
	procedure intersectclipregion(const region: regionty);
	function copyclipregion: regionty;
	function clipregionisempty: boolean;
	function clipbox: rectty;
	function createregion: regionty; overload;
	function createregion(const asource: regionty): regionty; overload;
	function createregion(const arect: rectty): regionty; overload;
	function createregion(const rects: array of rectty): regionty; overload;
	function createregion(frame: rectty; const inflate: integer): regionty; overload;
	procedure destroyregion(region: regionty);
	procedure regmove(const adest: regionty; const dist: pointty);
	procedure regremove(const adest: regionty; const dist: pointty);
	procedure regaddrect(const dest: regionty; const rect: rectty);
	procedure regsubrect(const dest: regionty; const rect: rectty);
	procedure regintersectrect(const dest: regionty; const rect: rectty);
	procedure regaddregion(const dest: regionty; const region: regionty);
	procedure regsubregion(const dest: regionty; const region: regionty);
	procedure regintersectregion(const dest: regionty; const region: regionty);
	function regionisempty(const region: regionty): boolean;
	function regionclipbox(const region: regionty): rectty;
	procedure adjustbrushorigin(const arect: rectty; const alignment: alignmentsty);

Properties

	property origin: pointty read getorigin write setorigin;
	property clipregion: regionty write setclipregion;
	property kind: bitmapkindty read getkind;
	property color: colorty read getcolor write setcolor default cl_black;
	property colorbackground: colorty read getcolorbackground write setcolorbackground default cl_transparent;
	property rasterop: rasteropty read getrasterop write setrasterop default rop_copy;
	property font: tfont read ffont write setfont;
	property brush: tsimplebitmap read getbrush write setbrush;
	property brushorigin: pointty read getbrushorigin write setbrushorigin;
	property rootbrushorigin: pointty read getrootbrushorigin write setrootbrushorigin;
	property linewidth: integer read getlinewidth write setlinewidth default 0;
	property linewidthmm: real read getlinewidthmm write setlinewidthmm;
	property dashes: dashesstringty read getdashes write setdashes;
	property capstyle: capstylety read getcapstyle write setcapstyle default cs_butt;
	property joinstyle: joinstylety read getjoinstyle write setjoinstyle default js_miter;
	property smooth: boolean read getsmooth write setsmooth;
	property options: canvasoptionsty read getoptions write setoptions default [];
	property paintdevice: paintdevicety read fdrawinfo.paintdevice;
	property gchandle: ptruint read getgchandle;
	property ppmm: real read fdrawinfo.gc.ppmm write setppmm;
	property statestamp: longword read fdrawinfo.statestamp;

Description

Fields

	fuser: tobject;

	fintf: pointer;

	fstate: canvasstatesty;

	fvaluepo: canvasvaluespoty;

	fdrawinfo: drawinfoty;

	gcfonthandle1: fontnumty;

	afonthandle1: fontnumty;

	ffont: tfont;

	target: tobject;

	drawinfopo: pointer;

Methods

	function getgdifuncs: pgdifunctionaty; virtual;

	procedure registergclink(const dest: tcanvas);

	procedure unregistergclink(const dest: tcanvas);

	procedure gcdestroyed(const sender: tcanvas); virtual;

	procedure setppmm(avalue: real); virtual;

	function getfitrect: rectty; virtual;

	procedure valuechanged(value: canvasstatety); inline;

	procedure valueschanged(values: canvasstatesty); inline;

	procedure initgcvalues; virtual;

	procedure initgcstate; virtual;

	procedure finalizegcstate; virtual;

	procedure checkrect(const rect: rectty);

	procedure checkgcstate(state: canvasstatesty); virtual;

	procedure checkregionstate;

	function defaultcliprect: rectty; virtual;

	function lock: boolean; virtual;

	procedure unlock; virtual;

	procedure doflush;

	procedure gdi(const func: gdifuncty); virtual;

	procedure init;

	procedure beforeread;

	procedure afterread;

	procedure internalcopyarea(asource: tcanvas; const asourcerect: rectty; const adestrect: rectty; acopymode: rasteropty; atransparentcolor: colorty; amask: tsimplebitmap; const amaskpos: pointty; aalignment: alignmentsty; const atileorigin: pointty; const aopacity: colorty);

	procedure setcliporigin(const Value: pointty);

	function getgchandle: ptruint;

	function getcanvasimage(const abgr: boolean = false): imagety;

	function getimage(const bgr: boolean): maskedimagety;

	procedure fillarc(const def: rectty; const startang,extentang: real; const acolor: colorty; const pieslice: boolean);

	procedure getarcinfo(out startpo,endpo: pointty);

	procedure internaldrawtext(var info); virtual;

	function createfont: tcanvasfont; virtual;

	procedure drawfontline(const startpoint,endpoint: pointty);

	procedure nextpage; virtual;

	function getcontextinfopo: pointer; virtual;

	procedure updatesize(const asize: sizety); virtual;

	procedure movewindowrect(const adist: pointty; const arect: rectty);

	procedure defineproperties(filer: tfiler); override;

	constructor create(const user: tobject; const intf: icanvas); virtual;

	destructor destroy; override;

	class function getclassgdifuncs: pgdifunctionaty; virtual;

	procedure updatewindowoptions(var aoptions: internalwindowoptionsty); virtual;

	function creategc(const apaintdevice: paintdevicety; const akind: gckindty; var gc: gcty; const aprintername: msestring = ''): gdierrorty;

	procedure linktopaintdevice(apaintdevice: paintdevicety; const gc: gcty; const cliporigin: pointty); virtual;

	procedure fitppmm(const asize: sizety);

	function size: sizety;

	function highresdevice: boolean;

	procedure initflags(const dest: tcanvas); virtual;

	procedure unlink;

	procedure initdrawinfo(var adrawinfo: drawinfoty);

	function active: boolean;

	procedure reset; virtual;

	function save: integer;

	function restore(index: integer = -1): integer;

	procedure resetpaintedflag;

	procedure endpaint;

	procedure move(const dist: pointty);

	procedure remove(const dist: pointty);

	procedure copyarea(const asource: tcanvas; const asourcerect: rectty; const adestpoint: pointty; const acopymode: rasteropty = rop_copy; const atransparentcolor: colorty = cl_default; const aopacity: colorty = cl_none); overload;

	procedure copyarea(const asource: tcanvas; const asourcerect: rectty; const adestrect: rectty; const alignment: alignmentsty = []; const acopymode: rasteropty = rop_copy; const atransparentcolor: colorty = cl_default; const aopacity: colorty = cl_none); overload;

	procedure drawpoint(const point: pointty; const acolor: colorty = cl_default);

	procedure drawpoints(const apoints: array of pointty; const acolor: colorty = cl_default; first: integer = 0; acount: integer = -1);

	procedure drawline(const startpoint,endpoint: pointty; const acolor: colorty = cl_default);

	procedure drawline(const startpoint: pointty; const length: sizety; const acolor: colorty = cl_default);

	procedure drawlinesegments(const apoints: array of segmentty; const acolor: colorty = cl_default);

	procedure drawlines(const apoints: array of pointty; const aclosed: boolean = false; const acolor: colorty = cl_default; const first: integer = 0; const acount: integer = -1); overload;

	procedure drawlines(const apoints: array of pointty; const abreaks: array of integer; const aclosed: boolean = false; const acolor: colorty = cl_default; const first: integer = 0; const acount: integer = -1); overload;

	procedure drawvect(const startpoint: pointty; const direction: graphicdirectionty; const length: integer; const acolor: colorty = cl_default); overload;

	procedure drawvect(const startpoint: pointty; const direction: graphicdirectionty; const length: integer; out endpoint: pointty; const acolor: colorty = cl_default); overload;

	procedure drawrect(const arect: rectty; const acolor: colorty = cl_default);

	procedure drawcross(const arect: rectty; const acolor: colorty = cl_default; const alignment: alignmentsty = [al_xcentered,al_ycentered]);

	procedure drawellipse(const def: rectty; const acolor: colorty = cl_default);

	procedure drawellipse1(const def: rectty; const acolor: colorty = cl_default);

	procedure drawcircle(const center: pointty; const radius: integer; const acolor: colorty = cl_default);

	procedure drawarc(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default); overload;

	procedure drawarc1(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default);

	procedure drawarc(const center: pointty; const radius: integer; const startang,extentang: real; const acolor: colorty = cl_default); overload;

	procedure fillrect(const arect: rectty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);

	procedure fillellipse(const def: rectty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);

	procedure fillellipse1(const def: rectty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);

	procedure fillcircle(const center: pointty; const radius: integer; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);

	procedure fillarcchord(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;

	procedure fillarcchord1(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);

	procedure fillarcchord(const center: pointty; const radius: integer; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;

	procedure fillarcpieslice(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;

	procedure fillarcpieslice1(const def: rectty; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;

	procedure fillarcpieslice(const center: pointty; const radius: integer; const startang,extentang: real; const acolor: colorty = cl_default; const linecolor: colorty = cl_none); overload;

	procedure fillpolygon(const apoints: array of pointty; const acolor: colorty = cl_default; const linecolor: colorty = cl_none);

	procedure drawframe(const arect: rectty; awidth: integer = -1; const acolor: colorty = cl_default; const hiddenedges: edgesty = []); overload;

	procedure drawframe(const arect: rectty; awidth: framety; const acolor: colorty = cl_default; const hiddenedges: edgesty = []); overload;

	procedure drawxorframe(const arect: rectty; const awidth: integer = -1; const abrush: tsimplebitmap = nil); overload;

	procedure drawxorframe(const po1: pointty; const po2: pointty; const awidth: integer = -1; const abrush: tsimplebitmap = nil); overload;

	procedure fillxorrect(const arect: rectty; const abrush: tsimplebitmap = nil); overload;

	procedure fillxorrect(const start: pointty; const length: integer; const direction: graphicdirectionty; const awidth: integer = 0; const abrush: tsimplebitmap = nil); overload;

	procedure drawstring(const atext: msestring; const apos: pointty; const afont: tfont = nil; const grayed: boolean = false; const arotation: real = 0); overload;

	procedure drawstring(const atext: pmsechar; const acount: integer; const apos: pointty; const afont: tfont = nil; const grayed: boolean = false; const arotation: real = 0); overload;

	function getstringwidth(const atext: msestring; const afont: tfont = nil): integer; overload;

	function getstringwidth(const atext: pmsechar; const acount: integer; const afont: tfont = nil): integer; overload;

	function getfontmetrics(const achar: ucs4char; const afont: tfont = nil): fontmetricsty;

	function getfontmetrics(const achar: msechar; const afont: tfont = nil): fontmetricsty;

	procedure resetclipregion;

	procedure setcliprect(const rect: rectty);

	procedure addcliprect(const rect: rectty);

	procedure addclipframe(const frame: rectty; inflate: integer);

	procedure subcliprect(const rect: rectty);

	procedure subclipframe(const frame: rectty; inflate: integer);

	procedure intersectcliprect(const rect: rectty);

	procedure intersectclipframe(const frame: rectty; inflate: integer);

	procedure addclipregion(const region: regionty);

	procedure subclipregion(const region: regionty);

	procedure intersectclipregion(const region: regionty);

	function copyclipregion: regionty;

	function clipregionisempty: boolean;

	function clipbox: rectty;

	function createregion: regionty; overload;

	function createregion(const asource: regionty): regionty; overload;

	function createregion(const arect: rectty): regionty; overload;

	function createregion(const rects: array of rectty): regionty; overload;

	function createregion(frame: rectty; const inflate: integer): regionty; overload;

	procedure destroyregion(region: regionty);

	procedure regmove(const adest: regionty; const dist: pointty);

	procedure regremove(const adest: regionty; const dist: pointty);

	procedure regaddrect(const dest: regionty; const rect: rectty);

	procedure regsubrect(const dest: regionty; const rect: rectty);

	procedure regintersectrect(const dest: regionty; const rect: rectty);

	procedure regaddregion(const dest: regionty; const region: regionty);

	procedure regsubregion(const dest: regionty; const region: regionty);

	procedure regintersectregion(const dest: regionty; const region: regionty);

	function regionisempty(const region: regionty): boolean;

	function regionclipbox(const region: regionty): rectty;

	procedure adjustbrushorigin(const arect: rectty; const alignment: alignmentsty);

Properties

	property origin: pointty read getorigin write setorigin;

	property clipregion: regionty write setclipregion;

	property kind: bitmapkindty read getkind;

	property color: colorty read getcolor write setcolor default cl_black;

	property colorbackground: colorty read getcolorbackground write setcolorbackground default cl_transparent;

	property rasterop: rasteropty read getrasterop write setrasterop default rop_copy;

	property font: tfont read ffont write setfont;

	property brush: tsimplebitmap read getbrush write setbrush;

	property brushorigin: pointty read getbrushorigin write setbrushorigin;

	property rootbrushorigin: pointty read getrootbrushorigin write setrootbrushorigin;

	property linewidth: integer read getlinewidth write setlinewidth default 0;

	property linewidthmm: real read getlinewidthmm write setlinewidthmm;

	property dashes: dashesstringty read getdashes write setdashes;

	property capstyle: capstylety read getcapstyle write setcapstyle default cs_butt;

	property joinstyle: joinstylety read getjoinstyle write setjoinstyle default js_miter;

	property smooth: boolean read getsmooth write setsmooth;

	property options: canvasoptionsty read getoptions write setoptions default [];

	property paintdevice: paintdevicety read fdrawinfo.paintdevice;

	property gchandle: ptruint read getgchandle;

	property ppmm: real read fdrawinfo.gc.ppmm write setppmm;

	property statestamp: longword read fdrawinfo.statestamp;

---

Generated by PasDoc 0.16.0.