windows-server-2003/base/cluster/admin/common/atlbaseapp.h

/////////////////////////////////////////////////////////////////////////////
//
//  Copyright (c) 1998-2002 Microsoft Corporation
//
//  Module Name:
//      AtlBaseApp.h
//
//  Description:
//      Definition of the CBaseApp class.
//
//  Author:
//      Galen Barbee (galenb)   May 21, 1998
//
//  Revision History:
//
//  Notes:
//
/////////////////////////////////////////////////////////////////////////////

#pragma once

#ifndef __ATLBASEAPP_H_
#define __ATLBASEAPP_H_

/////////////////////////////////////////////////////////////////////////////
// Forward Class Declarations
/////////////////////////////////////////////////////////////////////////////

class CBaseApp;

/////////////////////////////////////////////////////////////////////////////
// External Class Declarations
/////////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////////////////////////////////////
// Include Files
/////////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////////////////////////////////////
// Type Definitions
/////////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////////////////////////////////////
//++
//
//  class CBaseApp
//
//  Description:
//      Base application class.  The following functionality is provided:
//      -- Help file support.
//
//  Inheritance:
//      CBaseApp
//      CComModule
//
//--
/////////////////////////////////////////////////////////////////////////////

class CBaseApp : public CComModule
{
public:
    //
    // Construction.
    //

    // Default constructor
    CBaseApp( void )
        : m_pszHelpFilePath( NULL )
    {
    } //*** CBaseApp()

    // Destructor
    ~CBaseApp( void )
    {
        delete m_pszHelpFilePath;

    } //*** ~CBaseApp()

    // Return the path to the help file, generate if necessary
    virtual LPCTSTR PszHelpFilePath( void );

    // Return the name of the help file
    virtual LPCTSTR PszHelpFileName( void )
    {
        //
        // Override this method or no help file name will
        // be specified for this application.
        //
        return NULL;

    } //*** PszHelpFileName()

private:
    LPTSTR  m_pszHelpFilePath;

}; //*** class CBaseApp

/////////////////////////////////////////////////////////////////////////////

#endif // __ATLBASEAPP_H_