Ginger88895
/
warzone2100
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more doxygen markup, especially for widget code. 

git-svn-id: svn+ssh://svn.gna.org/svn/warzone/trunk@4758 4a71c877-e1ca-e34f-864e-861f7616d084
master
Per Inge Mathisen 2008-04-24 17:06:25 +00:00
parent 1b128781cf
commit 5533cf265a
5 changed files with 175 additions and 169 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

330
lib/widget/widget.h
View File

@ -17,8 +17,14 @@
along with Warzone 2100; if not, write to the Free Software along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/** @file /**
* @file widget.h
* Definitions for the Widget library * Definitions for the Widget library
* @defgroup Widget
* Warzone uses a pixel layout, callback based widget code. While it has several
* fallbacks for drawing standard widgets, usually you want to specify your
* own drawing callbacks.
* @{
*/ */
#ifndef __INCLUDED_LIB_WIDGET_WIDGET_H__ #ifndef __INCLUDED_LIB_WIDGET_WIDGET_H__
@ -34,65 +40,61 @@
* Widget style definitions - these control how the basic widget appears on screen * Widget style definitions - these control how the basic widget appears on screen
*/ */
#define WIDG_HIDDEN 0x8000 // The widget is initially hidden #define WIDG_HIDDEN 0x8000 ///< The widget is initially hidden
/************ Form styles ****************/ /************ Form styles ****************/
/* Plain form */ #define WFORM_PLAIN 0 ///< Plain form
#define WFORM_PLAIN 0 #define WFORM_TABBED 1 ///< Tabbed form
/* Tabbed form */ /** Invisible (i.e. see through) form - can be used in conjunction with WFORM_PLAIN or WFORM_TABBED. */
#define WFORM_TABBED 1
/* Invisible (i.e. see through) form -
* can be used in conjunction with WFORM_PLAIN or WFORM_TABBED.
*/
#define WFORM_INVISIBLE 2 #define WFORM_INVISIBLE 2
/* Clickable form - return form id when the form is clicked */ #define WFORM_CLICKABLE 4 ///< Clickable form - return form id when the form is clicked
#define WFORM_CLICKABLE 4 #define WFORM_NOCLICKMOVE 8 ///< Disable movement on a clickable form
/* Disable movement on a clickable form. */ /**
#define WFORM_NOCLICKMOVE 8 * Control whether the primary or secondary buttons work on a clickable form.
* Primary works by default - this turns it off.
/* Control whether the primary or secondary buttons work on a clickable form */ */
#define WFORM_NOPRIMARY 0x10 // Primary works by default - this turns it off #define WFORM_NOPRIMARY 0x10
#define WFORM_SECONDARY 0x20 #define WFORM_SECONDARY 0x20 ///< Enable secondary buttons
/************ Label styles ***************/ /************ Label styles ***************/
#define WLAB_PLAIN 0 // Plain text only label #define WLAB_PLAIN 0 ///< Plain text only label
#define WLAB_ALIGNLEFT 1 // Align the text at the left of the box #define WLAB_ALIGNLEFT 1 ///< Align the text at the left of the box
#define WLAB_ALIGNCENTRE 2 // Center the text #define WLAB_ALIGNCENTRE 2 ///< Center the text
#define WLAB_ALIGNRIGHT 4 // Align the text at the right of the box #define WLAB_ALIGNRIGHT 4 ///< Align the text at the right of the box
/************ Button styles **************/ /************ Button styles **************/
#define WBUT_PLAIN 0 // Plain button (text with a box around it) #define WBUT_PLAIN 0 ///< Plain button (text with a box around it)
#define WBUT_NOCLICKMOVE 8 ///< Disable movement on a button
/* Disable movement on a button */
#define WBUT_NOCLICKMOVE 8
/* Control whether the primary or secondary buttons work on a button */ /**
#define WBUT_NOPRIMARY 0x10 // Primary works by default - this turns it off * Control whether the primary or secondary buttons work on a button. Primary works by default -
#define WBUT_SECONDARY 0x20 * this turns it off.
*/
#define WBUT_NOPRIMARY 0x10
#define WBUT_SECONDARY 0x20 ///< Enable secondary buttons.
#define WBUT_TXTCENTRE 64 ///< Text only buttons. centre the text?
#define WBUT_TXTCENTRE 64 // text only buttons. centre the text?
/*********** Edit Box styles *************/ /*********** Edit Box styles *************/
#define WEDB_PLAIN 0 // Plain edit box (text with a box around it) #define WEDB_PLAIN 0 ///< Plain edit box (text with a box around it)
#define WEDB_DISABLED 1 // Disabled. Displayed but never gets focus. #define WEDB_DISABLED 1 ///< Disabled. Displayed but never gets focus.
/*********** Bar Graph styles ************/ /*********** Bar Graph styles ************/
#define WBAR_PLAIN 0 // Plain bar graph #define WBAR_PLAIN 0 ////< Plain bar graph
#define WBAR_TROUGH 1 // Bar graph with a trough showing empty percentage #define WBAR_TROUGH 1 ///< Bar graph with a trough showing empty percentage
#define WBAR_DOUBLE 2 // Double bar graph, one on top of other #define WBAR_DOUBLE 2 ///< Double bar graph, one on top of other
/*********** Slider styles ***************/ /*********** Slider styles ***************/
#define WSLD_PLAIN 0 // Plain slider #define WSLD_PLAIN 0 ///< Plain slider
/***********************************************************************************/ /***********************************************************************************/
@ -111,22 +113,24 @@
void *pUserData; /* Optional user data pointer */\ void *pUserData; /* Optional user data pointer */\
UDWORD UserData /* User data (if any) */ UDWORD UserData /* User data (if any) */
/* The basic initialisation structure */ /** The basic initialisation structure */
typedef struct _w_init typedef struct
{ {
WINIT_BASE; WINIT_BASE;
} W_INIT; } W_INIT;
/* Flags for controlling where the tabs appear on a form - /*
* Flags for controlling where the tabs appear on a form -
* used in the majorPos and minorPos entries of the W_FORMINIT struct * used in the majorPos and minorPos entries of the W_FORMINIT struct
*/ */
#define WFORM_TABNONE 0 // No tab #define WFORM_TABNONE 0 ///< No tab
#define WFORM_TABTOP 1 #define WFORM_TABTOP 1
#define WFORM_TABLEFT 2 #define WFORM_TABLEFT 2
#define WFORM_TABRIGHT 3 #define WFORM_TABRIGHT 3
#define WFORM_TABBOTTOM 4 #define WFORM_TABBOTTOM 4
/* Upper limits for major and minor tabs on a tab form. /*
* Upper limits for major and minor tabs on a tab form.
* Not the best way to do it I know, but it keeps the memory * Not the best way to do it I know, but it keeps the memory
* management MUCH simpler. * management MUCH simpler.
*/ */
@ -147,8 +151,8 @@ typedef struct _w_init
typedef void (*TAB_DISPLAY)(WIDGET *psWidget, UDWORD TabType, UDWORD Position, UDWORD Number, BOOL Selected, BOOL Hilight, UDWORD x, UDWORD y, UDWORD Width, UDWORD Height); typedef void (*TAB_DISPLAY)(WIDGET *psWidget, UDWORD TabType, UDWORD Position, UDWORD Number, BOOL Selected, BOOL Hilight, UDWORD x, UDWORD y, UDWORD Width, UDWORD Height);
typedef void (*FONT_DISPLAY)(UDWORD x, UDWORD y, char *String); typedef void (*FONT_DISPLAY)(UDWORD x, UDWORD y, char *String);
/* Form initialisation structure */ /** Form initialisation structure */
typedef struct _w_forminit typedef struct
{ {
/* The basic init entries */ /* The basic init entries */
WINIT_BASE; WINIT_BASE;
@ -158,243 +162,242 @@ typedef struct _w_forminit
UWORD majorPos, minorPos; // Position of the tabs on the form UWORD majorPos, minorPos; // Position of the tabs on the form
UWORD majorSize, minorSize; // Size of the tabs (in pixels) UWORD majorSize, minorSize; // Size of the tabs (in pixels)
SWORD majorOffset, minorOffset; // Tab start offset. SWORD majorOffset, minorOffset; // Tab start offset.
SWORD tabVertOffset; // Tab form overlap offset. SWORD tabVertOffset; ///< Tab form overlap offset.
SWORD tabHorzOffset; // Tab form overlap offset. SWORD tabHorzOffset; ///< Tab form overlap offset.
UWORD tabMajorThickness; // The thickness of the tabs UWORD tabMajorThickness; ///< The thickness of the tabs
UWORD tabMinorThickness; // The thickness of the tabs UWORD tabMinorThickness; ///< The thickness of the tabs
UWORD tabMajorGap; // The space between tabs UWORD tabMajorGap; ///< The space between tabs
UWORD tabMinorGap; // The space between tabs UWORD tabMinorGap; ///< The space between tabs
UWORD numStats; // Number of "stats" (items) in list UWORD numStats; ///< Number of "stats" (items) in list
UWORD numButtons; //Number of buttons per form UWORD numButtons; ///< Number of buttons per form
UWORD numMajor; // Number of major tabs UWORD numMajor; ///< Number of major tabs
UWORD aNumMinors[WFORM_MAXMAJOR]; // Number of minor tabs for each major UWORD aNumMinors[WFORM_MAXMAJOR]; ///< Number of minor tabs for each major
SWORD TabMultiplier; //used to tell system we got lots of (virtual) tabs to display SWORD TabMultiplier; ///< Used to tell system we got lots of (virtual) tabs to display
const char *pTip; // Tool tip for the form itself const char *pTip; ///< Tool tip for the form itself
char *apMajorTips[WFORM_MAXMAJOR]; // Tool tips for the major tabs char *apMajorTips[WFORM_MAXMAJOR]; ///< Tool tips for the major tabs
char *apMinorTips[WFORM_MAXMAJOR][WFORM_MAXMINOR]; char *apMinorTips[WFORM_MAXMAJOR][WFORM_MAXMINOR]; ///< Tool tips for the minor tabs
// Tool tips for the minor tabs TAB_DISPLAY pTabDisplay; ///< Optional callback for displaying a tab.
TAB_DISPLAY pTabDisplay; // Optional callback for displaying a tab. WIDGET_DISPLAY pFormDisplay; ///< Optional callback to display the form.
WIDGET_DISPLAY pFormDisplay; // Optional callback to display the form.
} W_FORMINIT; } W_FORMINIT;
/* Label initialisation structure */ /** Label initialisation structure */
typedef struct _w_labinit typedef struct
{ {
/* The basic init entries */ /* The basic init entries */
WINIT_BASE; WINIT_BASE;
const char *pText; // label text const char *pText; ///< label text
const char *pTip; // Tool tip for the label. const char *pTip; ///< Tool tip for the label.
enum iV_fonts FontID; // ID of the IVIS font to use for this widget. enum iV_fonts FontID; ///< ID of the IVIS font to use for this widget.
} W_LABINIT; } W_LABINIT;
/* Button initialisation structure */ /** Button initialisation structure */
typedef struct _w_butinit typedef struct
{ {
/* The basic init entries */ /* The basic init entries */
WINIT_BASE; WINIT_BASE;
const char *pText; // button text const char *pText; ///< Button text
const char *pTip; // Tool tip text const char *pTip; ///< Tool tip text
enum iV_fonts FontID; // ID of the IVIS font to use for this widget. enum iV_fonts FontID; //< ID of the IVIS font to use for this widget.
} W_BUTINIT; } W_BUTINIT;
/* Edit box initialisation structure */ /** Edit box initialisation structure */
typedef struct _w_edbinit typedef struct
{ {
/* The basic init entries */ /* The basic init entries */
WINIT_BASE; WINIT_BASE;
const char *pText; // initial contents of the edit box const char *pText; ///< initial contents of the edit box
enum iV_fonts FontID; // ID of the IVIS font to use for this widget. enum iV_fonts FontID; ///< ID of the IVIS font to use for this widget.
WIDGET_DISPLAY pBoxDisplay; // Optional callback to display the form. WIDGET_DISPLAY pBoxDisplay; ///< Optional callback to display the form.
FONT_DISPLAY pFontDisplay; // Optional callback to display a string. FONT_DISPLAY pFontDisplay; ///< Optional callback to display a string.
} W_EDBINIT; } W_EDBINIT;
/* Orientation flags for the bar graph */ /* Orientation flags for the bar graph */
#define WBAR_LEFT 0x0001 // Bar graph fills from left to right #define WBAR_LEFT 0x0001 ///< Bar graph fills from left to right
#define WBAR_RIGHT 0x0002 // Bar graph fills from right to left #define WBAR_RIGHT 0x0002 ///< Bar graph fills from right to left
#define WBAR_TOP 0x0003 // Bar graph fills from top to bottom #define WBAR_TOP 0x0003 ///< Bar graph fills from top to bottom
#define WBAR_BOTTOM 0x0004 // Bar graph fills from bottom to top #define WBAR_BOTTOM 0x0004 ///< Bar graph fills from bottom to top
/* Bar Graph initialisation structure */ /** Bar Graph initialisation structure */
typedef struct _w_barinit typedef struct
{ {
/* The basic init entries */ /* The basic init entries */
WINIT_BASE; WINIT_BASE;
UWORD orientation; // Orientation of the bar on the widget UWORD orientation; ///< Orientation of the bar on the widget
UWORD size; // Initial percentage of the graph that is filled UWORD size; ///< Initial percentage of the graph that is filled
UWORD minorSize; // Percentage of second bar graph if there is one UWORD minorSize; ///< Percentage of second bar graph if there is one
UWORD iRange; // Maximum range UWORD iRange; ///< Maximum range
PIELIGHT sCol; // Bar colour PIELIGHT sCol; ///< Bar colour
PIELIGHT sMinorCol; // Minor bar colour PIELIGHT sMinorCol; ///< Minor bar colour
const char *pTip; // Tool tip text const char *pTip; ///< Tool tip text
} W_BARINIT; } W_BARINIT;
/* Orientation of the slider */ /* Orientation of the slider */
#define WSLD_LEFT 0x0001 // Slider is horizontal and starts at left #define WSLD_LEFT 0x0001 ///< Slider is horizontal and starts at left
#define WSLD_RIGHT 0x0002 // Slider is horizontal and starts at the right #define WSLD_RIGHT 0x0002 ///< Slider is horizontal and starts at the right
#define WSLD_TOP 0x0003 // Slider is vertical and starts at the top #define WSLD_TOP 0x0003 ///< Slider is vertical and starts at the top
#define WSLD_BOTTOM 0x0004 // Slider is vertical and starts at the bottom #define WSLD_BOTTOM 0x0004 ///< Slider is vertical and starts at the bottom
/* Slider initialisation structure */ /** Slider initialisation structure */
typedef struct _w_sldinit typedef struct
{ {
/* The basic init entries */ /* The basic init entries */
WINIT_BASE; WINIT_BASE;
UWORD orientation; // Orientation of the slider UWORD orientation; ///< Orientation of the slider
UWORD numStops; // Number of stops on the slider UWORD numStops; ///< Number of stops on the slider
UWORD barSize; // Size of the bar UWORD barSize; ///< Size of the bar
UWORD pos; // Initial position of the slider bar UWORD pos; ///< Initial position of the slider bar
const char *pTip; // Tip string const char *pTip; ///< Tip string
} W_SLDINIT; } W_SLDINIT;
/***********************************************************************************/ /***********************************************************************************/
/* The maximum lenth of strings for the widget system */ /** The maximum lenth of strings for the widget system */
#define WIDG_MAXSTR 80 #define WIDG_MAXSTR 80
/* The maximum value for bar graph size */ /** The maximum value for bar graph size */
#define WBAR_SCALE 100 #define WBAR_SCALE 100
/* Initialise the widget module */ /** Initialise the widget module */
extern bool widgInitialise(void); extern bool widgInitialise(void);
/* Reset the widget module */ /** Reset the widget module */
extern void widgReset(void); extern void widgReset(void);
/* Shut down the widget module */ /** Shut down the widget module */
extern void widgShutDown(void); extern void widgShutDown(void);
/* Create an empty widget screen */ /** Create an empty widget screen */
extern W_SCREEN* widgCreateScreen(void); extern W_SCREEN* widgCreateScreen(void);
/* Release a screen and all its associated data */ /** Release a screen and all its associated data */
extern void widgReleaseScreen(W_SCREEN *psScreen); extern void widgReleaseScreen(W_SCREEN *psScreen);
/* Set the tool tip font for a screen */ /** Set the tool tip font for a screen */
extern void widgSetTipFont(W_SCREEN *psScreen, enum iV_fonts FontID); extern void widgSetTipFont(W_SCREEN *psScreen, enum iV_fonts FontID);
/* Add a form to the widget screen */ /** Add a form to the widget screen */
extern BOOL widgAddForm(W_SCREEN *psScreen, const W_FORMINIT* psInit); extern BOOL widgAddForm(W_SCREEN *psScreen, const W_FORMINIT* psInit);
/* Add a label to the widget screen */ /** Add a label to the widget screen */
extern BOOL widgAddLabel(W_SCREEN *psScreen, const W_LABINIT* psInit); extern BOOL widgAddLabel(W_SCREEN *psScreen, const W_LABINIT* psInit);
/* Add a button to a form */ /** Add a button to a form */
extern BOOL widgAddButton(W_SCREEN *psScreen, const W_BUTINIT* psInit); extern BOOL widgAddButton(W_SCREEN *psScreen, const W_BUTINIT* psInit);
/* Add an edit box to a form */ /** Add an edit box to a form */
extern BOOL widgAddEditBox(W_SCREEN *psScreen, const W_EDBINIT* psInit); extern BOOL widgAddEditBox(W_SCREEN *psScreen, const W_EDBINIT* psInit);
/* Add a bar graph to a form */ /** Add a bar graph to a form */
extern BOOL widgAddBarGraph(W_SCREEN *psScreen, const W_BARINIT* psInit); extern BOOL widgAddBarGraph(W_SCREEN *psScreen, const W_BARINIT* psInit);
/* Add a slider to a form */ /** Add a slider to a form */
extern BOOL widgAddSlider(W_SCREEN *psScreen, const W_SLDINIT* psInit); extern BOOL widgAddSlider(W_SCREEN *psScreen, const W_SLDINIT* psInit);
/* Delete a widget from the screen */ /** Delete a widget from the screen */
extern void widgDelete(W_SCREEN *psScreen, UDWORD id); extern void widgDelete(W_SCREEN *psScreen, UDWORD id);
/* Hide a widget */ /** Hide a widget */
extern void widgHide(W_SCREEN *psScreen, UDWORD id); extern void widgHide(W_SCREEN *psScreen, UDWORD id);
/* Reveal a widget */ /** Reveal a widget */
extern void widgReveal(W_SCREEN *psScreen, UDWORD id); extern void widgReveal(W_SCREEN *psScreen, UDWORD id);
/* Return a pointer to a buffer containing the current string of a widget if any. /** Return a pointer to a buffer containing the current string of a widget if any.
* This will always return a valid string pointer. * This will always return a valid string pointer.
* NOTE: The string must be copied out of the buffer * NOTE: The string must be copied out of the buffer
*/ */
extern const char *widgGetString(W_SCREEN *psScreen, UDWORD id); extern const char *widgGetString(W_SCREEN *psScreen, UDWORD id);
/* Set the text in a widget */ /** Set the text in a widget */
extern void widgSetString(W_SCREEN *psScreen, UDWORD id, const char *pText); extern void widgSetString(W_SCREEN *psScreen, UDWORD id, const char *pText);
/* Set the current tabs for a tab form */ /** Set the current tabs for a tab form */
extern void widgSetTabs(W_SCREEN *psScreen, UDWORD id, UWORD major, UWORD minor); extern void widgSetTabs(W_SCREEN *psScreen, UDWORD id, UWORD major, UWORD minor);
/* Get the current tabs for a tab form */ /** Get the current tabs for a tab form */
extern void widgGetTabs(W_SCREEN *psScreen, UDWORD id, UWORD *pMajor, UWORD *pMinor); extern void widgGetTabs(W_SCREEN *psScreen, UDWORD id, UWORD *pMajor, UWORD *pMinor);
/* Get the current position of a widget */ /** Get the current position of a widget */
extern void widgGetPos(W_SCREEN *psScreen, UDWORD id, SWORD *pX, SWORD *pY); extern void widgGetPos(W_SCREEN *psScreen, UDWORD id, SWORD *pX, SWORD *pY);
/* Get the current position of a slider bar */ /** Get the current position of a slider bar */
extern UDWORD widgGetSliderPos(W_SCREEN *psScreen, UDWORD id); extern UDWORD widgGetSliderPos(W_SCREEN *psScreen, UDWORD id);
/* Set the current position of a slider bar */ /** Set the current position of a slider bar */
extern void widgSetSliderPos(W_SCREEN *psScreen, UDWORD id, UWORD pos); extern void widgSetSliderPos(W_SCREEN *psScreen, UDWORD id, UWORD pos);
/* Set the current size of a bar graph */ /** Set the current size of a bar graph */
extern void widgSetBarSize(W_SCREEN *psScreen, UDWORD id, UDWORD size); extern void widgSetBarSize(W_SCREEN *psScreen, UDWORD id, UDWORD size);
/* Set the current size of a minor bar on a double graph */ /** Set the current size of a minor bar on a double graph */
extern void widgSetMinorBarSize(W_SCREEN *psScreen, UDWORD id, UDWORD size); extern void widgSetMinorBarSize(W_SCREEN *psScreen, UDWORD id, UDWORD size);
/* Return the ID of the widget the mouse was over this frame */ /** Return the ID of the widget the mouse was over this frame */
extern UDWORD widgGetMouseOver(W_SCREEN *psScreen); extern UDWORD widgGetMouseOver(W_SCREEN *psScreen);
/* Return the user data for a widget */ /** Return the user data for a widget */
extern void *widgGetUserData(W_SCREEN *psScreen, UDWORD id); extern void *widgGetUserData(W_SCREEN *psScreen, UDWORD id);
/* Set the user data for a widget */ /** Set the user data for a widget */
extern void widgSetUserData(W_SCREEN *psScreen, UDWORD id, void *UserData); extern void widgSetUserData(W_SCREEN *psScreen, UDWORD id, void *UserData);
/* Return the user data for a widget */ /** Return the user data for a widget */
extern UDWORD widgGetUserData2(W_SCREEN *psScreen, UDWORD id); extern UDWORD widgGetUserData2(W_SCREEN *psScreen, UDWORD id);
/* Set the user data for a widget */ /** Set the user data for a widget */
extern void widgSetUserData2(W_SCREEN *psScreen, UDWORD id,UDWORD UserData); extern void widgSetUserData2(W_SCREEN *psScreen, UDWORD id,UDWORD UserData);
/* Return the user data for the returned widget */ /** Return the user data for the returned widget */
extern void *widgGetLastUserData(W_SCREEN *psScreen); extern void *widgGetLastUserData(W_SCREEN *psScreen);
/* Get widget structure */ /** Get widget structure */
extern WIDGET *widgGetFromID(W_SCREEN *psScreen, UDWORD id); extern WIDGET *widgGetFromID(W_SCREEN *psScreen, UDWORD id);
/* Set tip string for a widget */ /** Set tip string for a widget */
extern void widgSetTip( W_SCREEN *psScreen, UDWORD id, const char *pTip ); extern void widgSetTip(W_SCREEN *psScreen, UDWORD id, const char *pTip);
extern void widgSetTipText(WIDGET* psWidget, const char* pTip); extern void widgSetTipText(WIDGET* psWidget, const char* pTip);
/* Colour numbers */ /** Colour numbers */
enum _w_colour enum _w_colour
{ {
WCOL_BKGRND, // Background colours WCOL_BKGRND, ///< Background colours
WCOL_TEXT, // Text colour WCOL_TEXT, ///< Text colour
WCOL_LIGHT, // Light colour for 3D effects WCOL_LIGHT, ///< Light colour for 3D effects
WCOL_DARK, // Dark colour for 3D effects WCOL_DARK, ///< Dark colour for 3D effects
WCOL_HILITE, // Hilite colour WCOL_HILITE, ///< Hilite colour
WCOL_CURSOR, // Edit Box cursor colour WCOL_CURSOR, ///< Edit Box cursor colour
WCOL_TIPBKGRND, // Background for the tool tip window WCOL_TIPBKGRND, ///< Background for the tool tip window
WCOL_DISABLE, // Text colour on a disabled button WCOL_DISABLE, ///< Text colour on a disabled button
WCOL_MAX, // all colour numbers are less than this WCOL_MAX, ///< All colour numbers are less than this
}; };
/* Set a colour on a form */ /** Set a colour on a form */
extern void widgSetColour(W_SCREEN *psScreen, UDWORD id, UDWORD colour, extern void widgSetColour(W_SCREEN *psScreen, UDWORD id, UDWORD colour,
UBYTE red, UBYTE green, UBYTE blue); UBYTE red, UBYTE green, UBYTE blue);
// Set the global toop tip text colour. /** Set the global toop tip text colour. */
extern void widgSetTipColour(PIELIGHT colour); extern void widgSetTipColour(PIELIGHT colour);
/* Possible states for a button */ /* Possible states for a button */
#define WBUT_DISABLE 0x0001 // Disable (grey out) a button #define WBUT_DISABLE 0x0001 ///< Disable (grey out) a button
#define WBUT_LOCK 0x0002 // Fix a button down #define WBUT_LOCK 0x0002 ///< Fix a button down
#define WBUT_CLICKLOCK 0x0004 // Fix a button down but it is still clickable #define WBUT_CLICKLOCK 0x0004 ///< Fix a button down but it is still clickable
#define WBUT_FLASH 0x0008 // Make a button flash. #define WBUT_FLASH 0x0008 ///< Make a button flash.
extern void widgSetButtonFlash(W_SCREEN *psScreen, UDWORD id); extern void widgSetButtonFlash(W_SCREEN *psScreen, UDWORD id);
extern void widgClearButtonFlash(W_SCREEN *psScreen, UDWORD id); extern void widgClearButtonFlash(W_SCREEN *psScreen, UDWORD id);
/* Get a button or clickable form's state */ /** Get a button or clickable form's state */
extern UDWORD widgGetButtonState(W_SCREEN *psScreen, UDWORD id); extern UDWORD widgGetButtonState(W_SCREEN *psScreen, UDWORD id);
/* Set a button or clickable form's state */ /** Set a button or clickable form's state */
extern void widgSetButtonState(W_SCREEN *psScreen, UDWORD id, UDWORD state); extern void widgSetButtonState(W_SCREEN *psScreen, UDWORD id, UDWORD state);
@ -403,48 +406,51 @@ extern void widgSetButtonState(W_SCREEN *psScreen, UDWORD id, UDWORD state);
#define WKEY_PRIMARY 1 #define WKEY_PRIMARY 1
#define WKEY_SECONDARY 2 #define WKEY_SECONDARY 2
/* Return which key was used to press the last returned widget */ /** Return which key was used to press the last returned widget */
extern UDWORD widgGetButtonKey(W_SCREEN *psScreen); extern UDWORD widgGetButtonKey(W_SCREEN *psScreen);
/* Initialise the set of widgets that make up a screen. /** Initialise the set of widgets that make up a screen.
* Call this once before calling widgRunScreen and widgDisplayScreen. * Call this once before calling widgRunScreen and widgDisplayScreen.
* This should only be called once before calling Run and Display as many times * This should only be called once before calling Run and Display as many times
* as is required. * as is required.
*/ */
extern void widgStartScreen(W_SCREEN *psScreen); extern void widgStartScreen(W_SCREEN *psScreen);
/* Clean up after a screen has been run. /** Clean up after a screen has been run.
* Call this after the widgRunScreen / widgDisplayScreen cycle. * Call this after the widgRunScreen / widgDisplayScreen cycle.
*/ */
extern void widgEndScreen(W_SCREEN *psScreen); extern void widgEndScreen(W_SCREEN *psScreen);
/* Execute a set of widgets for one cycle. /** Execute a set of widgets for one cycle.
* Return the id of the widget that was activated, or 0 for none. * Return the id of the widget that was activated, or 0 for none.
*/ */
extern UDWORD widgRunScreen(W_SCREEN *psScreen); extern UDWORD widgRunScreen(W_SCREEN *psScreen);
/* Display the screen's widgets in their current state /** Display the screen's widgets in their current state
* (Call after calling widgRunScreen, this allows the input * (Call after calling widgRunScreen, this allows the input
* processing to be seperated from the display of the widgets). * processing to be seperated from the display of the widgets).
*/ */
extern void widgDisplayScreen(W_SCREEN *psScreen); extern void widgDisplayScreen(W_SCREEN *psScreen);
// Set the current audio callback function and audio id's. /** Set the current audio callback function and audio id's. */
extern void WidgSetAudio(WIDGET_AUDIOCALLBACK Callback,SWORD HilightID,SWORD ClickedID); extern void WidgSetAudio(WIDGET_AUDIOCALLBACK Callback,SWORD HilightID,SWORD ClickedID);
// Get pointer to current audio callback function. /** Get pointer to current audio callback function. */
extern WIDGET_AUDIOCALLBACK WidgGetAudioCallback(void); extern WIDGET_AUDIOCALLBACK WidgGetAudioCallback(void);
// Get current audio ID for hilight. /** Get current audio ID for hilight. */
extern SWORD WidgGetHilightAudioID(void); extern SWORD WidgGetHilightAudioID(void);
// Get current audio ID for clicked. /** Get current audio ID for clicked. */
extern SWORD WidgGetClickedAudioID(void); extern SWORD WidgGetClickedAudioID(void);
/** Enable or disable all sliders. */
extern void sliderEnableDrag(BOOL Enable); extern void sliderEnableDrag(BOOL Enable);
extern void setWidgetsStatus( BOOL var ); extern void setWidgetsStatus( BOOL var );
extern BOOL getWidgetsStatus( void ); extern BOOL getWidgetsStatus( void );
/** @} */
#endif // __INCLUDED_LIB_WIDGET_WIDGET_H__ #endif // __INCLUDED_LIB_WIDGET_WIDGET_H__

2
src/bucket3d.c
View File

@ -18,7 +18,7 @@
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/** /**
* @file bucket3D.c * @file bucket3d.c
* *
* Stores object render calls in a linked list renders after bucket sorting objects. * Stores object render calls in a linked list renders after bucket sorting objects.
*/ */

2
src/configuration.c
View File

@ -18,7 +18,7 @@
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/** /**
* @file config.c * @file configuration.c
* Saves your favourite options to the Registry. * Saves your favourite options to the Registry.
* *
*/ */

2
src/display3d.c
View File

@ -18,7 +18,7 @@
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/** /**
* @file display3D.c * @file display3d.c
* Draws the 3D terrain view. Both the 3D and pseudo-3D components - textured tiles. * Draws the 3D terrain view. Both the 3D and pseudo-3D components - textured tiles.
------------------------------------------------------------------- -------------------------------------------------------------------

2
src/warzoneconfig.c
View File

@ -18,7 +18,7 @@
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/** /**
* @file warzoneConfig.c * @file warzoneconfig.c
* *
* Warzone Global configuration functions. * Warzone Global configuration functions.
*/ */