Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

mi32/mstatus.h File Reference

<mi32/mstatus.h> Include file for "status display" functions More...

#include <mi32/mtimer.h>
#include <mi32/mistring.h>
#include <stdarg.h>
#include <mi32/stddefns.h>

Include dependency graph for mstatus.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Classes

struct  _MSTATUSCONTEXT
struct  _MSTATUSHANDLE
struct  _MSTATUSINTERFACE
 Generic status interface structure. More...

class  STATUSCONTEXT
 Status context. More...

class  STATUSDIALOG
 Status dialog. More...

class  STATUSDISABLECANCEL
 Class to disable status "Cancel" button when an instance is created and reenable the button when the instance is destroyed. More...


Defines

#define RVCLOWLIBEXPORT   MI_DLLIMPORT
#define MSTATUSFLAG_NoCancel   0x0001
#define MSTATUSFLAG_DelayPopup   0x0002
#define MSTATUSFLAG_AllowFinish   0x0004
#define MstatusBarClear(c, ln)   ((*DftStatusInterface->StatusBarClear)(c,ln))
#define MstatusBarIncrement(c, ln, inc)   ((*DftStatusInterface->StatusBarIncrement)(c,ln,inc))
#define MstatusBarInit(c, ln, max)   ((*DftStatusInterface->StatusBarInit)(c,ln,max))
#define MstatusBarUpdate(c, ln, val, max)   ((*DftStatusInterface->StatusBarUpdate)(c,ln,val,max))
#define MstatusCheckCancel(h)   ((*DftStatusInterface->StatusCheckCancel)(h))
#define MstatusClearAll(c)   ((*DftStatusInterface->StatusClearAll)(c))
#define MstatusClearLine(c, ln)   ((*DftStatusInterface->StatusClearLine)(c,ln))
#define MstatusContextCreate(h)   ((*DftStatusInterface->StatusContextCreate)(h))
#define MstatusContextFree(c)   ((*DftStatusInterface->StatusContextFree)(c))
#define MstatusDialogCreate(p, ph, pc, f)   ((*DftStatusInterface->StatusDialogCreate)(p,ph,pc,f))
#define MstatusDialogDestroy(h)   ((*DftStatusInterface->StatusDialogDestroy)(h))
#define MstatusDisableCancel(h)   ((*DftStatusInterface->StatusDisableCancel)(h))
#define MstatusEnableCancel(h)   ((*DftStatusInterface->StatusEnableCancel)(h))
#define MstatusGetDefaultHandle()   ((*DftStatusInterface->StatusGetDefaultHandle)())
#define MstatusInterfaceGet()   (DftStatusInterface)
#define MstatusReportDone(h, mg, mc)   ((*DftStatusInterface->StatusReportDone)(h,mg,mc))
#define MstatusResetCancel(h)   ((*DftStatusInterface->StatusResetCancel)(h))
#define MstatusSetCancelFunc(h, f, d)   ((*DftStatusInterface->StatusSetCancelFunc)(h,f,d))
#define MstatusSetDefaultHandle(h)   ((*DftStatusInterface->StatusSetDefaultHandle)(h))
#define MstatusTextClear(c, ln)   ((*DftStatusInterface->StatusTextClear)(c,ln))
#define MstatusTextUpdateString(c, ln, s)   ((*DftStatusInterface->StatusTextUpdateString)(c,ln,s))
#define MstatusTextUpdateTimer(c, ln, mg, mc, t)   ((*DftStatusInterface->StatusTextUpdateTimer)(c,ln,mg,mc,t))
#define MstatusTimerGet(h)   ((*DftStatusInterface->StatusTimerGet)(h))
#define MstatusTimerReset(h)   ((*DftStatusInterface->StatusTimerReset)(h))
#define MstatusWaitForOK(h)   ((*DftStatusInterface->StatusWaitForOK)(h))

Typedefs

typedef _MSTATUSCONTEXT * MSTATUSCONTEXT
typedef _MSTATUSHANDLE * MSTATUSHANDLE
typedef _MSTATUSINTERFACE * MSTATUSINTERFACE

