YPushButton.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  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) version 3.0 of the License. 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., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YPushButton.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YPushButton_h
#define YPushButton_h

#include "YWidget.h"

class YPushButtonPrivate;



class YPushButton : public YWidget
{
protected:
    YPushButton( YWidget * parent, const std::string & label );

public:
    virtual ~YPushButton();

    virtual const char * widgetClass() const { return "YPushButton"; }

    std::string label() const;

    virtual void setLabel( const std::string & label );

    virtual void setIcon( const std::string & iconName ) {}

    bool isDefaultButton() const;

    virtual void setDefaultButton( bool def = true );

    virtual void setRole( YButtonRole role );

    YButtonRole role() const;

    virtual void setFunctionKey( int fkey_no );


    bool isHelpButton() const;

    virtual void setHelpButton( bool helpButton = true );

    bool isRelNotesButton() const;

    virtual void setRelNotesButton( bool relNotesButton = true );

    virtual bool setProperty( const std::string    & propertyName,
                  const YPropertyValue & val );

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();

    virtual std::string shortcutString() const { return label(); }

    virtual void setShortcutString( const std::string & str )
    { setLabel( str ); }


    virtual void activate() = 0;

private:

    ImplPtr<YPushButtonPrivate> priv;
};


std::ostream & operator<<( std::ostream & stream, YButtonRole role );


typedef YPushButton YIconButton;


#endif // YPushButton_h