Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QVideoWindow Class Reference

#include <qvideowindow_p.h>

Inheritance diagram for QVideoWindow:
Collaboration diagram for QVideoWindow:

Public Slots

void setAspectRatioMode (Qt::AspectRatioMode mode)
Public Slots inherited from QWindow
 Q_REVISION (2, 1) void requestActivate()
void setVisible (bool visible)
void show ()
 Shows the window.
void hide ()
 Hides the window.
void showMinimized ()
 Shows the window as minimized.
void showMaximized ()
 Shows the window as maximized.
void showFullScreen ()
 Shows the window as fullscreen.
void showNormal ()
 Shows the window as normal, i.e.
bool close ()
 Close the window.
void raise ()
 Raise the window in the windowing system.
void lower ()
 Lower the window in the windowing system.
bool startSystemResize (Qt::Edges edges)
 Start a system-specific resize operation.
bool startSystemMove ()
 Start a system-specific move operation.
void setTitle (const QString &)
void setX (int arg)
void setY (int arg)
void setWidth (int arg)
void setHeight (int arg)
void setGeometry (int posx, int posy, int w, int h)
 Sets the geometry of the window, excluding its window frame, to a rectangle constructed from posx, posy, w and h.
void setGeometry (const QRect &rect)
 Sets the geometry of the window, excluding its window frame, to rect.
void setMinimumWidth (int w)
void setMinimumHeight (int h)
void setMaximumWidth (int w)
void setMaximumHeight (int h)
 Q_REVISION (2, 1) void alert(int msec)
 Q_REVISION (2, 3) void requestUpdate()
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void aspectRatioModeChanged (Qt::AspectRatioMode mode)
Signals inherited from QWindow
void screenChanged (QScreen *screen)
 This signal is emitted when a window's screen changes, either by being set explicitly with setScreen(), or automatically when the window's screen is removed.
void modalityChanged (Qt::WindowModality modality)
 This signal is emitted when the Qwindow::modality property changes to modality.
