#include <qvncclient.h>

Inheritance diagram for QVncClient:

Collaboration diagram for QVncClient:

Public Types
enum	ClientMsg { SetPixelFormat = 0 , FixColourMapEntries = 1 , SetEncodings = 2 , FramebufferUpdateRequest = 3 , KeyEvent = 4 , PointerEvent = 5 , ClientCutText = 6 }

Public Member Functions
	QVncClient (QTcpSocket clientSocket, QVncServer server)

	~QVncClient ()

QTcpSocket *	clientSocket () const

QVncServer *	server () const

void	setDirty (const QRegion &region)

void	setDirtyCursor ()

QRegion	dirtyRegion () const

bool	isConnected () const

int	clientBytesPerPixel () const

void	convertPixels (char dst, const char src, int count, int depth) const

bool	doPixelConversion () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

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

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
bool	event (QEvent *event) override
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

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

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 16 of file qvncclient.h.

Member Enumeration Documentation

◆ ClientMsg

enum QVncClient::ClientMsg

Enumerator
SetPixelFormat
FixColourMapEntries
SetEncodings
FramebufferUpdateRequest
KeyEvent
PointerEvent
ClientCutText

Definition at line 20 of file qvncclient.h.

Constructor & Destructor Documentation

◆ QVncClient()

QT_BEGIN_NAMESPACE QVncClient::QVncClient	(	QTcpSocket *	clientSocket,
		QVncServer *	server )

explicit

Definition at line 21 of file qvncclient.cpp.

◆ ~QVncClient()

QVncClient::~QVncClient ( )

Definition at line 45 of file qvncclient.cpp.

Member Function Documentation

◆ clientBytesPerPixel()

int QVncClient::clientBytesPerPixel ( ) const

inline

Definition at line 40 of file qvncclient.h.

References QRfbPixelFormat::bitsPerPixel.

Referenced by QRfbRawEncoder::write().

Here is the caller graph for this function:

◆ clientSocket()

QTcpSocket * QVncClient::clientSocket ( ) const

Definition at line 50 of file qvncclient.cpp.

Referenced by QRfbRawEncoder::write().

Here is the caller graph for this function:

◆ convertPixels()

void QVncClient::convertPixels	(	char *	dst,
		const char *	src,
		int	count,
		int	depth ) const

Definition at line 64 of file qvncclient.cpp.

References QRfbPixelFormat::bitsPerPixel, QRfbPixelFormat::blueBits, QRfbPixelFormat::blueShift, QRfbPixelFormat::greenBits, QRfbPixelFormat::greenShift, QRfbPixelFormat::redBits, and QRfbPixelFormat::redShift.

◆ dirtyRegion()

QRegion QVncClient::dirtyRegion ( ) const

inline

Definition at line 37 of file qvncclient.h.

◆ doPixelConversion()

bool QVncClient::doPixelConversion ( ) const

inline

Definition at line 45 of file qvncclient.h.

◆ event()

bool QVncClient::event ( QEvent * e )

overrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
    Q_OBJECT
 
public:
    MyClass(QWidget *parent = nullptr);
    ~MyClass();
 
    bool event(QEvent* ev) override
    {
        if (ev->type() == QEvent::PolishRequest) {
            // overwrite handling of PolishRequest if any
            doThings();
            return true;
        } else  if (ev->type() == QEvent::Show) {
            // complement handling of Show if any
            doThings2();
            QWidget::event(ev);
            return true;
        }
        // Make sure the rest of events are handled
        return QWidget::event(ev);
    }
};

See also: installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 413 of file qvncclient.cpp.

◆ isConnected()

bool QVncClient::isConnected ( ) const

inline

Definition at line 38 of file qvncclient.h.

◆ server()

QVncServer * QVncClient::server ( ) const

inline

Definition at line 33 of file qvncclient.h.

◆ setDirty()

void QVncClient::setDirty ( const QRegion & region )

Definition at line 55 of file qvncclient.cpp.

References QVncServer::dirtyMap(), and QVncDirtyMap::numDirty.

Here is the call graph for this function:

◆ setDirtyCursor()

void QVncClient::setDirtyCursor ( )

inline

Definition at line 36 of file qvncclient.h.

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

qtbase/src/plugins/platforms/vnc/qvncclient.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/plugins/platforms/vnc/qvncclient.cpp (05fc3aef53348fb58be6308076e000825b704e58)

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ClientMsg

Constructor & Destructor Documentation

◆ QVncClient()

◆ ~QVncClient()

Member Function Documentation

◆ clientBytesPerPixel()

◆ clientSocket()

◆ convertPixels()

◆ dirtyRegion()

◆ doPixelConversion()

◆ event()

◆ isConnected()

◆ server()

◆ setDirty()

◆ setDirtyCursor()