Main Page | Modules | Directories | 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 MSTATUSFLAG_AllowFinish   0x0004
#define MSTATUSFLAG_DelayPopup   0x0002
#define MSTATUSFLAG_NoCancel   0x0001
#define RVCLOWLIBEXPORT   MI_DLLIMPORT

Typedefs

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

Functions

 DEFINE_ENUM_OPERATORS (STATUSDIALOG::FLAGS)
RVCLOWLIBEXPORT MSTATUSINTERFACE MfStatusGet (void)
RVCLOWLIBEXPORT void MfStatusSet (MSTATUSINTERFACE status)
DEPRECATED void MstatusBarClear (MSTATUSCONTEXT c, INT16 ln)
DEPRECATED int MstatusBarIncrement (MSTATUSCONTEXT c, INT16 ln, INT32 inc)
DEPRECATED int MstatusBarInit (MSTATUSCONTEXT c, INT16 ln, INT32 max)
DEPRECATED int MstatusBarUpdate (MSTATUSCONTEXT c, INT16 ln, INT32 val, INT32 max)
DEPRECATED int MstatusCheckCancel (MSTATUSHANDLE h)
DEPRECATED void MstatusClearAll (MSTATUSCONTEXT c)
DEPRECATED void MstatusClearLine (MSTATUSCONTEXT c, INT16 ln)
DEPRECATED MSTATUSCONTEXT MstatusContextCreate (MSTATUSHANDLE h)
DEPRECATED void MstatusContextFree (MSTATUSCONTEXT c)
DEPRECATED int MstatusDialogCreate (MDLGPARENT p, MSTATUSHANDLE *ph, MSTATUSCONTEXT *pc, UINT32 flags)
DEPRECATED void MstatusDialogDestroy (MSTATUSHANDLE h)
DEPRECATED void MstatusDisableCancel (MSTATUSHANDLE h)
DEPRECATED void MstatusEnableCancel (MSTATUSHANDLE h)
int MstatusFormCreate (CStatusBar *pStatusBar, MSTATUSHANDLE *rshandle, UINT32 flags)
void MstatusFormDestroy (MSTATUSHANDLE shandle)
MSTATUSHANDLE MstatusGetDefaultHandle ()
MSTATUSINTERFACE & MstatusInterfaceGet ()
void MstatusInterfaceInitWin (void)
void MstatusInterfaceSet (MSTATUSINTERFACE StatusInterface)
DEPRECATED void MstatusReportDone (MSTATUSHANDLE h, const char *mg, const char *mc)
DEPRECATED void MstatusResetCancel (MSTATUSHANDLE h)
DEPRECATED void MstatusSetCancelFunc (MSTATUSHANDLE h, int(*f)(MSTATUSHANDLE, void *), void *d)
DEPRECATED MSTATUSHANDLE MstatusSetDefaultHandle (MSTATUSHANDLE h)
DEPRECATED void MstatusTextClear (MSTATUSCONTEXT c, INT16 ln)
ERRVALUE MstatusTextUpdate (MSTATUSCONTEXT c, INT16 line, TEXTID textid)
DEPRECATED ERRVALUE MstatusTextUpdate (MSTATUSCONTEXT c, INT16 line, const char *msggroup, const char *msgkey)
DEPRECATED int MstatusTextUpdateString (MSTATUSCONTEXT c, INT16 ln, const UNICODE *s)
DEPRECATED int MstatusTextUpdateTimer (MSTATUSCONTEXT c, INT16 ln, const char *mg, const char *mc, MTIMER *t)
DEPRECATED MTIMER * MstatusTimerGet (MSTATUSHANDLE h)
DEPRECATED void MstatusTimerReset (MSTATUSHANDLE h)
DEPRECATED void MstatusWaitForOK (MSTATUSHANDLE h)

Variables

MSTATUSINTERFACE DftStatusInterface

Detailed Description

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

Definition in file mstatus.h.

Define Documentation

#define MSTATUSFLAG_AllowFinish   0x0004
 

Include "Finish" button.

Definition at line 263 of file mstatus.h.

#define MSTATUSFLAG_DelayPopup   0x0002
 

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

Definition at line 262 of file mstatus.h.

#define MSTATUSFLAG_NoCancel   0x0001
 

Don't include "Cancel" button.

Definition at line 261 of file mstatus.h.

