diff options
Diffstat (limited to 'krdc/kremoteview.h')
| -rw-r--r-- | krdc/kremoteview.h | 289 |
1 files changed, 289 insertions, 0 deletions
diff --git a/krdc/kremoteview.h b/krdc/kremoteview.h new file mode 100644 index 00000000..d07b82a1 --- /dev/null +++ b/krdc/kremoteview.h @@ -0,0 +1,289 @@ +/*************************************************************************** + kremoteview.h - widget that shows the remote framebuffer + ------------------- + begin : Wed Dec 25 23:58:12 CET 2002 + copyright : (C) 2002-2003 by Tim Jansen + email : [email protected] + ***************************************************************************/ + +/*************************************************************************** + * * + * 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. * + * * + ***************************************************************************/ + +#ifndef KREMOTEVIEW_H +#define KREMOTEVIEW_H + + +#include <qwidget.h> +#include <kkeynative.h> +#include "events.h" + +typedef enum { + QUALITY_UNKNOWN=0, + QUALITY_HIGH=1, + QUALITY_MEDIUM=2, + QUALITY_LOW=3 +} Quality; + +/** + * Describes the state of a local cursor, if there is such a concept in the backend. + * With local cursors, there are two cursors: the cursor on the local machine (client), + * and the cursor on the remote machine (server). Because there is usually some lag, + * some backends show both cursors simultanously. In the VNC backend the local cursor + * is a dot and the remote cursor is the 'real' cursor, usually an arrow. + */ +enum DotCursorState { + DOT_CURSOR_ON, ///< Always show local cursor (and the remote one). + DOT_CURSOR_OFF, ///< Never show local cursor, only the remote one. + /// Try to measure the lag and enable the local cursor if the latency is too high. + DOT_CURSOR_AUTO +}; + +/** + * Generic widget that displays a remote framebuffer. + * Implement this if you want to add another backend. + * + * Things to take care of: + * @li The KRemoteView is responsible for its size. In + * non-scaling mode, set the fixed size of the widget + * to the remote resolution. In scaling mode, set the + * maximum size to the remote size and minimum size to the + * smallest resolution that your scaler can handle. + * @li if you override mouseMoveEvent() + * you must ignore the QEvent, because the KRDC widget will + * need it for stuff like toolbar auto-hide and bump + * scrolling. If you use x11Event(), make sure that + * MotionNotify events will be forwarded. + * + */ +class KRemoteView : public QWidget +{ + Q_OBJECT +public: + KRemoteView(QWidget *parent = 0, + const char *name = 0, + WFlags f = 0); + + virtual ~KRemoteView(); + + /** + * Checks whether the backend supports scaling. The + * default implementation returns false. + * @return true if scaling is supported + * @see scaling() + */ + virtual bool supportsScaling() const; + + /** + * Checks whether the widget is in scale mode. The + * default implementation always returns false. + * @return true if scaling is activated. Must always be + * false if @ref supportsScaling() returns false + * @see supportsScaling() + */ + virtual bool scaling() const; + + /** + * Checks whether the backend supports the concept of local cursors. The + * default implementation returns false. + * @return true if local cursors are supported/known + * @see DotCursorState + * @see showDotCursor() + * @see dotCursorState() + */ + virtual bool supportsLocalCursor() const; + + /** + * Sets the state of the dot cursor, if supported by the backend. + * The default implementation does nothing. + * @param state the new state (DOT_CURSOR_ON, DOT_CURSOR_OFF or + * DOT_CURSOR_AUTO) + * @see dotCursorState() + * @see supportsLocalCursor() + */ + virtual void showDotCursor(DotCursorState state); + + /** + * Returns the state of the local cursor. The default implementation returns + * always DOT_CURSOR_OFF. + * @return true if local cursors are supported/known + * @see showDotCursor() + * @see supportsLocalCursor() + */ + virtual DotCursorState dotCursorState() const; + + /** + * Checks whether the view is in view-only mode. This means + * that all input is ignored. + */ + virtual bool viewOnly() = 0; + + /** + * Returns the resolution of the remote framebuffer. + * It should return a null @ref QSize when the size + * is not known. + * The backend must also emit a @ref changeSize() + * when the size of the framebuffer becomes available + * for the first time or the size changed. + * @return the remote framebuffer size, a null QSize + * if unknown + */ + virtual QSize framebufferSize() = 0; + + /** + * Initiate the disconnection. This doesn't need to happen + * immediately. The call must not block. + * @see isQuitting() + */ + virtual void startQuitting() = 0; + + /** + * Checks whether the view is currently quitting. + * @return true if it is quitting + * @see startQuitting() + * @see setStatus() + */ + virtual bool isQuitting() = 0; + + /** + * Returns the host the view is connected to. + * @return the host the view is connected to + */ + virtual QString host() = 0; + + /** + * Returns the port the view is connected to. + * @return the port the view is connected to + */ + virtual int port() = 0; + + /** + * Initialize the view (for example by showing configuration + * dialogs to the user) and start connecting. Should not block + * without running the event loop (so displaying a dialog is ok). + * When the view starts connecting the application must call + * @ref setStatus() with the status REMOTE_VIEW_CONNECTING. + * @return true if successful (so far), false + * otherwise + * @see connected() + * @see disconnected() + * @see disconnectedError() + * @see statusChanged() + */ + virtual bool start() = 0; + + /** + * Returns the current status of the connection. + * @return the status of the connection + * @see setStatus() + */ + enum RemoteViewStatus status(); + +public slots: + /** + * Called to enable or disable scaling. + * Ignored if @ref supportsScaling() is false. + * The default implementation does nothing. + * @param s true to enable, false to disable. + * @see supportsScaling() + * @see scaling() + */ + virtual void enableScaling(bool s); + + /** + * Enables/disables the view-only mode. + * Ignored if @ref supportsScaling() is false. + * The default implementation does nothing. + * @param s true to enable, false to disable. + * @see supportsScaling() + * @see viewOnly() + */ + virtual void setViewOnly(bool s) = 0; + + /** + * Called to let the backend know it when + * we switch from/to fullscreen. + * @param on true when switching to fullscreen, + * false when switching from fullscreen. + */ + virtual void switchFullscreen(bool on); + + /** + * Sends a key to the remote server. + * @param k the key to send + */ + virtual void pressKey(XEvent *k) = 0; + +signals: + /** + * Emitted when the size of the remote screen changes. Also + * called when the size is known for the first time. + * @param x the width of the screen + * @param y the height of the screen + */ + void changeSize(int w, int h); + + /** + * Emitted when the view connected successfully. + */ + void connected(); + + /** + * Emitted when the view disconnected without error. + */ + void disconnected(); + + /** + * Emitted when the view disconnected with error. + */ + void disconnectedError(); + + /** + * Emitted when the status of the view changed. + * @param s the new status + */ + void statusChanged(RemoteViewStatus s); + + /** + * Emitted when the password dialog is shown or hidden. + * @param b true when the dialog is shown, false when it has + * been hidden + */ + void showingPasswordDialog(bool b); + + /** + * Emitted when the mouse on the remote side has been moved. + * @param x the new x coordinate + * @param y the new y coordinate + * @param buttonMask the mask of mouse buttons (bit 0 for first mouse + * button, 1 for second button etc)a + */ + void mouseStateChanged(int x, int y, int buttonMask); + +protected: + /** + * The status of the remote view. + */ + enum RemoteViewStatus m_status; + + /** + * Set the status of the connection. + * Emits a statusChanged() signal. + * Note that the states need to be set in a certain order, + * see @ref RemoteViewStatus. setStatus() will try to do this + * transition automatically, so if you are in REMOTE_VIEW_CONNECTING + * and call setStatus(REMOTE_VIEW_PREPARING), setStatus() will + * emit a REMOTE_VIEW_AUTHENTICATING and then REMOTE_VIEW_PREPARING. + * If you transition backwards, it will emit a + * REMOTE_VIEW_DISCONNECTED before doing the transition. + * @param s the new status + */ + virtual void setStatus(RemoteViewStatus s); +}; + +#endif |