BioImager  3.9.1
A .NET microscopy imaging library. Supports various microscopes by using imported libraries & GUI automation. Supported libraries include PriorĀ® & ZeissĀ® & all devices supported by Micromanager 2.0 and python-microscope.
Loading...
Searching...
No Matches
BioImager.MouseOperations Class Reference

Classes

struct  MousePoint
 

Public Types

enum  MouseEventFlags
 

Static Public Member Functions

static void LeftClick ()
 
static void RightClick ()
 
static void LeftDown ()
 
static void RightDown ()
 
static void LeftUp ()
 
static void RightUp ()
 
static void SetCursorPosition (int x, int y)
 
static void SetCursorPosition (MousePoint point)
 
static MousePoint GetCursorPosition ()
 
static void MouseEvent (MouseEventFlags value)
 

Detailed Description

Definition at line 104 of file Win32.cs.

Member Enumeration Documentation

◆ MouseEventFlags

enum BioImager.MouseOperations.MouseEventFlags

Definition at line 108 of file Win32.cs.

109 {
110 LeftDown = 0x00000002,
111 LeftUp = 0x00000004,
112 MiddleDown = 0x00000020,
113 MiddleUp = 0x00000040,
114 Move = 0x00000001,
115 Absolute = 0x00008000,
116 RightDown = 0x00000008,
117 RightUp = 0x00000010
118 }

Member Function Documentation

◆ GetCursorPosition()

static MousePoint BioImager.MouseOperations.GetCursorPosition ( )
static

GetCursorPosition() returns a MousePoint object that contains the current position of the mouse cursor

Returns
A MousePoint object.

Definition at line 177 of file Win32.cs.

178 {
179 MousePoint currentMousePoint;
180 var gotPoint = GetCursorPos(out currentMousePoint);
181 if (!gotPoint) { currentMousePoint = new MousePoint(0, 0); }
182 return currentMousePoint;
183 }

Referenced by BioImager.MouseOperations.MouseEvent().

◆ LeftClick()

static void BioImager.MouseOperations.LeftClick ( )
static

Definition at line 131 of file Win32.cs.

132 {
133 MouseEvent(MouseEventFlags.LeftDown | MouseEventFlags.LeftUp);
134 }
static void MouseEvent(MouseEventFlags value)
Definition: Win32.cs:188

◆ LeftDown()

static void BioImager.MouseOperations.LeftDown ( )
static

Definition at line 139 of file Win32.cs.

140 {
141 MouseEvent(MouseEventFlags.LeftDown);
142 }

◆ LeftUp()

static void BioImager.MouseOperations.LeftUp ( )
static

Definition at line 147 of file Win32.cs.

148 {
149 MouseEvent(MouseEventFlags.LeftUp);
150 }

◆ MouseEvent()

static void BioImager.MouseOperations.MouseEvent ( MouseEventFlags  value)
static

It simulates a mouse click at the current cursor position

Parameters
MouseEventFlagsThis is the type of mouse event you want to simulate.

Definition at line 188 of file Win32.cs.

189 {
190 MousePoint position = GetCursorPosition();
191
192 mouse_event
193 ((int)value,
194 position.X,
195 position.Y,
196 0,
197 0)
198 ;
199 }
static MousePoint GetCursorPosition()
Definition: Win32.cs:177

References BioImager.MouseOperations.GetCursorPosition().

◆ RightClick()

static void BioImager.MouseOperations.RightClick ( )
static

Definition at line 135 of file Win32.cs.

136 {
137 MouseEvent(MouseEventFlags.RightDown | MouseEventFlags.RightUp);
138 }

◆ RightDown()

static void BioImager.MouseOperations.RightDown ( )
static

Definition at line 143 of file Win32.cs.

144 {
145 MouseEvent(MouseEventFlags.RightDown);
146 }

◆ RightUp()

static void BioImager.MouseOperations.RightUp ( )
static

Definition at line 151 of file Win32.cs.

152 {
153 MouseEvent(MouseEventFlags.RightUp);
154 }

◆ SetCursorPosition() [1/2]

static void BioImager.MouseOperations.SetCursorPosition ( int  x,
int  y 
)
static

It sets the cursor position to the specified coordinates

Parameters
xThe x coordinate of the cursor.
yThe y coordinate of the cursor.

Definition at line 159 of file Win32.cs.

160 {
161 SetCursorPos(x, y);
162 }

◆ SetCursorPosition() [2/2]

static void BioImager.MouseOperations.SetCursorPosition ( MousePoint  point)
static

It takes a MousePoint object and sets the cursor position to the X and Y coordinates of the MousePoint object

Parameters
MousePointA struct that contains the X and Y coordinates of the mouse.

Definition at line 168 of file Win32.cs.

169 {
170 SetCursorPos(point.X, point.Y);
171 }

The documentation for this class was generated from the following file: