fpCEF3: what changed

Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		## Description
2	2
3	3		![](/wiki-images/b/b4/SimpleChromium.png)
4	4
5	5		Chromium is an open source project (from Google) to create a browser for different platforms. Among other things the browser Chrome is based on it.
6	6
7	7		The Chromium Embedded Framework (CEF) is an open source framework for embedding Chromium into user applications. It can be used on Linux, macOS and Windows in 32 and 64 bit versions. Originally there were two versions of CEF, CEF1 and CEF3, but CEF1 is no longer maintained.
8	8
9	9		CEF can be used in Delphi via the Delphi Chromium Embedded Framework (DCEF3). For Lazarus/Free Pascal there is the equivalent framework [fpCEF3](https://github.com/dliw/fpCEF3) (or alternative [CEF4Delphi](https://github.com/salvadordf/CEF4Delphi) with examples for Lazarus including newest versions of Chromium Embedded Framework).
10	10
11	11		## Installation
12	12
13	13		Besides the Lazarus package, the CEF framework itself is needed. It is important to use the correct version of the CEF framework for the fpCEF release used. Further specific installation instructions can be found on Github: [<https://github.com/dliw/fpCEF3>](https://github.com/dliw/fpCEF3)
14	14
15	15		The latest release and its corresponding CEF version can be found on [1](https://github.com/dliw/fpCEF3/releases/latest)
16	16
17	17		CEF releases can be found on <https://cef-builds.spotifycdn.com/index.html> (use the version filter or click "Show more builds" to find the release)
18	18
19	19		### Download Package
20	20
21	21		fpCEF3 with [Git](http://git-scm.com/)
22	22
23		-	~~[`git://github.com/dliw/fpCEF3.git`](git://github.com/dliw/fpCEF3.git)~~
	23	+	```text
	24	+	git://github.com/dliw/fpCEF3.git
	25	+	```
24	26
25	27		You can also download a zipped package:
26	28
27		-	~~[`master.zip`](https://github.com/dliw/fpCEF3/archive/master.zip)~~
	29	+	```text
	30	+	master.zip
	31	+	```
28	32
29	33		### Package Installation
30	34
31	35		![](/wiki-images/3/33/Chromium.png)
32	36
33	37		After downloading of package fpCEF3, it can be installed in Lazarus:
34	38
35	39		- Start Lazarus and open main menu Package -\> Open package file (.lpk)...
36	40		- Select the file cef3.lpk in the fpCEF3 subdirectory Component
37	41		- The package editing window will open
38	42		- Click on Compile, the package will be compiled
39	43		- Click on Use...-\> Install and confirm the dialog window with Yes
40	44		- Lazarus is now compiling and create a new tab Chromium in the component palette
41	45
42	46		### Download Framework CEF3
43	47
44	48		You can now download the framework and made the libraries available for a particular project. You can download it from the following pages:\
45	49		[<https://cefbuilds.com>](https://cefbuilds.com)\
46	50		[<http://www.magpcss.net/cef_downloads>](http://www.magpcss.net/cef_downloads) (or a older version from [here](http://www.magpcss.net/cef_downloads/index.php?query=label%3ADeprecated#list))
47	51
48	52		> Note: Make sure to use the correct framework version for the fpCEF version! See Installation
49	53
50	54		## Usage
51	55
52	56		### Minimal example
53	57
54	58		A minimal example with a simple browser is created.
55	59
56	60		#### Windows
57	61
58	62		The CEF libraries are needed for loading, so it makes sense to create a new project folder, to save the project and the libraries in it together.
59	63
60	64		- Create a new directory for the project to a location of your choice such as C:\SimpleBrowser
61	65		- Copy the complete CEF3 directory Resources to C:\SimpleBrowser
62	66		- Copy the contents of the CEF3 directory Release in the directory C:\SimpleBrowser
63	67
64	68		The files (libcef.dll, natives_blob.bin, icudtl.dat etc.) are in the same directory as the project and the directory locales in C:\SimpleBrowser\locales.\
65	69		To prevent misunderstands, here is a picture how the file and directory structure of the Simplebrowser should look:\
66	70
67	71		![](/wiki-images/a/aa/FilesForSimplebrowser.png)\
68	72
69	73		Now build the project with Lazarus
70	74
71	75		- Create a new empty [[Form Tutorial\|GUI application]]
72	76		- Save the project in the directory you specify for Windows (e.g. under C:\SimpleBrowser)
73	77		- Drop a `TEditButton` on the form
74	78		- With Object Inspector set the `Name` to `edtURL`, `Align` on `alTop` and `ButtonCaption` to `go`
75	79		- Put a `TChromium` on the form and set the `Name` to `Chromium` and its `Align` to `alClient`
76	80		- Create the `OnButtonClick` event handler for the TEditButton `edtURL`. Select the `OnButtonClick` in the Object Inspector tab `events` and click on the button \[...\]
77	81		- Write following code (chromium should open at each click the URL in the text box):
78	82
79	83		``` pascal
80	84		procedure TForm1.edtURLClick(Sender: TObject);
81	85		begin
82	86		Chromium.Load(UTF8Decode(edtURL.Text));
83	87		end;
84	88		```
85	89
86	90		- `Chromium` must be initialized at the start of the program, you can do this with the `OnCreate` event handler of the form:
87	91
88	92		``` pascal
89	93		procedure TForm1.FormCreate(Sender: TObject);
90	94		var
91	95		PrjPath: ustring;
92	96		Lang, FallbackLang: string;
93	97		begin
94	98		PrjPath := UTF8Decode(GetCurrentDir + PathDelim);
95	99		CefLocalesDirPath := PrjPath + 'locales';
96	100		GetLanguageIDs(Lang, FallbackLang);
97	101		CefLocale := UTF8Decode(FallbackLang);
98	102		edtURL.Text:='http://www.lazarus-ide.org/';
99	103		end;
100	104		```
101	105
102	106		- If a identifier wouldn't be found, you have to put some units to the uses clause. These units should be in there:
103	107
104	108		``` pascal
105	109		uses
106	110		sysutils, Forms, EditBtn, cef3lcl, cef3intf, cef3types, cef3lib, gettext;
107	111		```
108	112
109	113		- Run your program, if all goes well it might look like:
110	114
111	115		![](/wiki-images/b/b4/SimpleChromium.png)\
112	116
113	117		### Show URL of loaded page
114	118
115	119		Based on Minimal example
116	120
117	121		- Create the `OnLoadEnd` event handler for `Chromium`
118	122		- Write following code (URL should be updated after any browsing):
119	123
120	124		``` pascal
121	125		procedure TForm1.ChromiumLoadEnd(Sender: TObject; const Browser: ICefBrowser;
122	126		const Frame: ICefFrame; httpStatusCode: Integer);
123	127		begin
124	128		edtURL.Text:=UTF8Encode(Browser.MainFrame.Url);
125	129		end;
126	130		```
127	131
128	132		### Allow downloading of files
129	133
130	134		- Create the `OnBeforeDownload` event handler for `Chromium` and write in it:
131	135
132	136		``` pascal
133	137		procedure TForm1.ChromiumBeforeDownload(Sender: TObject;
134	138		const Browser: ICefBrowser; const downloadItem: ICefDownloadItem;
135	139		const suggestedName: ustring; const callback: ICefBeforeDownloadCallback);
136	140		begin
137	141		callback.Cont(suggestedName, True);
138	142		end;
139	143		```
140	144
141	145		### Printing per code
142	146
143	147		- Add a `TButton` on your form and write in its `OnClick` event handler:
144	148
145	149		``` pascal
146	150		procedure TForm1.Button1Click(Sender: TObject);
147	151		begin
148	152		Chromium.Browser.Host.Print;
149	153		end;
150	154		```
151	155
152	156		### Creating a pdf
153	157
154	158		- Add a `TSaveDialog` on your form
155	159		- Add a `TButton` on your form and write in its `OnClick` event handler:
156	160
157	161		``` pascal
158	162		procedure TForm1.Button1Click(Sender: TObject);
159	163		var
160	164		CefPdfPrintSettings: TCefPdfPrintSettings;
161	165		EmptyCefStringUtf16: TCefStringUtf16;
162	166		begin
163	167		SaveDialog1.DefaultExt := 'pdf';
164	168		SaveDialog1.Filter := 'Portable Document Format (pdf)\|*.pdf';
165	169		if SaveDialog1.Execute then
166	170		begin
167	171		FillByte(EmptyCefStringUtf16, SizeOf(EmptyCefStringUtf16), 0);
168	172
169	173		CefPdfPrintSettings.backgrounds_enabled := 1;
170	174		CefPdfPrintSettings.header_footer_enabled := 0;
171	175		CefPdfPrintSettings.header_footer_title := EmptyCefStringUtf16;
172	176		CefPdfPrintSettings.header_footer_url := EmptyCefStringUtf16;
173	177		CefPdfPrintSettings.landscape := 0;
174	178		CefPdfPrintSettings.margin_bottom := 0;
175	179		CefPdfPrintSettings.margin_left := 0;
176	180		CefPdfPrintSettings.margin_right := 0;
177	181		CefPdfPrintSettings.margin_top := 0;
178	182		CefPdfPrintSettings.margin_type := PDF_PRINT_MARGIN_DEFAULT;
179	183		CefPdfPrintSettings.page_height := 0;
180	184		CefPdfPrintSettings.page_width := 0;
181	185		CefPdfPrintSettings.selection_only := 0;
182	186
183	187		Chromium.Browser.Host.PrintToPdf(UTF8Decode(SaveDialog1.FileName), CefPdfPrintSettings, Nil);
184	188		end;
185	189		end;
186	190		```
187	191
188	192		The description of the `TCefPdfPrintSettings` you will find by the declaration of the `TCefPdfPrintSettings`
189	193
190	194		## Known Problems
191	195
192	196		- If your program doesn't start, maybe a Antivirus program prevent this.
193	197		- If your program start but your TChromium window keeps empty, maybe a firewall block it (see [Chromium Embedded Framework for Free Pascal (fpCEF3) BRUNCH 2556](http://forum.lazarus.freepascal.org/index.php/topic,31361.0.html)).
194	198		- If your file structure isn't correct (see Minimal example) and therefore some libraries wouldn't be found, you can get optical errors (see [Fpcef red borders in the browser](http://forum.lazarus.freepascal.org/index.php/topic,30763.0.html)).
195	199
196	200		## Further Information
197	201
198	202		- [Thread in the German Lazarusforum](http://www.lazarusforum.de/viewtopic.php?f=18&t=7676)
199	203		- [[Webbrowser]]
200	204
201	205		---
202	206		From the Free Pascal wiki, page "fpCEF3", as it stood on 2021-01-15 after a change by Michael.vanham, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
203	207		Category: Components
204	208		Category: LCL

Back to history