Tidied up the documentation.

master
Pacman Ghost 7 years ago
parent e37baf36d8
commit 377986d7ef
  1. 14
      MainApp/AppConfig.cs
  2. 13
      MouseDll/api.hpp

@ -19,7 +19,6 @@ namespace MouseInterception
// elements specify which ones they want via a start index and item count. Sigh...
// --- SETTINGS: application settings ---
[StructLayout( LayoutKind.Sequential , CharSet=CharSet.Unicode , Pack=1 )]
public struct ApiSettings
{
@ -28,7 +27,6 @@ namespace MouseInterception
public ApiSettings settings { get { return mSettings ; } }
// --- DEVICE: device attributes ---
[StructLayout( LayoutKind.Sequential , CharSet=CharSet.Unicode , Pack=1 )]
public struct ApiDevice
{
@ -42,11 +40,6 @@ namespace MouseInterception
public ApiDevice[] devices { get { return mDevices ; } }
// --- DEVICE CONFIG: device configuration ---
// A DeviceConfig is associated with a single Device. We have 2 struct's to keep separate
// the configuration of the device itself, and how the user wants it to behave.
// A device can be configured to respond differently depending on which application is active.
// Each one is managed by an AppProfile object.
[StructLayout( LayoutKind.Sequential , CharSet=CharSet.Unicode , Pack=1 )]
public struct ApiDeviceConfig
{
@ -59,9 +52,6 @@ namespace MouseInterception
public ApiDeviceConfig[] deviceConfigs { get { return mDeviceConfigs ; } }
// --- APP PROFILE: device configuration for an application ---
// This holds the configuration for how the user wants a device to behave, for a specific application e.g.
// Alt + mouseLeft => scrollLeft
[StructLayout( LayoutKind.Sequential , CharSet=CharSet.Unicode , Pack=1 )]
public struct ApiAppProfile
{
@ -73,9 +63,6 @@ namespace MouseInterception
public ApiAppProfile[] appProfiles { get { return mAppProfiles ; } }
// --- API EVENT: device event ---
// Represents an event that can be generated by a device e.g. mouse was moved left, button 3 was pressed.
// It also holds a list of Action's to be executed when the event happens.
[StructLayout( LayoutKind.Sequential , CharSet=CharSet.Unicode , Pack=1 )]
public struct ApiEvent
{
@ -90,7 +77,6 @@ namespace MouseInterception
public ApiEvent[] events { get { return mEvents ; } }
// --- API ACTION: action to perform in response to a device event ---
[StructLayout( LayoutKind.Sequential , CharSet=CharSet.Unicode , Pack=1 )]
public struct ApiAction
{

@ -5,10 +5,12 @@
// IMPORTANT! The definitions here must be kept in sync with their C# equivalents in App/ApiDebugConfig.cs.
// --- SETTINGS: application settings ---
struct ApiAppConfig
{
} ;
// --- DEVICE: device attributes ---
struct ApiDevice
{
int mDeviceId ;
@ -18,6 +20,10 @@ struct ApiDevice
bool mIsEnabled ;
} ;
// --- DEVICE CONFIG: device configuration ---
// A DeviceConfig is associated with a single Device. We have 2 struct's to keep separate the configuration
// of the device itself, and how the user wants it to behave. A device can be configured to respond differently
// depending on which application is active, with each one managed by an AppProfile object.
struct ApiDeviceConfig
{
int mDeviceId ;
@ -26,6 +32,9 @@ struct ApiDeviceConfig
int mAppProfileCount ;
} ;
// --- APP PROFILE: device configuration for an application ---
// This holds the configuration for how the user wants a device to behave, for a specific application e.g.
// Alt + mouseLeft => scrollLeft
struct ApiAppProfile
{
const wchar_t* mpApp ;
@ -33,6 +42,9 @@ struct ApiAppProfile
int mEventCount ;
} ;
// --- API EVENT: device event ---
// Represents an event that can be generated by a device e.g. mouse was moved left, button 3 was pressed.
// It also holds a list of Action's to be executed when the event happens.
struct ApiEvent
{
int mEventType ;
@ -41,6 +53,7 @@ struct ApiEvent
int mActionCount ;
} ;
// --- API ACTION: action to perform in response to a device event ---
struct ApiAction
{
int mActionType ;

Loading…
Cancel
Save