UnitFigure.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file UnitFigure.hh
 *
 * Declaration of UnitFigure class.
 *
 * @author Ari Metsähalme 2003 (ari.metsahalme-no.spam-tut.fi)
 * @note rating: yellow
 * @note reviewed Jul 22 2004 by tr, ml, jm, am
 */
 
#ifndef TTA_UNIT_FIGURE_HH
#define TTA_UNIT_FIGURE_HH
 
#include <wx/wx.h>
 
#include "Figure.hh"
 
class wxDC;
 
/**
 * Figure of a unit.
 */
class UnitFigure : public Figure {
public:
    UnitFigure();
    virtual ~UnitFigure();
 
    void setName(const wxString& name);
    void setInfo(const wxString& info);
 
protected:
    virtual void layout(wxDC*);
    virtual void layoutSelf(wxDC*);
    virtual void layoutChildren(wxDC*);
    virtual void drawSelf(wxDC*);
 
private:
    /// Assignment not allowed.
    UnitFigure& operator=(UnitFigure& old);
    /// Copying not allowed.
    UnitFigure(UnitFigure& old);
 
    /// Type identifier of the unit.
    wxString type_;
    /// Name of the unit.
    wxString name_;
    /// Extra information string describing the unit.
    wxString info_;
 
    /// Default colour for the figure.
    static const wxColour DEFAULT_COLOUR;
    /// Default background colour for the figure.
    static const wxColour DEFAULT_BG_COLOUR;
    /// Default info string colour for the figure.
    static const wxColour DEFAULT_INFO_TEXT_COLOUR;
    /// Top and bottom margin in pixels.
    static const int MARGIN;
    /// Space between text rows in pixels.
    static const int SPACING;
};
 
#endif