CATLabel.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
/// \file CATLabel.h
/// \brief Text label for GUI
/// \ingroup CATGUI
/// 
/// Copyright (c) 2003-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-24 06:27:32 -0600 (Thu, 24 Jan 2008) $
// $Revision:   $
// $NoKeywords: $
//---------------------------------------------------------------------------
#ifndef _GGLabel_H_
#define _GGLabel_H_

#include "CATControl.h"

class CATLabel;

/// \class CATLabel CATLabel.h
/// \brief Text label for GUI
/// \ingroup CATGUI
///
class CATLabel : public CATControl
{
public:
    /// CATLabel constructor (inherited from CATControl->CATXMLObject)
    /// \param element - Type name ("Label")
    /// \param attribs - attribute information for the window
    /// \param parent - parent XML object (should be a "Window" element)
    /// \param rootDir - root directory of skin for bin/png load
    CATLabel(    const CATString&             element, 
        const CATString&             rootDir);

    virtual ~CATLabel();          

    /// IsFocusable() returns true if the control can receive
    /// focus, and false otherwise.
    virtual bool         IsFocusable() const;

    /// 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);


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

    virtual void SetString ( const CATString& text );
    virtual CATString GetString () const;

    /// Event handler
    virtual CATResult OnEvent(const CATEvent& event, CATInt32& retVal);

#ifdef _WIN32
    virtual CATUInt32     GetAccessRole() {return CAT_ROLE_SYSTEM_TEXT;}
#endif


protected:
    bool        fAllowClick;
};

#endif // _GGLabel_H_

---