Functions

RVCLOWLIBEXPORT MSTATUSINTERFACE MfStatusGet (void)
RVCLOWLIBEXPORT void MfStatusSet (MSTATUSINTERFACE status)
void MstatusInterfaceSet (MSTATUSINTERFACE)
int MstatusFormCreate (CStatusBar *pStatusBar, MSTATUSHANDLE *rshandle, UINT32 flags)
void MstatusFormDestroy (MSTATUSHANDLE shandle)
void MstatusInterfaceInitWin (void)
ERRVALUE MstatusTextUpdate (MSTATUSCONTEXT c, INT16 line, const char *msggroup, const char *msgkey)
ERRVALUE MstatusTextUpdate (MSTATUSCONTEXT c, INT16 line, TEXTID textid)
 DEFINE_ENUM_OPERATORS (STATUSDIALOG::FLAGS)

Variables

MSTATUSINTERFACE DftStatusInterface

Detailed Description

<mi32/mstatus.h> Include file for "status display" functions

Definition in file mstatus.h.

Define Documentation

#define MstatusBarClear (  c,
ln   )     ((*DftStatusInterface->StatusBarClear)(c,ln))
 

Definition at line 355 of file mstatus.h.

#define MstatusBarIncrement (  c,
ln,
inc   )     ((*DftStatusInterface->StatusBarIncrement)(c,ln,inc))
 

Definition at line 356 of file mstatus.h.

#define MstatusBarInit (  c,
ln,
max   )     ((*DftStatusInterface->StatusBarInit)(c,ln,max))
 

Definition at line 357 of file mstatus.h.

#define MstatusBarUpdate (  c,
ln,
val,
max   )     ((*DftStatusInterface->StatusBarUpdate)(c,ln,val,max))
 

Definition at line 358 of file mstatus.h.

#define MstatusCheckCancel (  h   )     ((*DftStatusInterface->StatusCheckCancel)(h))
 

Definition at line 359 of file mstatus.h.

#define MstatusClearAll (  c   )     ((*DftStatusInterface->StatusClearAll)(c))
 

Definition at line 360 of file mstatus.h.

#define MstatusClearLine (  c,
ln   )     ((*DftStatusInterface->StatusClearLine)(c,ln))
 

Definition at line 361 of file mstatus.h.

#define MstatusContextCreate (  h   )     ((*DftStatusInterface->StatusContextCreate)(h))
 

Definition at line 362 of file mstatus.h.

#define MstatusContextFree (  c   )     ((*DftStatusInterface->StatusContextFree)(c))
 

Definition at line 363 of file mstatus.h.

#define MstatusDialogCreate (  p,
ph,
pc,
f   )     ((*DftStatusInterface->StatusDialogCreate)(p,ph,pc,f))
 

Definition at line 364 of file mstatus.h.

#define MstatusDialogDestroy (  h   )     ((*DftStatusInterface->StatusDialogDestroy)(h))
 

Definition at line 365 of file mstatus.h.

#define MstatusDisableCancel (  h   )     ((*DftStatusInterface->StatusDisableCancel)(h))
 

Definition at line 366 of file mstatus.h.

#define MstatusEnableCancel (  h   )     ((*DftStatusInterface->StatusEnableCancel)(h))
 

Definition at line 367 of file mstatus.h.

#define MSTATUSFLAG_AllowFinish   0x0004
 

Include "Finish" button.

Definition at line 244 of file mstatus.h.

#define MSTATUSFLAG_DelayPopup   0x0002
 

Don't popup until after a given time (read from Ini file).

Definition at line 243 of file mstatus.h.

#define MSTATUSFLAG_NoCancel   0x0001
 

Don't include "Cancel" button.

Definition at line 242 of file mstatus.h.

 
#define MstatusGetDefaultHandle (   )     ((*DftStatusInterface->StatusGetDefaultHandle)())
 

