Source: klineeditdlg.h

# Source: klineeditdlg.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE libraries

       Copyright (C) 1999 Preston Brown

       This library is free software; you can redistribute it and/or
       modify it under the terms of the GNU Library General Public
       License as published by the Free Software Foundation; either
       version 2 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
       Library General Public License for more details.

       You should have received a copy of the GNU Library General Public License
       along with this library; see the file COPYING.LIB.  If not, write to
       the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */
    #ifndef __klineeditdlg_h__
    #define __klineeditdlg_h__

    class KLineEdit;
    class QValidator;

    #include

    /**
     * Dialog for user to enter a single line of text.
     *
     * @version $Id: klineeditdlg.h,v 1.13 2002/03/04 00:51:50 lunakl Exp $
     * @author David Faure , layout management by Preston Brown
     */

    class KLineEditDlg : public KDialogBase
    {
      Q_OBJECT
    public:
      /**
       * Create a dialog that asks for a single line of text. _value is
       * the initial value of the line. _text appears as label on top of
       * the entry box. If the internal line edit has an associated @ref
       * QValidator set, the OK button is disabled as long as the
       * validator doesn't return Acceptable. If there's no validator, the
       * OK button is enabled whenever the line edit isn't empty.
       *
       * If you want to accept empty input, make a trivial QValidator that
       * always returns Acceptable, e.g. @ref QRegExpValidator with a
       * regexp of ".*".
       *
       * @param _text      Text of the label
       * @param _value     Initial value of the inputline
       */
      KLineEditDlg( const QString& _text, const QString& _value, QWidget *parent );
      virtual ~KLineEditDlg();

      /**
       * @return the value the user entered
       */
      QString text() const;

      /**
       * @return the line edit widget
       */
      KLineEdit *lineEdit() const { return edit; }

      /**
       * Static convenience function to get a textual input from the user.
       *
       * @param _text      Text of the label
       * @param _value     Initial value of the inputline
       * @param ok         this bool will be set to true if user pressed "Ok"
       * @param _validator Validator to be stuffed into the line edit.
       */
      static QString getText(const QString &_text, const QString& _value,
    		 bool *ok, QWidget *parent, QValidator *validator=0 );

      /**
       * Static convenience function to get a textual input from the user.
       * This method includes a caption, and has (almost) the same API as QInputDialog::getText
       * (no echo mode, we have KPasswordDialog).
       *
       * @param _caption   Caption of the dialog
       * @param _text      Text of the label
       * @param _value     Initial value of the inputline
       * @param ok         this bool will be set to true if user pressed "Ok"
       * @param _validator Validator to be stuffed into the line edit.
       */
      static QString getText(const QString &_caption, const QString &_text,
                             const QString& _value=QString::null,
                             bool *ok=0, QWidget *parent=0,
    			 QValidator *validator=0);

    public slots:
      /**
       * Clears the edit widget
       */
      void slotClear();

    protected slots:
      /**
       * Enables and disables the OK button depending on the state
       * returned by the lineedit's @ref QValidator.
       */
      void slotTextChanged( const QString& );

    protected:
      /**
       * The line edit widget
       */
      KLineEdit *edit;
    protected:
      virtual void virtual_hook( int id, void* data );
    private:
      class KLineEditDlgPrivate;
      KLineEditDlgPrivate* d;
    };

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.