CAdUiBaseDialog.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include <afxwin.h>
class CAdUiAssist;
class CDC;
class CDataExchange;
class CToolTipCtrl;
class CAdUiTextTip;
class CWnd;
 
class ARX_API CAdUiBaseDialog : public CDialog
{
public:
         DECLARE_DYNAMIC(CAdUiBaseDialog);
 
protected:
         static  CAdUiAssist * m_pUIAssist;
 
public:
        void SetContextHelpMapFileName(wchar_t const *);
        wchar_t const * GetContextHelpMapFileName(void);
          CAdUiBaseDialog(unsigned int, CWnd* =NULL, HINSTANCE__* =NULL);
          CToolTipCtrl *  GetToolTipCtrl(void);
         int  DisplayData(void);
         int  EditorCommandCancelled(void);
         int  GetUseTips(void);
         int  ValidateData(void);
          HICON__ *  GetDialogIcon(void);
         virtual  ~CAdUiBaseDialog(void);
         virtual  CWnd *  AppMainWindow(void);
         virtual int  Create(unsigned int, CWnd * = NULL);
         virtual int  Create(wchar_t const *, CWnd * = NULL);
         virtual int  DoDialogHelp(void);
     virtual INT_PTR  DoModal(void);
         virtual int  EnableMultiDocumentActivation(int);
         virtual int  ExchangeData(int);
         virtual int  IsMultiDocumentActivationEnabled(void);
         virtual int  PreTranslateMessage( tagMSG *);
         virtual  HINSTANCE__ *  AppResourceInstance(void);
         virtual void  EnableFloatingWindows(int);
         virtual wchar_t const *  AppRootKey(void);
         void  SetAppRootKey(wchar_t const *);
         void  SetContextHelpFileName(wchar_t const *);
         void  SetContextHelpFullPathName(wchar_t const *);
         void  SetContextHelpPrefix(wchar_t const *);
         void  SetDialogIcon( HICON__ *);
         void  SetUseTips(int);
         wchar_t const *  GetContextHelpFileName(void);
         wchar_t const *  GetContextHelpFullPathName(void);
         wchar_t const *  GetContextHelpPrefix(void);
 
protected:
         int  OnHelpInfo( tagHELPINFO *);
         int  OnNotify_ToolTipText(unsigned int, tagNMHDR *,LRESULT *);
     afx_msg LRESULT OnAdUiMessage(WPARAM wParam, LPARAM lParam);
         DECLARE_MESSAGE_MAP()
          HBRUSH__ *  OnCtlColor( CDC *, CWnd *,unsigned int);
         virtual  ADUI_REPLY  DoAdUiMessage( ADUI_NOTIFY,unsigned int, LPARAM);
         virtual  ADUI_REPLY  OnNotifyControlChange(unsigned int,LPARAM);
         virtual  ADUI_REPLY  OnNotifyControlValid(unsigned int,int);
         virtual  ADUI_REPLY  OnNotifyGeneric(unsigned int,LPARAM);
         virtual  ADUI_REPLY  OnNotifyUpdateTip( CWnd *);
         virtual int  FindContextHelpFullPath(wchar_t const *, CStringW &);
         virtual int  OnInitDialog(void);
         virtual int  PreCreateWindow( tagCREATESTRUCTW &);
         virtual void  DoDataExchange( CDataExchange *);
         virtual void  OnInitDialogBegin(void);
         virtual void  OnInitDialogFinish(void);
         virtual void  PostNcDestroy(void);
         virtual void OnClose(void);
         void  BeginEditorCommand(void);
         void  CancelEditorCommand(void);
         void  CompleteEditorCommand( int = 1 );
         void  MakeDialogsVisible(int);
         void  OnActivate(unsigned int, CWnd *,int);
         void  OnAdUiTimer(UINT_PTR);
 
     CString m_rootKey;
         int MultiDocumentActivate;
     CAdUiTextTip *m_pTextTip;
     HICON m_hIcon;
     HINSTANCE m_hDialogResource;
 
protected:
    CString m_contextHelpFileName;
    CString m_contextHelpFullPathName;
    CString m_contextHelpPrefix;
};