/data/gitorious.org/libyui/libyui-master/src/YInputField.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:         YInputField.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YInputField_h
#define YInputField_h

#include <string>
#include "YWidget.h"

class YInputFieldPrivate;

using std::string;


class YInputField : public YWidget
{
protected:
    YInputField( YWidget *      parent,
                 const string & label,
                 bool           passwordMode = false );

public:
    virtual ~YInputField();

    virtual const char * widgetClass() const;

    virtual string value() = 0;

    virtual void setValue( const string & text ) = 0;

    string label() const;

    virtual void setLabel( const string & label );

    bool passwordMode() const;

    string validChars();

    virtual void setValidChars( const string & validChars );

    int inputMaxLength() const;

    virtual void setInputMaxLength( int numberOfChars );

    bool shrinkable() const;

    virtual void setShrinkable( bool shrinkable = 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; }

    virtual void saveUserInput( YMacroRecorder *macroRecorder );

private:
    
    ImplPtr<YInputFieldPrivate> priv;
};


#endif // YInputField_h