#include <remoteview.h>

Inheritance diagram for RemoteView:

Public Types
enum	DotCursorState { CursorOn, CursorOff, CursorAuto }

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

enum	Quality { Unknown, High, Medium, Low }

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

Public Slots
virtual void	enableScaling (bool scale)

virtual void	keyEvent (QKeyEvent *event)

virtual void	scaleResize (int w, int h)

virtual void	setGrabAllKeys (bool grabAllKeys)

virtual void	setViewOnly (bool viewOnly)

virtual void	switchFullscreen (bool on)

Signals
void	connected ()

void	disconnected ()

void	disconnectedError ()

void	errorMessage (const QString &title, const QString &message)

void	framebufferSizeChanged (int w, int h)

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

void	showingPasswordDialog (bool b)

void	statusChanged (RemoteView::RemoteStatus s)

Public Member Functions
virtual	~RemoteView ()

virtual DotCursorState	dotCursorState () const

virtual QSize	framebufferSize ()

virtual bool	grabAllKeys ()

virtual QString	host ()

virtual HostPreferences *	hostPreferences ()=0

virtual bool	isQuitting ()

virtual int	port ()

virtual bool	scaling () const

virtual void	showDotCursor (DotCursorState state)

virtual bool	start ()=0

virtual void	startQuitting ()

RemoteStatus	status ()

virtual bool	supportsLocalCursor () const

virtual bool	supportsScaling () const

virtual QPixmap	takeScreenshot ()

virtual void	updateConfiguration ()

KUrl	url ()

virtual bool	viewOnly ()

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

virtual QSize	minimumSizeHint () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

virtual QSize	sizeHint () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Protected Member Functions
	RemoteView (QWidget *parent=0)

void	focusInEvent (QFocusEvent *event)

void	focusOutEvent (QFocusEvent *event)

QCursor	localDotCursor () const

QString	readWalletPassword (bool fromUserNameOnly=false)

void	saveWalletPassword (const QString &password, bool fromUserNameOnly=false)

