remoteview.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2002-2003 Tim Jansen <tim@tjansen.de>
** Copyright (C) 2007-2008 Urs Wolfer <uwolfer @ kde.org>
**
** This file is part of KDE.
**
** 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; see the file COPYING. If not, write to
** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
** Boston, MA 02110-1301, USA.
**
****************************************************************************/

#ifndef REMOTEVIEW_H
#define REMOTEVIEW_H

#ifdef QTONLY
    #include <QUrl>
    #define KUrl QUrl
    #define KRDCCORE_EXPORT
#else
    #include <KDE/KUrl>
    #include <KDE/KWallet/Wallet>
    #include <krdc_export.h>
#endif

#include <QWidget>

class HostPreferences;

class KRDCCORE_EXPORT RemoteView : public QWidget
{
    Q_OBJECT

public:

    Q_ENUMS(Quality)

    enum Quality {
        Unknown,
        High,
        Medium,
        Low
    };

    Q_ENUMS(DotCursorState)

    enum DotCursorState {
        CursorOn,  
        CursorOff, 
        CursorAuto
    };

    Q_ENUMS(RemoteStatus)

    enum RemoteStatus {
        Connecting     = 0,
        Authenticating = 1,
        Preparing      = 2,
        Connected      = 3,
        Disconnecting  = -1,
        Disconnected   = -2
    };

    Q_ENUMS(ErrorCode)

    enum ErrorCode {
        None = 0,
        Internal,
        Connection,
        Protocol,
        IO,
        Name,
        NoServer,
        ServerBlocked,
        Authentication
    };

    virtual ~RemoteView();

    virtual bool supportsScaling() const;

    virtual bool scaling() const;

    virtual bool supportsLocalCursor() const;

    virtual void showDotCursor(DotCursorState state);

    virtual DotCursorState dotCursorState() const;

    virtual bool viewOnly();

    virtual bool grabAllKeys();

    virtual QSize framebufferSize();

    virtual void startQuitting();

    virtual bool isQuitting();

    virtual QString host();

    virtual int port();

    virtual bool start() = 0;
    
    virtual void updateConfiguration();
    
    virtual QPixmap takeScreenshot();
    
#ifndef QTONLY

    virtual HostPreferences* hostPreferences() = 0;
#endif
    
    RemoteStatus status();

    KUrl url();

public slots:
    virtual void enableScaling(bool scale);

    virtual void setViewOnly(bool viewOnly);

    virtual void setGrabAllKeys(bool grabAllKeys);

    virtual void switchFullscreen(bool on);

    virtual void keyEvent(QKeyEvent *event);

    virtual void scaleResize(int w, int h);

Q_SIGNALS:
    void framebufferSizeChanged(int w, int h);

    void connected();

    void disconnected();

    void disconnectedError();

    void errorMessage(const QString &title, const QString &message);
 
    void statusChanged(RemoteView::RemoteStatus s);

    void showingPasswordDialog(bool b);

    void mouseStateChanged(int x, int y, int buttonMask);

protected:
    RemoteView(QWidget *parent = 0);

    void focusInEvent(QFocusEvent *event);
    void focusOutEvent(QFocusEvent *event);

    RemoteStatus m_status;

    virtual void setStatus(RemoteStatus s);

    QCursor localDotCursor() const;

    QString m_host;
    int m_port;
    bool m_viewOnly;
    bool m_grabAllKeys;
    bool m_scale;
    bool m_keyboardIsGrabbed;
    KUrl m_url;

#ifndef QTONLY
    QString readWalletPassword(bool fromUserNameOnly = false);
    void saveWalletPassword(const QString &password, bool fromUserNameOnly = false);
    KWallet::Wallet *m_wallet;
#endif

    DotCursorState m_dotCursorState;
};

#endif