/kde/autobuild/kdebase/kdmlib/kgreeterplugin.h

/*

    Authentication method specific conversation plugin for KDE's greeter widgets

    Copyright (C) 2003 Oswald Buddenhagen <ossi@kde.org>
    Copyright (C) 2003 Fabian Kaiser <xfk@softpro.de>

    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., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KGREETERPLUGIN_H
#define KGREETERPLUGIN_H

#include <tqvariant.h>
#include <tqmessagebox.h>
#include <kdemacros.h>

class KdmThemer;

class TQWidget;
class TQLayoutItem;

class KGreeterPluginHandler {
public:
    /* keep in sync with V_IS_* */
    enum { IsSecret = 1, IsUser = 2, IsPassword = 4, IsOldPassword = 8,
           IsNewPassword = 16 };
    virtual void gplugReturnText( const char *text, int tag ) = 0;
    virtual void gplugReturnBinary( const char *data ) = 0;
    virtual void gplugSetUser( const TQString &user ) = 0;
    virtual void gplugStart() = 0;
    virtual void gplugActivity() = 0;
    virtual void gplugMsgBox( TQMessageBox::Icon type, const TQString &text ) = 0;
};

class KGreeterPlugin {
public:
    KGreeterPlugin( KGreeterPluginHandler *h ) : handler( h ) {}
    virtual ~KGreeterPlugin() {}

    enum Function { Authenticate, AuthChAuthTok, ChAuthTok };

    enum Context { Login, Shutdown, Unlock, ChangeTok,
                   ExUnlock, ExChangeTok };

    virtual void loadUsers( const TQStringList &users ) = 0;

    virtual void presetEntity( const TQString &entity, int field ) = 0;

    virtual TQString getEntity() const = 0;

    virtual void setUser( const TQString &user ) = 0;

    virtual void setEnabled( bool on ) = 0;

    virtual bool textMessage( const char *message, bool error ) = 0;

    virtual void textPrompt( const char *prompt, bool echo, bool nonBlocking ) = 0;

    virtual bool binaryPrompt( const char *prompt, bool nonBlocking ) = 0;

    virtual void start() = 0;

    virtual void suspend() = 0;

    virtual void resume() = 0;

    virtual void next() = 0;

    virtual void abort() = 0;

    virtual void succeeded() = 0;

    virtual void failed() = 0;

    virtual void revive() = 0;

    virtual void clear() = 0;

    TQLayoutItem *getLayoutItem() const { return layoutItem; }

protected:
    KGreeterPluginHandler *handler;
    TQLayoutItem *layoutItem;
};

struct KDE_EXPORT kgreeterplugin_info {
    const char *name;

    const char *method;

    enum {
        Local = 1,
        Fielded = 2,
        Presettable = 4
    };

    /*
     * Capability flags.
     */
    int flags;

    bool (*init)( const TQString &method,
                  TQVariant (*getConf)( void *ctx, const char *key,
                                       const TQVariant &dflt ),
                  void *ctx );

    void (*done)( void );

    KGreeterPlugin *(*create)( KGreeterPluginHandler *handler,
                               KdmThemer *themer,
                               TQWidget *parent, TQWidget *predecessor,
                               const TQString &fixedEntity,
                               KGreeterPlugin::Function func,
                               KGreeterPlugin::Context ctx );
};

#endif

---