Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 73c84b2

Browse files
committed
Update docs
1 parent bacb635 commit 73c84b2

File tree

5 files changed

+18
-21
lines changed

5 files changed

+18
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ There are many use cases for CEF. You can embed a web browser control
2828
based on Chromium with great HTML 5 support. You can use it to create
2929
a HTML 5 based GUI in an application, this can act as a replacement for
3030
standard GUI toolkits such as wxWidgets, Qt or GTK. In such case to
31-
communicate between Python<>Javascript use [javascript bindings](api/JavascriptBindings.md)
31+
communicate between Python<>Javascript use [javascript bindings](docs/Tutorial.md#javascript-integration)
3232
or embed an internal web server and talk using http requests. You
3333
can render web content off-screen in applications that use custom
3434
drawing frameworks. You can use it for automated testing of existing

api/Browser.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,14 @@
33

44
# Browser (object)
55

6-
Remember to free all browser references for the browser to shut down cleanly.
6+
Remember to free all browser references when closing app
7+
for the browser to shut down cleanly.
78
Otherwise data such as cookies or other storage might not be flushed to disk
8-
when closing app, and other issues might occur as well. If you store
9-
a reference to Frame somewhere in your code then to free it just assign
10-
a None value to the variable.
9+
when closing app, and other issues might occur as well. To free a reference
10+
just assign a None value to a browser variable.
1111

1212
To compare browser objects always use [GetIdentifier()](#getidentifier)
13-
method. Do not compare two Browser objects variables directly. There
14-
are some edge cases when after the OnBeforeClose event browser objects
15-
are no more globally referenced thus a new instance is created that
16-
wraps upstream CefBrowser object. Browser objects that were globally
17-
unreferenced do not have properties of the original Browser object,
18-
for example they do not have client callbacks, javascript bindings
19-
or user data set.
13+
method. Do not compare two Browser objects variables directly.
2014

2115

2216
Table of contents:
@@ -107,6 +101,12 @@ Methods available in upstream CEF which were not yet exposed in CEF Python
107101
* ImeFinishComposingText
108102
* ImeCancelComposition
109103

104+
There are some edge cases when after the OnBeforeClose event browser objects
105+
are no more globally referenced thus a new instance is created that
106+
wraps upstream CefBrowser object. Browser objects that were globally
107+
unreferenced do not have properties of the original Browser object,
108+
for example they do not have client callbacks, javascript bindings
109+
or user data set.
110110

111111
## Methods
112112

api/JavascriptCallback.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Table of contents:
2727

2828
| Parameter | Type |
2929
| --- | --- |
30-
| [params..] | mixed |
31-
| __Return__ | mixed |
30+
| [params..] (optional) | mixed |
31+
| __Return__ | void |
3232

33-
Call the javascript callback function.
33+
Call the javascript callback function. Pass arguments optionally.
3434

3535
For a list of allowed types for `mixed` see JavascriptBindings.[IsValueAllowed()](JavascriptBindings.md#isvalueallowed).
3636

docs/Build-instructions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Table of contents:
2222
## Preface
2323

2424
These instructions are for the new releases of CEF Python v50+.
25-
For the old v31 release that is supported on all platforms, see
26-
the build instructions on the wiki pages.
25+
For the old v31 release see the build instructions on Wiki pages.
2726

2827
If you would like to quickly build cefpython then see the
2928
[Quick build instructions for Windows](#quick-build-instructions-for-windows)

docs/Tutorial.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,8 @@ Examples switches:
268268
- "proxy-server" - to set proxy server
269269
- "disable-gpu" - use only CPU software rendering
270270

271-
Example code:
271+
Note that when setting switch that doesn't accept value then
272+
must pass an empty string as value. Example code:
272273

273274
```python
274275
switches = {
@@ -279,9 +280,6 @@ switches = {
279280
cef.Initialize(switches=switches)
280281
```
281282

282-
Note that when setting switch that doesn't accept value then
283-
must pass an empty string as value.
284-
285283

286284
**Chromium preferences**
287285

0 commit comments

Comments
 (0)