1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _core.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13class wxMouseEventsManager : wxEvtHandler
14{
15    %Docstring
16        MouseEventsManager()
17        MouseEventsManager(win)
18
19        Helper for handling mouse input events in windows containing multiple
20        items.
21    %End
22    %TypeHeaderCode
23        #include <wx/mousemanager.h>
24    %End
25
26public:
27    wxMouseEventsManager();
28
29    wxMouseEventsManager(
30        wxWindow * win
31    );
32
33    bool Create(
34        wxWindow * win
35    );
36    %Docstring
37        Create(win) -> bool
38
39        Finishes initialization of the object created using default
40        constructor.
41    %End
42
43
44protected:
45    virtual
46    int MouseHitTest(
47        const wxPoint & pos
48    ) = 0;
49    %Docstring
50        MouseHitTest(pos) -> int
51
52        Must be overridden to return the item at the given position.
53    %End
54
55    virtual
56    bool MouseClicked(
57        int item
58    ) = 0;
59    %Docstring
60        MouseClicked(item) -> bool
61
62        Must be overridden to react to mouse clicks.
63    %End
64
65    virtual
66    bool MouseDragBegin(
67        int item,
68        const wxPoint & pos
69    ) = 0;
70    %Docstring
71        MouseDragBegin(item, pos) -> bool
72
73        Must be overridden to allow or deny dragging of the item.
74    %End
75
76    virtual
77    void MouseDragging(
78        int item,
79        const wxPoint & pos
80    ) = 0;
81    %Docstring
82        MouseDragging(item, pos)
83
84        Must be overridden to provide feed back while an item is being
85        dragged.
86    %End
87
88    virtual
89    void MouseDragEnd(
90        int item,
91        const wxPoint & pos
92    ) = 0;
93    %Docstring
94        MouseDragEnd(item, pos)
95
96        Must be overridden to handle item drop.
97    %End
98
99    virtual
100    void MouseDragCancelled(
101        int item
102    ) = 0;
103    %Docstring
104        MouseDragCancelled(item)
105
106        Must be overridden to handle cancellation of mouse dragging.
107    %End
108
109    virtual
110    void MouseClickBegin(
111        int item
112    );
113    %Docstring
114        MouseClickBegin(item)
115
116        May be overridden to update the state of an item when it is pressed.
117    %End
118
119    virtual
120    void MouseClickCancelled(
121        int item
122    );
123    %Docstring
124        MouseClickCancelled(item)
125
126        Must be overridden to reset the item appearance changed by
127        MouseClickBegin().
128    %End
129
130};  // end of class wxMouseEventsManager
131
132
133
134//---------------------------------------------------------------------------
135
136