Q_REVISION(6, 10) void flagsChanged(Qt void windowStateChanged (Qt::WindowState windowState)
 This signal is emitted when the windowState changes, either by being set explicitly with setWindowStates(), or automatically when the user clicks one of the titlebar buttons or by other means.
 Q_REVISION (2, 2) void windowTitleChanged(const QString &title)
void xChanged (int arg)
void yChanged (int arg)
void widthChanged (int arg)
void heightChanged (int arg)
void minimumWidthChanged (int arg)
void minimumHeightChanged (int arg)
void maximumWidthChanged (int arg)
void maximumHeightChanged (int arg)
 Q_REVISION (6, 9) void safeAreaMarginsChanged(QMargins arg)
void visibleChanged (bool arg)
Q_REVISION(2, 1) void visibilityChanged(QWindow Q_REVISION (2, 1) void activeChanged()
void contentOrientationChanged (Qt::ScreenOrientation orientation)
void focusObjectChanged (QObject *object)
 This signal is emitted when the final receiver of events tied to focus is changed to object.
 Q_REVISION (2, 1) void opacityChanged(qreal opacity)
 Q_REVISION (2, 13) void transientParentChanged(QWindow *transientParent)
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.

Public Member Functions

 QVideoWindow (QScreen *screen=nullptr)
 QVideoWindow (QWindow *parent)
 ~QVideoWindow () override
Q_INVOKABLE QVideoSinkvideoSink () const
Qt::AspectRatioMode aspectRatioMode () 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< QStringbindableObjectName ()
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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.
Public Member Functions inherited from QSurface
virtual ~QSurface ()
 Destroys the surface.
SurfaceClass surfaceClass () const
 Returns the surface class of this surface.
virtual QPlatformSurfacesurfaceHandle () const =0
 Returns a handle to the platform-specific implementation of the surface.
bool supportsOpenGL () const
 Returns true if the surface is OpenGL compatible and can be used in conjunction with QOpenGLContext; otherwise returns false.

Protected Member Functions

bool event (QEvent *e) override
 Override this to handle any event (ev) sent to the window.
void resizeEvent (QResizeEvent *) override
 Override this to handle resize events (ev).
Protected Member Functions inherited from QWindow
virtual void exposeEvent (QExposeEvent *)
 The expose event (ev) is sent by the window system when a window moves between the un-exposed and exposed states.
virtual void paintEvent (QPaintEvent *)
 The paint event (ev) is sent by the window system whenever an area of the window needs a repaint, for example when initially showing the window, or due to parts of the window being uncovered by moving another window.
virtual void moveEvent (QMoveEvent *)
 Override this to handle window move events (ev).
virtual void focusInEvent (QFocusEvent *)
 Override this to handle focus in events (ev).
virtual void focusOutEvent (QFocusEvent *)
 Override this to handle focus out events (ev).
virtual void showEvent (QShowEvent *)
 Override this to handle show events (ev).
virtual void hideEvent (QHideEvent *)
 Override this to handle hide events (ev).
virtual void closeEvent (QCloseEvent *)
 Override this to handle close events (ev).
virtual void keyPressEvent (QKeyEvent *)
 Override this to handle key press events (ev).
virtual void keyReleaseEvent (QKeyEvent *)
 Override this to handle key release events (ev).
virtual void mousePressEvent (QMouseEvent *)
 Override this to handle mouse press events (ev).
virtual void mouseReleaseEvent (QMouseEvent *)
 Override this to handle mouse release events (ev).
virtual void mouseDoubleClickEvent (QMouseEvent *)
 Override this to handle mouse double click events (ev).
virtual void mouseMoveEvent (QMouseEvent *)
 Override this to handle mouse move events (ev).
virtual void touchEvent (QTouchEvent *)
 Override this to handle touch events (ev).
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 Override this to handle platform dependent events.
 QWindow (QWindowPrivate &dd, QWindow *parent)
 Creates a window as a child of the given parent window with the dd private implementation.
Protected Member Functions inherited from QObject
QObjectsender () 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)
Protected Member Functions inherited from QSurface
 QSurface (SurfaceClass type)
 Creates a surface with the given type.

Friends

class QVideoWindowPrivate

Additional Inherited Members

Public Types inherited from QSurface
enum  SurfaceClass { Window , Offscreen }
 The SurfaceClass enum describes the actual subclass of the surface. More...
enum  SurfaceType {
  RasterSurface , OpenGLSurface , OpenVGSurface , VulkanSurface ,
  MetalSurface , Direct3DSurface
}
 The SurfaceType enum describes what type of surface this is. More...
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< QObjectDatad_ptr
Protected Attributes inherited from QSurface
SurfaceClass m_type
QSurfacePrivate * m_reserved
Properties inherited from QWindow
QString title
 the window's title in the windowing system
Qt::WindowModality modality
 the modality of the window
Qt::WindowFlags flags
 the window flags of the window
int x
 the x position of the window's geometry
int y
 the y position of the window's geometry
int width
 the width of the window's geometry
int height
 the height of the window's geometry
int minimumWidth
 the minimum width of the window's geometry
int minimumHeight
 the minimum height of the window's geometry
int maximumWidth
 the maximum width of the window's geometry
int maximumHeight
 the maximum height of the window's geometry
bool visible
 whether the window is visible or not
bool active
 the active status of the window
Visibility visibility
 the screen-occupation state of the window
Qt::ScreenOrientation contentOrientation
 the orientation of the window's contents
qreal opacity
 The opacity of the window in the windowing system.
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 91 of file qvideowindow_p.h.

Constructor & Destructor Documentation

◆ QVideoWindow() [1/2]

QVideoWindow::QVideoWindow ( QScreen * screen = nullptr)
explicit

Definition at line 450 of file qvideowindow.cpp.

◆ QVideoWindow() [2/2]

QVideoWindow::QVideoWindow ( QWindow * parent)
explicit

Definition at line 456 of file qvideowindow.cpp.

◆ ~QVideoWindow()

QVideoWindow::~QVideoWindow ( )
overridedefault

Member Function Documentation

◆ aspectRatioMode()

Qt::AspectRatioMode QVideoWindow::aspectRatioMode ( ) const

Definition at line 469 of file qvideowindow.cpp.

◆ aspectRatioModeChanged

void QVideoWindow::aspectRatioModeChanged ( Qt::AspectRatioMode mode)
signal

◆ event()

bool QVideoWindow::event ( QEvent * ev)
overrideprotectedvirtual

Override this to handle any event (ev) sent to the window.

Return true if the event was recognized and processed.

Remember to call the base class version if you wish for mouse events, key events, resize events, etc to be dispatched as usual.

Reimplemented from QWindow.

Definition at line 482 of file qvideowindow.cpp.

◆ resizeEvent()

void QVideoWindow::resizeEvent ( QResizeEvent * ev)
overrideprotectedvirtual

Override this to handle resize events (ev).

The resize event is called whenever the window is resized in the windowing system, either directly through the windowing system acknowledging a setGeometry() or resize() request, or indirectly through the user resizing the window manually.

Reimplemented from QWindow.

Definition at line 509 of file qvideowindow.cpp.

◆ setAspectRatioMode

void QVideoWindow::setAspectRatioMode ( Qt::AspectRatioMode mode)
slot

Definition at line 474 of file qvideowindow.cpp.

◆ videoSink()

QVideoSink * QVideoWindow::videoSink ( ) const

Definition at line 464 of file qvideowindow.cpp.

◆ QVideoWindowPrivate

friend class QVideoWindowPrivate
friend

Definition at line 117 of file qvideowindow_p.h.


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