Mercurial > molko

comparison doc/api-molko-window.rst @ 191:633a25df450e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
molko-js: miscellaneous fixes While here, import sphinx as experimental documentation.
author David Demelier <markand@malikania.fr>
date Sat, 07 Nov 2020 15:40:34 +0100
parents
children
comparison
equal deleted inserted replaced
190:5dc57029b9f1 191:633a25df450e
1 .. toctree::
2 .. _api-molko-window:
3
4 Molko.Window
5 ============
6
7 This module is dedicated to window management.
8
9 Constants
10 ---------
11
12 .. js:data:: Molko.Window.Cursor
13
14 This is an enumeration of available cursor which you may choose from:
15
16 ``ARROW``
17 Default arrow.
18
19 ``EDIT``
20 Edit text cusror (like I-Beam)
21
22 ``WAIT``
23 Busy cursor, not available on all platforms.
24
25 ``CROSS_HAIR``
26 Cross.
27
28 ``SIZE``
29 Move and resizing cursor.
30
31 ``NO``
32 Action forbidden.
33
34 ``HAND``
35 Hand, mostly for moving.
36
37 Constructors
38 ------------
39
40 .. js:function:: Molko.Window(title, width, height)
41
42 :param string title: Title for the window.
43 :param int width: Desired window width.
44 :param int height: Desired window height.
45
46 Open a window or raise an error if any. This function MUST be called as a
47 constructor, not doing so will also raise an error.
48
49 Properties
50 ----------
51
52 .. js:data:: Molko.Window.cursor
53
54 (Write-only) Change the global window cursor to a system predefined one.