mirror of
https://github.com/1dot13/source.git
synced 2026-07-22 13:40:22 +02:00
majcostaandGitHub
aaa8b094c9
UTIL is never used, and JA2 is always used. assumption being we'll never make 1.13 for Wizardry 8. video2.h doesn't exist, which prevented me from deleting it.
279 lines
11 KiB
C
279 lines
11 KiB
C
// *****************************************************************************
|
|
//
|
|
// Filename : MouseSystem.h
|
|
//
|
|
// Purpose : Defines and typedefs for the "mousesystem" mouse region handler
|
|
//
|
|
// Modification history :
|
|
//
|
|
// 30jan97:Bret ->Creation
|
|
//
|
|
// *****************************************************************************
|
|
|
|
// *****************************************************************************
|
|
//
|
|
// Includes
|
|
//
|
|
// *****************************************************************************
|
|
|
|
#include "mousesystem_macros.h"
|
|
|
|
#ifndef _MOUSE_SYSTEM_H_
|
|
#define _MOUSE_SYSTEM_H_
|
|
|
|
// *****************************************************************************
|
|
//
|
|
// Typedefs
|
|
//
|
|
// *****************************************************************************
|
|
|
|
#define _JA2_RENDER_DIRTY // Undef this if not using the JA2 Dirty Rectangle System.
|
|
|
|
typedef void (*MOUSE_CALLBACK)(struct _MOUSE_REGION *,INT32); // Define MOUSE_CALLBACK type as pointer to void
|
|
typedef void (*MOUSE_HELPTEXT_DONE_CALLBACK)( ); // the help is done callback
|
|
|
|
typedef struct _MOUSE_REGION {
|
|
UINT16 IDNumber; // Region's ID number, set by mouse system
|
|
INT8 PriorityLevel; // Region's Priority, set by system and/or caller
|
|
UINT32 uiFlags; // Region's state flags
|
|
INT16 RegionTopLeftX; // Screen area affected by this region (absolute coordinates)
|
|
INT16 RegionTopLeftY;
|
|
INT16 RegionBottomRightX;
|
|
INT16 RegionBottomRightY;
|
|
INT16 MouseXPos; // Mouse's Coordinates in absolute screen coordinates
|
|
INT16 MouseYPos;
|
|
INT16 RelativeXPos; // Mouse's Coordinates relative to the Top-Left corner of the region
|
|
INT16 RelativeYPos;
|
|
UINT16 ButtonState; // Current state of the mouse buttons
|
|
INT16 WheelState; // Wheel state +/-number of wheel units
|
|
UINT16 Cursor; // Cursor to use when mouse in this region (see flags)
|
|
MOUSE_CALLBACK MovementCallback; // Pointer to callback function if movement occured in this region
|
|
MOUSE_CALLBACK ButtonCallback; // Pointer to callback function if button action occured in this region
|
|
INT32 UserData[4]; // User Data, can be set to anything!
|
|
|
|
//Fast help vars.
|
|
INT16 FastHelpTimer; // Countdown timer for FastHelp text
|
|
CHAR16 *FastHelpText; // Text string for the FastHelp (describes buttons if left there a while)
|
|
INT32 FastHelpRect;
|
|
MOUSE_HELPTEXT_DONE_CALLBACK HelpDoneCallback;
|
|
|
|
struct _MOUSE_REGION *next; // List maintenance, do NOT touch these entries
|
|
struct _MOUSE_REGION *prev;
|
|
} MOUSE_REGION;
|
|
|
|
|
|
// *****************************************************************************
|
|
//
|
|
// Defines
|
|
//
|
|
// *****************************************************************************
|
|
|
|
// Mouse Region Flags
|
|
#define MSYS_NO_FLAGS 0x00000000
|
|
#define MSYS_MOUSE_IN_AREA 0x00000001
|
|
#define MSYS_SET_CURSOR 0x00000002
|
|
#define MSYS_MOVE_CALLBACK 0x00000004
|
|
#define MSYS_BUTTON_CALLBACK 0x00000008
|
|
#define MSYS_REGION_EXISTS 0x00000010
|
|
#define MSYS_SYSTEM_INIT 0x00000020
|
|
#define MSYS_REGION_ENABLED 0x00000040
|
|
#define MSYS_FASTHELP 0x00000080
|
|
#define MSYS_GOT_BACKGROUND 0x00000100
|
|
#define MSYS_HAS_BACKRECT 0x00000200
|
|
#define MSYS_FASTHELP_RESET 0x00000400
|
|
#define MSYS_ALLOW_DISABLED_FASTHELP 0x00000800
|
|
|
|
// Mouse region IDs
|
|
#define MSYS_ID_BASE 1
|
|
#define MSYS_ID_MAX 0xfffffff // ( INT32 max )
|
|
#define MSYS_ID_SYSTEM 0
|
|
|
|
// Mouse region priorities
|
|
#define MSYS_PRIORITY_LOWEST 0
|
|
#define MSYS_PRIORITY_LOW 15
|
|
#define MSYS_PRIORITY_BASE 31
|
|
#define MSYS_PRIORITY_NORMAL 31
|
|
#define MSYS_PRIORITY_HIGH 63
|
|
#define MSYS_PRIORITY_HIGHEST 127
|
|
#define MSYS_PRIORITY_SYSTEM -1
|
|
#define MSYS_PRIORITY_AUTO -1
|
|
|
|
// Mouse system defines used during updates
|
|
#define MSYS_NO_ACTION 0
|
|
#define MSYS_DO_MOVE 1
|
|
#define MSYS_DO_LBUTTON_DWN 2
|
|
#define MSYS_DO_LBUTTON_UP 4
|
|
#define MSYS_DO_RBUTTON_DWN 8
|
|
#define MSYS_DO_RBUTTON_UP 16
|
|
#define MSYS_DO_LBUTTON_REPEAT 32
|
|
#define MSYS_DO_RBUTTON_REPEAT 64
|
|
#define MSYS_DO_MBUTTON_DWN 128
|
|
#define MSYS_DO_MBUTTON_UP 256
|
|
#define MSYS_DO_MBUTTON_REPEAT 512
|
|
|
|
#define MSYS_DO_X1BUTTON_DWN 1024
|
|
#define MSYS_DO_X1BUTTON_UP 2048
|
|
#define MSYS_DO_X1BUTTON_REPEAT 4096
|
|
#define MSYS_DO_X2BUTTON_DWN 8192
|
|
#define MSYS_DO_X2BUTTON_UP 16384
|
|
#define MSYS_DO_X2BUTTON_REPEAT 32768
|
|
|
|
#define MSYS_DO_WHEEL_UP 65536
|
|
#define MSYS_DO_WHEEL_DOWN 131072
|
|
|
|
#define MSYS_DO_BUTTONS (MSYS_DO_LBUTTON_DWN|MSYS_DO_LBUTTON_UP|MSYS_DO_LBUTTON_REPEAT|\
|
|
MSYS_DO_RBUTTON_DWN|MSYS_DO_RBUTTON_UP|MSYS_DO_RBUTTON_REPEAT|\
|
|
MSYS_DO_MBUTTON_DWN|MSYS_DO_MBUTTON_UP|MSYS_DO_MBUTTON_REPEAT|\
|
|
MSYS_DO_X1BUTTON_DWN|MSYS_DO_X1BUTTON_UP|MSYS_DO_X1BUTTON_REPEAT|\
|
|
MSYS_DO_X2BUTTON_DWN|MSYS_DO_X2BUTTON_UP|MSYS_DO_X2BUTTON_REPEAT)
|
|
|
|
#define MSYS_DO_WHEEL (MSYS_DO_WHEEL_UP|MSYS_DO_WHEEL_DOWN)
|
|
//#define MSYS_DO_BUTTONS (MSYS_DO_LBUTTON_DWN|MSYS_DO_LBUTTON_UP|MSYS_DO_RBUTTON_DWN|MSYS_DO_RBUTTON_UP|MSYS_DO_RBUTTON_REPEAT|MSYS_DO_LBUTTON_REPEAT)
|
|
|
|
// Mouse system button masks
|
|
#define MSYS_LEFT_BUTTON 1
|
|
#define MSYS_RIGHT_BUTTON 2
|
|
#define MSYS_MIDDLE_BUTTON 4
|
|
#define MSYS_X1_BUTTON 8
|
|
#define MSYS_X2_BUTTON 16
|
|
|
|
// Mouse system special values
|
|
#define MSYS_NO_CALLBACK NULL
|
|
#define MSYS_NO_CURSOR 65534
|
|
|
|
// Mouse system callback reasons
|
|
#define MSYS_CALLBACK_REASON_NONE 0
|
|
#define MSYS_CALLBACK_REASON_INIT 1
|
|
#define MSYS_CALLBACK_REASON_MOVE 2
|
|
#define MSYS_CALLBACK_REASON_LBUTTON_DWN 4
|
|
#define MSYS_CALLBACK_REASON_LBUTTON_UP 8
|
|
#define MSYS_CALLBACK_REASON_RBUTTON_DWN 16
|
|
#define MSYS_CALLBACK_REASON_RBUTTON_UP 32
|
|
//#define MSYS_CALLBACK_REASON_BUTTONS (MSYS_CALLBACK_REASON_LBUTTON_DWN|MSYS_CALLBACK_REASON_LBUTTON_UP| \
|
|
// MSYS_CALLBACK_REASON_RBUTTON_DWN|MSYS_CALLBACK_REASON_RBUTTON_UP)
|
|
#define MSYS_CALLBACK_REASON_LOST_MOUSE 64
|
|
#define MSYS_CALLBACK_REASON_GAIN_MOUSE 128
|
|
|
|
#define MSYS_CALLBACK_REASON_LBUTTON_REPEAT 256
|
|
#define MSYS_CALLBACK_REASON_RBUTTON_REPEAT 512
|
|
|
|
//Kris: Nov 31, 1999
|
|
//Added support for double clicks. The DOUBLECLICK event is passed combined with
|
|
//the LBUTTON_DWN event if two LBUTTON_DWN events are detected on the same button/region
|
|
//within the delay defined by MSYS_DOUBLECLICK_DELAY (in milliseconds). If your button/region
|
|
//supports double clicks and single clicks, make sure the DOUBLECLICK event is checked first (rejecting
|
|
//the LBUTTON_DWN event if detected)
|
|
#define MSYS_CALLBACK_REASON_LBUTTON_DOUBLECLICK 1024
|
|
#define MSYS_CALLBACK_REASON_MBUTTON_DWN 2048
|
|
#define MSYS_CALLBACK_REASON_MBUTTON_UP 4096
|
|
#define MSYS_CALLBACK_REASON_MBUTTON_REPEAT 8192
|
|
#define MSYS_CALLBACK_REASON_WHEEL_UP 16384
|
|
#define MSYS_CALLBACK_REASON_WHEEL_DOWN 32768
|
|
#define MSYS_CALLBACK_REASON_X1BUTTON_DWN 65536
|
|
#define MSYS_CALLBACK_REASON_X1BUTTON_UP 131072
|
|
#define MSYS_CALLBACK_REASON_X1BUTTON_REPEAT 262144
|
|
#define MSYS_CALLBACK_REASON_X2BUTTON_DWN 524288
|
|
#define MSYS_CALLBACK_REASON_X2BUTTON_UP 1048576
|
|
#define MSYS_CALLBACK_REASON_X2BUTTON_REPEAT 2097152
|
|
|
|
|
|
#define MSYS_CALLBACK_REASON_BUTTONS (MSYS_CALLBACK_REASON_LBUTTON_DWN|MSYS_CALLBACK_REASON_LBUTTON_UP| \
|
|
MSYS_CALLBACK_REASON_RBUTTON_DWN|MSYS_CALLBACK_REASON_RBUTTON_UP| \
|
|
MSYS_CALLBACK_REASON_MBUTTON_DWN|MSYS_CALLBACK_REASON_MBUTTON_UP|\
|
|
MSYS_CALLBACK_REASON_X1BUTTON_DWN|MSYS_CALLBACK_REASON_X1BUTTON_UP|\
|
|
MSYS_CALLBACK_REASON_X2BUTTON_DWN|MSYS_CALLBACK_REASON_X2BUTTON_UP)
|
|
|
|
#define MSYS_CALLBACK_REASON_WHEEL (MSYS_CALLBACK_REASON_WHEEL_UP|MSYS_CALLBACK_REASON_WHEEL_DOWN)
|
|
|
|
|
|
// Mouse grabbing return codes
|
|
#define MSYS_GRABBED_OK 0
|
|
#define MSYS_ALREADY_GRABBED 1
|
|
#define MSYS_REGION_NOT_IN_LIST 2
|
|
|
|
// *****************************************************************************
|
|
//
|
|
// Prototypes
|
|
//
|
|
// *****************************************************************************
|
|
/*
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
*/
|
|
// *****************************************************************************
|
|
|
|
|
|
// Note:
|
|
// The prototype for MSYS_SGP_Mouse_Handler_Hook() is defined in mousesystem_macros.h
|
|
|
|
// Internal Functions
|
|
INT32 MSYS_GetNewID(void);
|
|
void MSYS_TrashRegList(void);
|
|
void MSYS_AddRegionToList(MOUSE_REGION *region);
|
|
INT32 MSYS_RegionInList(MOUSE_REGION *region);
|
|
void MSYS_DeleteRegionFromList(MOUSE_REGION *region);
|
|
void MSYS_UpdateMouseRegion(void);
|
|
void MSYS_SetCurrentCursor(UINT16 Cursor);
|
|
|
|
// External
|
|
INT32 MSYS_Init(void);
|
|
void MSYS_Shutdown(void);
|
|
void MSYS_DefineRegion(MOUSE_REGION *region,UINT16 tlx,UINT16 tly,UINT16 brx,UINT16 bry,INT8 priority,
|
|
UINT16 crsr,MOUSE_CALLBACK movecallback,MOUSE_CALLBACK buttoncallback);
|
|
void MSYS_ChangeRegionCursor(MOUSE_REGION *region,UINT16 crsr);
|
|
INT32 MSYS_AddRegion(MOUSE_REGION *region);
|
|
void MSYS_RemoveRegion(MOUSE_REGION *region);
|
|
void MSYS_EnableRegion(MOUSE_REGION *region);
|
|
void MSYS_DisableRegion(MOUSE_REGION *region);
|
|
void MSYS_ChangeRegionPriority(MOUSE_REGION *region,INT8 priority);
|
|
void MSYS_SetRegionUserData(MOUSE_REGION *region,INT32 index,INT32 userdata);
|
|
INT32 MSYS_GetRegionUserData(MOUSE_REGION *region,INT32 index);
|
|
|
|
INT32 MSYS_GrabMouse(MOUSE_REGION *region);
|
|
void MSYS_ReleaseMouse(MOUSE_REGION *region);
|
|
void MSYS_MoveMouseRegionBy( MOUSE_REGION *region, INT16 sDeltaX, INT16 sDeltaY);
|
|
void MSYS_MoveMouseRegionTo( MOUSE_REGION *region, INT16 sX, INT16 sY);
|
|
|
|
void MSYS_AllowDisabledRegionFastHelp( MOUSE_REGION *region, BOOLEAN fAllow );
|
|
|
|
// arynn : render mouse regions
|
|
// functions to help externalize mouse region data
|
|
MOUSE_REGION *get_first_entry_in_MSYS_RegList(void); //list iteration initialize
|
|
MOUSE_REGION *get_next_entry_in_MSYS_RegList(MOUSE_REGION *current_region); //list iteration increment
|
|
|
|
// This function will force a re-evaluation of mous regions
|
|
// Usually used to force change of mouse cursor if panels switch, etc
|
|
void RefreshMouseRegions( );
|
|
|
|
void SetRegionFastHelpText( MOUSE_REGION *region, const STR16 szText );
|
|
|
|
void SetRegionHelpEndCallback( MOUSE_REGION *region, MOUSE_HELPTEXT_DONE_CALLBACK CallbackFxn );
|
|
|
|
// Now also used by Wizardry -- DB
|
|
void DisplayFastHelp( MOUSE_REGION *region );
|
|
void RenderFastHelp();
|
|
|
|
void SetFastHelpDelay( INT16 sFastHelpDelay );
|
|
void EnableMouseFastHelp( void );
|
|
void DisableMouseFastHelp( void );
|
|
|
|
void ResetClickedMode(void);
|
|
void ResetWheelState( MOUSE_REGION *region );
|
|
#ifdef _JA2_RENDER_DIRTY
|
|
|
|
BOOLEAN SetRegionSavedRect( MOUSE_REGION *region);
|
|
void FreeRegionSavedRect( MOUSE_REGION *region );
|
|
|
|
#endif
|
|
|
|
// *****************************************************************************
|
|
/*
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
*/
|
|
#endif
|
|
|
|
// EOF *************************************************************************
|