CATAppButton.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
/// \file CATAppButton.h
/// \brief Specialized pushbutton for launching apps
/// \ingroup CATGUI
/// 
/// Copyright (c) 2003-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-30 06:11:10 -0600 (Wed, 30 Jan 2008) $
// $Revision:   $
// $NoKeywords: $
//---------------------------------------------------------------------------
#ifndef CATAppButton_H_
#define CATAppButton_H_

#include "CATButton.h"

/// \class CATAppButton CATAppButton.h
/// \brief Specialized pushbutton for launching apps
/// \ingroup CATGUI
///
/// AppButtons automatically pick up the icon of the executable they are
/// set to, or disable themselves if they cannot find it.
///
/// A few ways to configure AppButtons for the executable.
/// Currently supported attributes:
///     -# "AppPath" attribute may contain full absolute path to the .exe
///     -# "UninstallId" may be used to get the uninstall path.  This is the
///        subkey under HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall
///        for the game's uninstaller.  InstallLocation should contain the base
///        directory.
///        Use "AppFile" for the relative path from the install location of the
///        executable to use.
///
class CATAppButton : public CATButton
{
    public:
        CATAppButton(   const CATString&             element, 
                        const CATString&             rootDir);

        virtual ~CATAppButton();          

        /// ParseAttributes() parses the known attributes for an object.
        virtual CATResult ParseAttributes();

        /// Draw() draws the control into the parent's image
        /// \param image - parent image to draw into
        /// \param dirtyRect - portion of control (in window coordinates)
        ///        that requires redrawing.
        virtual void   Draw(CATImage* image, const CATRect& dirtyRect);

        /// PostDraw() draws any stuff that requires an OS-specific draw
        /// context.
        virtual void   PostDraw(CATDRAWCONTEXT drawContext, const CATRect& dirtyRect);

    protected:
        CATString   fAppPath;
        CATString   fAppName;
        CATICON     fIconImage;
        CATInt32    fBorder;
};

#endif // CATAppButton_H_

---