mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
electron/docs
History
Jim Fisher 01b7ceac17
docs: coordinate system of badly named method getCursorScreenPoint (#27156) 
* Document coordinate system of badly named method getCursorScreenPoint

[Electron inherits this confusing name from Chromium](99314be815/ui/display/win/screen_win.cc (L677-L681)). We can also see there that the return value is a DIPPoint, due to `ScreenToDIPPoint` call:

    gfx::Point ScreenWin::GetCursorScreenPoint() {
      POINT pt;
      ::GetCursorPos(&pt);
      return gfx::ToFlooredPoint(ScreenToDIPPoint(gfx::PointF(gfx::Point(pt))));
    }

I lost over a day due to debugging this. I don't think we can change the method name due to backwards compatibility, but we can at least make amends in the documentation.

* Remove advice

* Softer wording

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>
2021-01-11 12:19:48 +09:00
..
api docs: coordinate system of badly named method getCursorScreenPoint (#27156) 2021-01-11 12:19:48 +09:00
development docs: add libraries for arch and manjaro linux (#27196) 2021-01-07 15:41:08 +09:00
fiddles docs: added fiddle support for code samples (#26501) 2020-11-30 16:48:39 +09:00
images docs: revised dark mode feature page (#26187) 2020-11-02 16:18:29 +09:00
tutorial docs: fix two "add" mistake in snapcraft.md (#27151) 2021-01-04 09:33:12 -08:00
breaking-changes.md chore: remove deprecated systemPreferences methods (#26849) 2020-12-16 08:34:24 +09:00
experimental.md docs: document what experimental means explicitly (#22893) 2020-04-02 09:32:18 -07:00
faq.md docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
glossary.md docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
README.md docs: app distribution page (#26239) 2020-12-02 15:52:12 +09:00
styleguide.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00

README.md

Official Guides

Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.

FAQ

There are questions that are asked quite often. Check this out before creating an issue:

Guides and Tutorials

Quickstart

Learning the basics

Advanced steps

Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.

API References

Custom DOM Elements:

Modules for the Main Process:

Modules for the Renderer Process (Web Page):

Modules for Both Processes:

Development

See development/README.md