/data/gitorious.org/libyui/libyui-master/src/YCheckBox.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

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.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:         YCheckBox.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YCheckBox_h
#define YCheckBox_h

#include <string>

#include "YWidget.h"
#include "ImplPtr.h"

using std::string;
class YCheckBoxPrivate;

enum YCheckBoxState
{
    YCheckBox_dont_care = -1,   // tristate
    YCheckBox_off       = 0,
    YCheckBox_on        = 1
};


class YCheckBox : public YWidget
{
protected:
    YCheckBox( YWidget * parent, const string & label );
    
public:
    virtual ~YCheckBox();

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


    virtual YCheckBoxState value() = 0;

    virtual void setValue( YCheckBoxState state ) = 0;

    bool isChecked() { return value() == YCheckBox_on; }

    void setChecked( bool checked = true )
        { setValue( checked ? YCheckBox_on : YCheckBox_off ); }

    bool dontCare() { return value() == YCheckBox_dont_care; }
    
    void setDontCare() { setValue( YCheckBox_dont_care ); }
    
    string label() const;

    virtual void setLabel( const string & label );

    bool useBoldFont() const;

    virtual void setUseBoldFont( bool bold = true );

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

    virtual YPropertyValue getProperty( const string & propertyName );

    virtual const YPropertySet & propertySet();

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

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

    const char * userInputProperty() { return YUIProperty_Value; }


private:

    ImplPtr<YCheckBoxPrivate> priv;
};


#endif // YCheckBox_h