fluxbox/src/FbTk/Button.hh

// Button.hh for FbTk - Fluxbox Toolkit
// Copyright (c) 2002 Henrik Kinnunen (fluxgen at users.sourceforge.net)
//
// 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.

// $Id: Button.hh,v 1.1 2002/12/13 20:24:33 fluxgen Exp $

#ifndef FBTK_BUTTON_HH
#define FBTK_BUTTON_HH

#include "EventHandler.hh"
#include "NotCopyable.hh"
#include "RefCount.hh"
#include "FbWindow.hh"
#include "Command.hh"

#include <X11/Xlib.h>
#include <memory>

namespace FbTk {

class Color;

class Button:public EventHandler, 
             private NotCopyable {
public:
    Button(int screen_num, int x, int y, unsigned int width, unsigned int height);
    Button(FbWindow &parent, int x, int y, unsigned int width, unsigned int height);
    virtual ~Button();	
    /// sets action when the button is clicked
    void setOnClick(RefCount<Command> &com) { m_onclick = com; }
    void move(int x, int y);
    void resize(unsigned int width, unsigned int height);
    void moveResize(int x, int y, unsigned int width, unsigned int height);
    /// sets the pixmap to be viewd when the button is in normal state (ie not pressed)
    void setPixmap(Pixmap pm);
    /// sets the pixmap to be viewed when the button is pressed
    void setPressedPixmap(Pixmap pm);
    void setGC(GC gc) { m_gc = gc; }
    /// sets background pixmap, this will override background color
    void setBackgroundPixmap(Pixmap pm);
    /// sets background color
    void setBackgroundColor(const Color &color);
    /// show button
    void show();
    /// hide button
    void hide();
    virtual void clear() { m_win.clear(); }
    /**
       @name eventhandlers
     */
    //@{
    virtual void buttonPressEvent(XButtonEvent &event);
    virtual void buttonReleaseEvent(XButtonEvent &event);
    virtual void exposeEvent(XExposeEvent &event);
    //@}
    /// @return true if the button is pressed, else false
    bool pressed() const { return m_pressed; }
    /**
       @name position and size of the button
     */
    //@{
    int x() const { return m_win.x(); }
    int y() const { return m_win.y(); }
    unsigned int width() const { return m_win.width(); }
    unsigned int height() const { return m_win.height(); }
    //@}
    FbWindow &window() { return m_win; }
    const FbWindow &window() const { return m_win; }
    GC gc() const { return m_gc; }
private:
    FbTk::FbWindow m_win; ///< window for button
    Pixmap m_foreground_pm; ///< foreground pixmap
    Pixmap m_pressed_pm; ///< pressed pixmap
    GC m_gc; ///< graphic context for button
    bool m_pressed; ///< if the button is pressed
    RefCount<Command> m_onclick; ///< what to do when this button is clicked
};

};

#endif // FBTK_BUTTON_HH