/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   copyright (C) 2003-2006                                               *
 *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
 ***************************************************************************/

#ifndef ENUMWIDGET_H
#define ENUMWIDGET_H

#include "umlwidget.h"

class UMLView;

#define ENUM_MARGIN 5

/**
 * Defines a graphical version of the enum.  Most of the functionality
 * will come from the @ref UMLWidget class from which class inherits from.
 *
 * @short A graphical version of an enum.
 * @author Jonathan Riddell
 * @see UMLWidget
 * Bugs and comments to uml-devel@lists.sf.net or http://bugs.trinitydesktop.org
 */
class EnumWidget : public UMLWidget {
public:

    /**
     * Constructs an EnumWidget.
     *
     * @param view              The parent of this EnumWidget.
     * @param o         The UMLObject this will be representing.
     */
    EnumWidget(UMLView* view, UMLObject* o);

    /**
     * Standard deconstructor.
     */
    ~EnumWidget();

    /**
     * Initializes key variables of the class.
     */
    void init();

    /**
     * Returns the status of whether to show Package.
     *
     * @return  True if package is shown.
     */
    bool getShowPackage() const;

    /**
     * Toggles the status of whether to show package.
     */
    void toggleShowPackage();

    /**
     * Set the status of whether to show Package.
     *
     * @param _status             True if package shall be shown.
     */
    void setShowPackage(bool _status);

    /**
     * Draws the enum as a rectangle with a box underneith with a list of literals
     */
    void draw(TQPainter& p, int offsetX, int offsetY);

    /**
     * Saves to the "enumwidget" XMI element.
     */
    void saveToXMI(TQDomDocument& qDoc, TQDomElement& qElement);

    /**
     * Loads from an "enumwidget" XMI element.
     */
    bool loadFromXMI(TQDomElement& qElement);

protected:
    /**
     * Overrides method from UMLWidget.
     */
    TQSize calculateSize();

    bool m_bShowPackage;

private:
    /**
     * The right mouse button menu.
     */
    ListPopupMenu* m_pMenu;

public slots:
    /**
     * Will be called when a menu selection has been made from the
     * popup menu.
     *
     * @param sel       The selection id that has been selected.
     */
    void slotMenuSelection(int sel);
};

#endif