Definition at line 368 of file mstatus.h.

 
#define MstatusInterfaceGet (   )     (DftStatusInterface)
 

Definition at line 369 of file mstatus.h.

#define MstatusReportDone (  h,
mg,
mc   )     ((*DftStatusInterface->StatusReportDone)(h,mg,mc))
 

Definition at line 372 of file mstatus.h.

#define MstatusResetCancel (  h   )     ((*DftStatusInterface->StatusResetCancel)(h))
 

Definition at line 374 of file mstatus.h.

#define MstatusSetCancelFunc (  h,
f,
d   )     ((*DftStatusInterface->StatusSetCancelFunc)(h,f,d))
 

Definition at line 375 of file mstatus.h.

#define MstatusSetDefaultHandle (  h   )     ((*DftStatusInterface->StatusSetDefaultHandle)(h))
 

Definition at line 376 of file mstatus.h.

#define MstatusTextClear (  c,
ln   )     ((*DftStatusInterface->StatusTextClear)(c,ln))
 

Definition at line 377 of file mstatus.h.

#define MstatusTextUpdateString (  c,
ln,
s   )     ((*DftStatusInterface->StatusTextUpdateString)(c,ln,s))
 

Definition at line 379 of file mstatus.h.

#define MstatusTextUpdateTimer (  c,
ln,
mg,
mc,
t   )     ((*DftStatusInterface->StatusTextUpdateTimer)(c,ln,mg,mc,t))
 

Definition at line 381 of file mstatus.h.

#define MstatusTimerGet (  h   )     ((*DftStatusInterface->StatusTimerGet)(h))
 

Definition at line 383 of file mstatus.h.

#define MstatusTimerReset (  h   )     ((*DftStatusInterface->StatusTimerReset)(h))
 

Definition at line 384 of file mstatus.h.

#define MstatusWaitForOK (  h   )     ((*DftStatusInterface->StatusWaitForOK)(h))
 

Definition at line 385 of file mstatus.h.

#define RVCLOWLIBEXPORT   MI_DLLIMPORT
 

Definition at line 233 of file mstatus.h.

Typedef Documentation

typedef struct _MSTATUSCONTEXT * MSTATUSCONTEXT
 

typedef struct _MSTATUSHANDLE * MSTATUSHANDLE
 

typedef struct _MSTATUSINTERFACE * MSTATUSINTERFACE
 

Generic status interface structure.

Function Documentation

DEFINE_ENUM_OPERATORS (  STATUSDIALOG::FLAGS   ) 
 

RVCLOWLIBEXPORT MSTATUSINTERFACE MfStatusGet (  void   ) 
 

Get the status.

RVCLOWLIBEXPORT void MfStatusSet (  MSTATUSINTERFACE  status  ) 
 

Set the status.

int MstatusFormCreate (  CStatusBar *  pStatusBar,
MSTATUSHANDLE *  rshandle,
UINT32  flags
) 
 

Create and manage a single line status form.

Parameters:
pStatusBar  Parent widget for dialog (will use toplevel if NULL)
rshandle  Status handle returned
flags  Flags

void MstatusFormDestroy (  MSTATUSHANDLE  shandle  ) 
 

Destroy and clear status form.

void MstatusInterfaceInitWin (  void   ) 
 

Initialize status interface to Windows functions.

void MstatusInterfaceSet (  MSTATUSINTERFACE   ) 
 

ERRVALUE MstatusTextUpdate (  MSTATUSCONTEXT  c,
INT16  line,
TEXTID  textid
)  [inline]
 

Definition at line 427 of file mstatus.h.

ERRVALUE MstatusTextUpdate (  MSTATUSCONTEXT  c,
INT16  line,
const char *  msggroup,
const char *  msgkey
)  [inline]
 

Definition at line 419 of file mstatus.h.

Variable Documentation

MSTATUSINTERFACE DftStatusInterface
 

Definition at line 335 of file mstatus.h.

Generated on Thu Aug 12 06:23:29 2004 for TNTsdk by doxygen 1.3.4-20031026