Standard Euler Disclaimer

The Standard Euler Disclaimer can be used by the module developer to display internal module/database information.

Interface

typedef BOOL (CALLBACK *CALLBACKFN)( WPARAM wParam, LPARAM lParam );
 
extern "C"
{
void WINAPI DisclaimerSetCallBack( CALLBACKFN Fn, WPARAM wParam, LPARAM lParam );
BOOL WINAPI DisclaimerCreate( HWND hwnd );
DWORD WINAPI DisclaimerWrite( const char* info , DWORD key );
HWND WINAPI DisclaimerGetHWnd();
}
void WINAPI DisclaimerSetCallBack( CALLBACKFN Fn, WPARAM wParam, LPARAM lParam )

This function sets the address of the initialisation loop function and its parameters. The callback function will be called during the initialisation process and must have one or more call to DisclaimeWrite function to append output text area with information. After the return of the callback function, the OK button of the disclaimer dialog box is enabled and the disclaimer is in modal state.

BOOL WINAPI DisclaimerCreate( HWND hwnd )

This function is called to display the Standard Euler Disclaimer in modal mode. The hwnd parameter can be used to attach the application window , if a NULL value is passed, the disclaimer window is attach to the Windows desktop. A FALSE return value indicates that the user wants to abort the initialisation process (by clicking on the cancel button or pressing the escape key ).

DWORD WINAPI DisclaimerWrite( const char* info, DWORD key )

This function has to be called into the initialisation loop defined by the DisclaimerSetCallBack function. The info parameter is a zero-ended character string who can contain two kinds of messages: an unformatted message or a rich text format (RTF) message. The message is appended at the bottom of the text control of the disclaimer dialog window. The key parameter is reserved and must be set to 0 (zero). The DWORD returned value is reserved.

HWND WINAPI DisclaimerGetHWnd()

This function returns the window handle of the Euler Disclaimer.

Examples.

You can see two examples of using the Standard Euler Disclaimer in files Euler\Apps\cmdEuler\cmdEuler.cpp and Euler\Apps\WinEuler\EulerBar.cpp.

The moduleInfo function of any of the modules provided with EULER use the DisclaimerWrite function to display their legal information; see Euler\Module\RulePreProcessorFr\RulePreProcessorFr.cpp for example.


Copyright © 1999 TCTS LAB, Faculté Polytechnique de Mons, Belgium