#define RVCLOWLIBEXPORT   MI_DLLIMPORT
 

Definition at line 252 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.

DEPRECATED void MstatusBarClear (  MSTATUSCONTEXT  c,
INT16  ln
)  [inline]
 

Definition at line 371 of file mstatus.h.

DEPRECATED int MstatusBarIncrement (  MSTATUSCONTEXT  c,
INT16  ln,
INT32  inc
)  [inline]
 

Definition at line 376 of file mstatus.h.

DEPRECATED int MstatusBarInit (  MSTATUSCONTEXT  c,
INT16  ln,
INT32  max
)  [inline]
 

Definition at line 382 of file mstatus.h.

DEPRECATED int MstatusBarUpdate (  MSTATUSCONTEXT  c,
INT16  ln,
INT32  val,
INT32  max
)  [inline]
 

Definition at line 388 of file mstatus.h.

DEPRECATED int MstatusCheckCancel (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 395 of file mstatus.h.

DEPRECATED void MstatusClearAll (  MSTATUSCONTEXT  c  )  [inline]
 

Definition at line 399 of file mstatus.h.

DEPRECATED void MstatusClearLine (  MSTATUSCONTEXT  c,
INT16  ln
)  [inline]
 

Definition at line 403 of file mstatus.h.

DEPRECATED MSTATUSCONTEXT MstatusContextCreate (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 408 of file mstatus.h.

DEPRECATED void MstatusContextFree (  MSTATUSCONTEXT  c  )  [inline]
 

Definition at line 412 of file mstatus.h.

DEPRECATED int MstatusDialogCreate (  MDLGPARENT  p,
MSTATUSHANDLE *  ph,
MSTATUSCONTEXT *  pc,
UINT32  flags
)  [inline]
 

Definition at line 416 of file mstatus.h.

DEPRECATED void MstatusDialogDestroy (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 423 of file mstatus.h.

DEPRECATED void MstatusDisableCancel (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 427 of file mstatus.h.

DEPRECATED void MstatusEnableCancel (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 431 of file mstatus.h.

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.

MSTATUSHANDLE MstatusGetDefaultHandle (   )  [inline]
 

Definition at line 435 of file mstatus.h.

MSTATUSINTERFACE& MstatusInterfaceGet (   )  [inline]
 

Definition at line 438 of file mstatus.h.

void MstatusInterfaceInitWin (  void   ) 
 

Initialize status interface to Windows functions.

void MstatusInterfaceSet (  MSTATUSINTERFACE  StatusInterface  ) 
 

DEPRECATED void MstatusReportDone (  MSTATUSHANDLE  h,
const char *  mg,
const char *  mc
)  [inline]
 

Definition at line 446 of file mstatus.h.

DEPRECATED void MstatusResetCancel (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 453 of file mstatus.h.

DEPRECATED void MstatusSetCancelFunc (  MSTATUSHANDLE  h,
int(*  f)(MSTATUSHANDLE, void *),
void *  d
)  [inline]
 

Definition at line 457 of file mstatus.h.

DEPRECATED MSTATUSHANDLE MstatusSetDefaultHandle (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 463 of file mstatus.h.

DEPRECATED void MstatusTextClear (  MSTATUSCONTEXT  c,
INT16  ln
)  [inline]
 

Definition at line 467 of file mstatus.h.

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

Definition at line 540 of file mstatus.h.

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

Definition at line 532 of file mstatus.h.

DEPRECATED int MstatusTextUpdateString (  MSTATUSCONTEXT  c,
INT16  ln,
const UNICODE *  s
)  [inline]
 

Definition at line 472 of file mstatus.h.

DEPRECATED int MstatusTextUpdateTimer (  MSTATUSCONTEXT  c,
INT16  ln,
const char *  mg,
const char *  mc,
MTIMER *  t
)  [inline]
 

Definition at line 479 of file mstatus.h.

DEPRECATED MTIMER* MstatusTimerGet (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 488 of file mstatus.h.

DEPRECATED void MstatusTimerReset (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 492 of file mstatus.h.

DEPRECATED void MstatusWaitForOK (  MSTATUSHANDLE  h  )  [inline]
 

Definition at line 496 of file mstatus.h.

Variable Documentation

MSTATUSINTERFACE DftStatusInterface
 

Generated on Tue Dec 14 13:19:09 2004 for TNTsdk by  doxygen 1.3.8-20040913