virtual void	setStatus (RemoteStatus s)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual bool	event (QEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Protected Attributes
DotCursorState	m_dotCursorState

bool	m_grabAllKeys

QString	m_host

bool	m_keyboardIsGrabbed

int	m_port

bool	m_scale

RemoteStatus	m_status

KUrl	m_url

bool	m_viewOnly

KWallet::Wallet *	m_wallet

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Detailed Description

Generic widget that displays a remote framebuffer.

Implement this if you want to add another backend.

Things to take care of:

The RemoteView 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.
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.

Definition at line 59 of file remoteview.h.

Member Enumeration Documentation

enum RemoteView::DotCursorState

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.

Enumerator
CursorOn	Always show local cursor (and the remote one).
CursorOff	Never show local cursor, only the remote one.
CursorAuto	Try to measure the lag and enable the local cursor if the latency is too high.

Definition at line 84 of file remoteview.h.

enum RemoteView::ErrorCode

Enumerator
None
Internal
Connection
Protocol
IO
Name
NoServer
ServerBlocked
Authentication

Definition at line 119 of file remoteview.h.

enum RemoteView::Quality

Enumerator
Unknown
High
Medium
Low

Definition at line 67 of file remoteview.h.

enum RemoteView::RemoteStatus

State of the connection.

The state of the connection is returned by RemoteView::status().

Not every state transition is allowed. You are only allowed to transition a state to the following state, with three exceptions:

You can move from every state directly to Disconnected
You can move from every state except Disconnected to Disconnecting
You can move from Disconnected to Connecting

RemoteView::setStatus() will follow this rules for you. (If you add/remove a state here, you must adapt it)

Enumerator
Connecting
Authenticating
Preparing
Connected
Disconnecting
Disconnected

Definition at line 108 of file remoteview.h.

Constructor & Destructor Documentation

RemoteView::~RemoteView ( )

virtual

Definition at line 50 of file remoteview.cpp.

RemoteView::RemoteView ( QWidget * parent = 0 )

protected

Definition at line 34 of file remoteview.cpp.

Member Function Documentation

void RemoteView::connected ( )

signal

Emitted when the view connected successfully.

void RemoteView::disconnected ( )

signal

Emitted when the view disconnected without error.

void RemoteView::disconnectedError ( )

signal

Emitted when the view disconnected with error.

RemoteView::DotCursorState RemoteView::dotCursorState ( ) const

virtual

Returns the state of the local cursor.

The default implementation returns always CursorOff.

Returns: true if local cursors are supported/known

See also: showDotCursor(); supportsLocalCursor()

Definition at line 170 of file remoteview.cpp.

void RemoteView::enableScaling ( bool scale )

virtualslot

Called to enable or disable scaling.

Ignored if supportsScaling() is false. The default implementation does nothing.

Parameters

s	true to enable, false to disable.

See also: supportsScaling(); scaling()

Reimplemented in VncView.

Definition at line 180 of file remoteview.cpp.

void RemoteView::errorMessage	(	const QString &	title,
		const QString &	message
	)

signal

Emitted when the view has a specific error.

void RemoteView::focusInEvent ( QFocusEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 263 of file remoteview.cpp.

void RemoteView::focusOutEvent ( QFocusEvent * event )

protectedvirtual

Reimplemented from QWidget.

Definition at line 273 of file remoteview.cpp.

QSize RemoteView::framebufferSize ( )

virtual

Returns the resolution of the remote framebuffer.

It should return a null QSize when the size is not known. The backend must also emit a framebufferSizeChanged() when the size of the framebuffer becomes available for the first time or the size changed.

Returns: the remote framebuffer size, a null QSize if unknown

Reimplemented in RdpView, NxView, VncView, and KonsoleView.

Definition at line 106 of file remoteview.cpp.

void RemoteView::framebufferSizeChanged	(	int	w,
		int	h
	)

signal

Emitted when the size of the remote screen changes.

Also called when the size is known for the first time.

Parameters

x	the width of the screen
y	the height of the screen

bool RemoteView::grabAllKeys ( )

virtual

Checks whether grabbing all possible keys is enabled.

Definition at line 143 of file remoteview.cpp.

QString RemoteView::host ( )

virtual

Returns: the host the view is connected to

Definition at line 101 of file remoteview.cpp.

virtual HostPreferences* RemoteView::hostPreferences ( )

pure virtual

Returns the current host preferences of this view.

Implemented in RdpView, VncView, NxView, and KonsoleView.

bool RemoteView::isQuitting ( )

virtual

Checks whether the view is currently quitting.

Returns: true if it is quitting

See also: startQuitting(); setStatus()

Reimplemented in RdpView, VncView, KonsoleView, and NxView.

Definition at line 115 of file remoteview.cpp.

void RemoteView::keyEvent ( QKeyEvent * event )

virtualslot

Sends a QKeyEvent to the remote server.

Parameters

event the key to send

Definition at line 129 of file remoteview.cpp.

QCursor RemoteView::localDotCursor ( ) const

protected

Definition at line 250 of file remoteview.cpp.

void RemoteView::mouseStateChanged	(	int	x,
		int	y,
		int	buttonMask
	)

signal

Emitted when the mouse on the remote side has been moved.

Parameters

x	the new x coordinate
y	the new y coordinate
buttonMask	the mask of mouse buttons (bit 0 for first mouse button, 1 for second button etc)a

int RemoteView::port ( )

virtual

Returns: the port the view is connected to

Definition at line 120 of file remoteview.cpp.

QString RemoteView::readWalletPassword ( bool fromUserNameOnly = false )

protected

Definition at line 199 of file remoteview.cpp.

void RemoteView::saveWalletPassword	(	const QString &	password,
		bool	fromUserNameOnly = `false`
	)

protected

Definition at line 235 of file remoteview.cpp.

void RemoteView::scaleResize	(	int	w,
		int	h
	)

virtualslot

Called when the visible place changed so remote view can resize itself.

Definition at line 189 of file remoteview.cpp.

bool RemoteView::scaling ( ) const

virtual

Checks whether the widget is in scale mode.

The default implementation always returns false.

Returns: true if scaling is activated. Must always be false if supportsScaling() returns false

See also: supportsScaling()

Definition at line 175 of file remoteview.cpp.

void RemoteView::setGrabAllKeys ( bool grabAllKeys )

virtualslot

Enables/disables grabbing all possible keys.

Parameters

grabAllKeys true to enable, false to disable. Default is false.

See also: grabAllKeys()

Reimplemented in RdpView, and NxView.

Definition at line 148 of file remoteview.cpp.

void RemoteView::setStatus ( RemoteView::RemoteStatus s )

protectedvirtual

Set the status of the connection.

Emits a statusChanged() signal. Note that the states need to be set in a certain order, see Status. setStatus() will try to do this transition automatically, so if you are in Connecting and call setStatus(Preparing), setStatus() will emit a Authenticating and then Preparing. If you transition backwards, it will emit a Disconnected before doing the transition.

Parameters

s	the new status

Definition at line 62 of file remoteview.cpp.

void RemoteView::setViewOnly ( bool viewOnly )

virtualslot

Enables/disables the view-only mode.

Ignored if supportsScaling() is false. The default implementation does nothing.

Parameters

viewOnly true to enable, false to disable.

See also: supportsScaling(); viewOnly()

Reimplemented in VncView.

Definition at line 138 of file remoteview.cpp.

void RemoteView::showDotCursor ( DotCursorState state )

virtual

Sets the state of the dot cursor, if supported by the backend.

The default implementation does nothing.

Parameters

state the new state (CursorOn, CursorOff or CursorAuto)

See also: dotCursorState(); supportsLocalCursor()

Reimplemented in VncView.

Definition at line 165 of file remoteview.cpp.

void RemoteView::showingPasswordDialog ( bool b )

signal

Emitted when the password dialog is shown or hidden.

Parameters

b	true when the dialog is shown, false when it has been hidden

virtual bool RemoteView::start ( )

pure virtual

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 setStatus() with the status Connecting.

Returns: true if successful (so far), false otherwise

See also: connected(); disconnected(); disconnectedError(); statusChanged()

Implemented in RdpView, VncView, KonsoleView, and NxView.

void RemoteView::startQuitting ( )

virtual

Initiate the disconnection.

This doesn't need to happen immediately. The call must not block.

See also: isQuitting()

Reimplemented in RdpView, VncView, and NxView.

Definition at line 111 of file remoteview.cpp.

RemoteView::RemoteStatus RemoteView::status ( )

Returns the current status of the connection.

Returns: the status of the connection

See also: setStatus()

Definition at line 57 of file remoteview.cpp.

void RemoteView::statusChanged ( RemoteView::RemoteStatus s )

signal

Emitted when the status of the view changed.

Parameters

s	the new status

bool RemoteView::supportsLocalCursor ( ) const

virtual

Checks whether the backend supports the concept of local cursors.

The default implementation returns false.

Returns: true if local cursors are supported/known

See also: DotCursorState; showDotCursor(); dotCursorState()

Reimplemented in VncView.

Definition at line 96 of file remoteview.cpp.

bool RemoteView::supportsScaling ( ) const

virtual

Checks whether the backend supports scaling.

The default implementation returns false.

Returns: true if scaling is supported

See also: scaling()

Reimplemented in VncView.

Definition at line 91 of file remoteview.cpp.

void RemoteView::switchFullscreen ( bool on )

virtualslot

Called to let the backend know it when we switch from/to fullscreen.

Parameters

on	true when switching to fullscreen, false when switching from fullscreen.

Definition at line 185 of file remoteview.cpp.

QPixmap RemoteView::takeScreenshot ( )

virtual

Returns: screenshot of the view

Reimplemented in RdpView.

Definition at line 160 of file remoteview.cpp.

void RemoteView::updateConfiguration ( )

virtual

Called when the configuration is changed.

The default implementation does nothing.

Reimplemented in VncView.

Definition at line 125 of file remoteview.cpp.

KUrl RemoteView::url ( )

Returns: the current url

Definition at line 193 of file remoteview.cpp.

bool RemoteView::viewOnly ( )

virtual

Checks whether the view is in view-only mode.

This means that all input is ignored.

Definition at line 133 of file remoteview.cpp.

Member Data Documentation

DotCursorState RemoteView::m_dotCursorState

protected

Definition at line 412 of file remoteview.h.

bool RemoteView::m_grabAllKeys

protected

Definition at line 401 of file remoteview.h.

QString RemoteView::m_host

protected

Definition at line 398 of file remoteview.h.

bool RemoteView::m_keyboardIsGrabbed

protected

Definition at line 403 of file remoteview.h.

int RemoteView::m_port

protected

Definition at line 399 of file remoteview.h.

bool RemoteView::m_scale

protected

Definition at line 402 of file remoteview.h.

RemoteStatus RemoteView::m_status

protected

The status of the remote view.

Definition at line 380 of file remoteview.h.

KUrl RemoteView::m_url

protected

Definition at line 404 of file remoteview.h.

bool RemoteView::m_viewOnly

protected

Definition at line 400 of file remoteview.h.

KWallet::Wallet* RemoteView::m_wallet

protected

Definition at line 409 of file remoteview.h.

The documentation for this class was generated from the following files:

krdc

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

krdc

kdenetwork API Reference

Search