summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_canvas_pointer.eo
blob: 57111a7896fa70ca34f57f7f45cf6a6a5a02af0f (plain) (blame)
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
import efl_input_device;

interface Efl.Canvas.Pointer ()
{
   methods {
      @property pointer_inside {
         get {
            [[Returns whether the mouse pointer is logically inside the
              canvas.

              When this function is called it will return a value of either
              $false or $true, depending on whether a pointer,in or pointer,out
              event has been called previously.

              A return value of $true indicates the mouse is logically
              inside the canvas, and $false implies it is logically
              outside the canvas.

              A canvas begins with the mouse being assumed outside ($false).
            ]]
         }
         keys {
            seat: Efl.Input.Device @optional; [[The seat to consider, if $null
                     then the default seat will be used.]]
         }
         values {
            inside: bool; [[$true if the mouse pointer is inside the canvas,
                            $false otherwise]]
         }
      }
   }
}