~martanne/vis

ref: v0.7 vis/doc/view.rst -rw-r--r-- 1.8 KiB
979f3d90Marc André Tanner Set version to 0.7 1 year, 5 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
View
====

Provides a viewport of a text instance and mangages selections.

Lifecycle
---------

.. doxygengroup:: view_life
   :content-only:

Viewport
--------

The cursor of the primary selection is always visible.

.. doxygengroup:: view_viewport
   :content-only:

Dimension
---------

.. doxygengroup:: view_size
   :content-only:

Draw
----

.. doxygengroup:: view_draw
   :content-only:

Selections
----------

A selection is a non-empty, directed range with two endpoints called *cursor*
and *anchor*. A selection can be anchored in which case the anchor remains
fixed while only the position of the cursor is adjusted. For non-anchored
selections both endpoints are updated. A singleton selection
covers one character on which both cursor and anchor reside. There always
exists a primary selection which remains visible (i.e. changes to its position
will adjust the viewport).

Creation and Destruction
~~~~~~~~~~~~~~~~~~~~~~~~

.. doxygengroup:: view_selnew
   :content-only:

Navigation
~~~~~~~~~~

.. doxygengroup:: view_navigate
   :content-only:

Cover
~~~~~

.. doxygengroup:: view_cover
   :content-only:

Anchor
~~~~~~

.. doxygengroup:: view_anchor
   :content-only:

Cursor
~~~~~~

Selection endpoint to which cursor motions apply.

Properties
^^^^^^^^^^

.. doxygengroup:: view_props
   :content-only:

Placement
^^^^^^^^^

.. doxygengroup:: view_place
   :content-only:

Motions
^^^^^^^^

These functions perform motions based on the current selection cursor position.

.. doxygengroup:: view_motions
   :content-only:

Primary Selection
~~~~~~~~~~~~~~~~~

These are convenience function which operate on the primary selection.

.. doxygengroup:: view_primary
   :content-only:

Save and Restore
~~~~~~~~~~~~~~~~

.. doxygengroup:: view_save
   :content-only:

Style
-----

.. doxygengroup:: view_style
   :content-only: