- Your Widget Set For OpenGL

---

ubutton.hpp

/***************************************************************************
    LibUFO - UI For OpenGL
    copyright         : (C) 2001-2005 by Johannes Schmidt
    email             : schmidtjf at users.sourceforge.net
                             -------------------

    file              : include/ufo/widgets/ubutton.hpp
    begin             : Mon May 28 2001
    $Id: ubutton.hpp,v 1.17 2005/06/21 09:27:23 schmidtjf Exp $
 ***************************************************************************/

/***************************************************************************
 *  This library is free software; you can redistribute it and/or          *
 * modify it under the terms of the GNU Lesser General Public              *
 * License as published by the Free Software Foundation; either            *
 * version 2.1 of the License, or (at your option) any later version.      *
 *                                                                         *
 * This library is distributed in the hope that it will be useful,         *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU       *
 * Lesser General Public License for more details.                         *
 *                                                                         *
 * You should have received a copy of the GNU Lesser General Public        *
 * License along with this library; if not, write to the Free Software     *
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
 ***************************************************************************/

#ifndef UBUTTON_HPP
#define UBUTTON_HPP

#include "ucompound.hpp"
#include "../events/ukeysym.hpp"
#include "../ukeystroke.hpp"

namespace ufo {
class UButtonGroup;

class UFO_EXPORT UButton : public UCompound {
    UFO_DECLARE_DYNAMIC_CLASS(UButton)
    UFO_UI_CLASS(UButtonUI)
    UFO_STYLE_TYPE(UStyle::CE_Button)
public:
    UButton();
    UButton(UIcon * icon);
    UButton(const std::string & text, UIcon * icon = NULL);

public: // Public methods
    virtual void doClick();

    virtual void doClick(int millis);

    virtual bool isSelected() const ;

    virtual void setSelected(bool b);

    bool isPressed() const;

    void setPressed(bool b);

    bool isRolloverEnabled() const ;

    void setRolloverEnabled(bool b);

    bool isRollover() const;

    bool isToggable() const ;

    void setToggable(bool b);

    virtual std::string getActionCommand() const;

    virtual void setActionCommand(const std::string & actionCommand);

    //
    // icons
    //
    void setPressedIcon(UIcon * icon);
    UIcon * getPressedIcon() const;
    void setRolloverIcon(UIcon * icon);
    UIcon * getRolloverIcon() const;

    void setAccelerator(const UKeyStroke & stroke);
    UKeyStroke getAccelerator() const;

    int getAcceleratorIndex() const;

    void setButtonGroup(UButtonGroup * buttonGroup);
    UButtonGroup * getButtonGroup() const;

    virtual void activate();

public: // Overrides UWidget
    virtual bool isActive() const;

public: // Overrides UCompound
    virtual UIcon * getIcon() const;
    virtual void setText(const std::string & text);


protected:  // Protected slots
    void fireActionEvent();
    void buttonUp();

protected:  // Overrides UWidget
    virtual UDimension getContentsSize(const UDimension & maxSize) const;
    virtual void processKeyEvent(UKeyEvent * e);
    virtual void processMouseEvent(UMouseEvent * e);
    virtual void processShortcutEvent(UShortcutEvent * e);

private:  // Private attributes
    UIcon * m_pressedIcon;
    UIcon * m_rolloverIcon;

    std::string m_actionCommand;

    UButtonGroup * m_buttonGroup;

    UKeyStroke m_accelerator;
    int m_acceleratorIndex;

public: // Public signal methods
    USignal1<UActionEvent*> & sigActivated() { return m_sigActivated; }

    USignal1<UActionEvent*> & sigHighlighted() { return m_sigHighlighted; }

private: // Private signals
    USignal1<UActionEvent*> m_sigActivated;
    USignal1<UActionEvent*> m_sigHighlighted;
};


//
// inline implementation
//

inline UIcon *
UButton::getPressedIcon() const {
    return m_pressedIcon;
}

inline UIcon *
UButton::getRolloverIcon() const {
    return m_rolloverIcon;
}

} // namespace ufo

#endif // UBUTTON_HPP

---