Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QCocoaIntegration Class Reference

#include <qcocoaintegration.h>

+ Inheritance diagram for QCocoaIntegration:
+ Collaboration diagram for QCocoaIntegration:

Public Types

enum  Option { UseFreeTypeFontEngine = 0x1 }
 
- Public Types inherited from QPlatformIntegration
enum  Capability {
  ThreadedPixmaps = 1 , OpenGL , ThreadedOpenGL , SharedGraphicsCache ,
  BufferQueueingOpenGL , WindowMasks , MultipleWindows , ApplicationState ,
  ForeignWindows , NonFullScreenWindows , NativeWidgets , WindowManagement ,
  WindowActivation , SyncState , RasterGLSurface , AllGLFunctionsQueryable ,
  ApplicationIcon , SwitchableWidgetComposition , TopStackedNativeChildWindows , OpenGLOnRasterSurface ,
  MaximizeUsingFullscreenGeometry , PaintEvents , RhiBasedRendering , ScreenWindowGrabbing
}
 Capabilities are used to determine specific features of a platform integration. More...
 
enum  StyleHint {
  CursorFlashTime , KeyboardInputInterval , MouseDoubleClickInterval , StartDragDistance ,
  StartDragTime , KeyboardAutoRepeatRate , ShowIsFullScreen , PasswordMaskDelay ,
  FontSmoothingGamma , StartDragVelocity , UseRtlExtensions , PasswordMaskCharacter ,
  SetFocusOnTouchRelease , ShowIsMaximized , MousePressAndHoldInterval , TabFocusBehavior ,
  ReplayMousePressOutsidePopup , ItemViewActivateItemOnSingleClick , UiEffects , WheelScrollLines ,
  ShowShortcutsInContextMenus , MouseQuickSelectionThreshold , MouseDoubleClickDistance , FlickStartDistance ,
  FlickMaximumVelocity , FlickDeceleration , UnderlineShortcut
}
 

Public Member Functions

 QCocoaIntegration (const QStringList &paramList)
 
 ~QCocoaIntegration ()
 
Options options () const
 
bool hasCapability (QPlatformIntegration::Capability cap) const override
 
QPlatformWindowcreatePlatformWindow (QWindow *window) const override
 Factory function for QPlatformWindow.
 
QPlatformWindowcreateForeignWindow (QWindow *window, WId nativeHandle) const override
 
QPlatformOffscreenSurfacecreatePlatformOffscreenSurface (QOffscreenSurface *surface) const override
 Factory function for QOffscreenSurface.
 
QPlatformOpenGLContextcreatePlatformOpenGLContext (QOpenGLContext *context) const override
 Factory function for QPlatformOpenGLContext.
 
QOpenGLContextcreateOpenGLContext (NSOpenGLContext *, QOpenGLContext *shareContext) const override
 
QPlatformBackingStorecreatePlatformBackingStore (QWindow *widget) const override
 Factory function for QPlatformBackingStore.
 
QAbstractEventDispatchercreateEventDispatcher () const override
 Factory function for the GUI event dispatcher.
 
QCoreTextFontDatabasefontDatabase () const override
 Accessor for the platform integration's fontdatabase.
 
QCocoaNativeInterfacenativeInterface () const override
 
QPlatformInputContextinputContext () const override
 Returns the platforms input context.
 
QCocoaClipboardclipboard () const override
 Accessor for the platform integration's clipboard.
 
QCocoaDragdrag () const override
 
QStringList themeNames () const override
 
QPlatformThemecreatePlatformTheme (const QString &name) const override
 
QCocoaServicesservices () const override
 
QVariant styleHint (StyleHint hint) const override
 
Qt::KeyboardModifiers queryKeyboardModifiers () const override
 
QList< int > possibleKeys (const QKeyEvent *event) const override
 Should be used to obtain a list of possible shortcuts for the given key event.
 
void setApplicationIcon (const QIcon &icon) const override
 
void setApplicationBadge (qint64 number) override
 
void beep () const override
 
void quit () const override
 
- 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 event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
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 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.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
findChild (const QString &aName=QString(), 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 (const QString &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 >
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 QPlatformIntegration
virtual ~QPlatformIntegration ()
 
virtual bool hasCapability (Capability cap) const
 
virtual QPlatformPixmapcreatePlatformPixmap (QPlatformPixmap::PixelType type) const
 Factory function for QPlatformPixmap.
 
virtual QPlatformWindowcreatePlatformWindow (QWindow *window) const =0
 Factory function for QPlatformWindow.
 
virtual QPlatformWindowcreateForeignWindow (QWindow *, WId) const
 
virtual QPlatformBackingStorecreatePlatformBackingStore (QWindow *window) const =0
 Factory function for QPlatformBackingStore.
 
virtual QPlatformOpenGLContextcreatePlatformOpenGLContext (QOpenGLContext *context) const
 Factory function for QPlatformOpenGLContext.
 
virtual QPlatformSharedGraphicsCachecreatePlatformSharedGraphicsCache (const char *cacheId) const
 Factory function for QPlatformSharedGraphicsCache.
 
virtual QPaintEnginecreateImagePaintEngine (QPaintDevice *paintDevice) const
 Factory function for QPaintEngine.
 
virtual QAbstractEventDispatchercreateEventDispatcher () const =0
 Factory function for the GUI event dispatcher.
 
virtual void initialize ()
 Performs initialization steps that depend on having an event dispatcher available.
 
virtual void destroy ()
 Called before the platform integration is deleted.
 
virtual QPlatformFontDatabasefontDatabase () const
 Accessor for the platform integration's fontdatabase.
 
virtual QPlatformClipboardclipboard () const
 Accessor for the platform integration's clipboard.
 
virtual QPlatformInputContextinputContext () const
 Returns the platforms input context.
 
virtual QPlatformNativeInterfacenativeInterface () const
 
virtual QPlatformServicesservices () const
 
virtual QVariant styleHint (StyleHint hint) const
 
virtual Qt::WindowState defaultWindowState (Qt::WindowFlags) const
 
virtual Qt::KeyboardModifiers queryKeyboardModifiers () const
 
virtual QList< int > possibleKeys (const QKeyEvent *) const
 Should be used to obtain a list of possible shortcuts for the given key event.
 
virtual QStringList themeNames () const
 
virtual QPlatformThemecreatePlatformTheme (const QString &name) const
 
virtual QPlatformOffscreenSurfacecreatePlatformOffscreenSurface (QOffscreenSurface *surface) const
 Factory function for QOffscreenSurface.
 
virtual QPlatformSessionManagercreatePlatformSessionManager (const QString &id, const QString &key) const
 
virtual void sync ()
 
virtual QOpenGLContext::OpenGLModuleType openGLModuleType ()
 Platform integration function for querying the OpenGL implementation type.
 
virtual void setApplicationIcon (const QIcon &icon) const
 
virtual void setApplicationBadge (qint64 number)
 
virtual void beep () const
 
virtual void quit () const
 
template<auto func, typename... Args>
auto call (Args... args)
 

Static Public Member Functions

static QCocoaIntegrationinstance ()
 
- 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)
 

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.
 
- 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 QPlatformIntegration
 QPlatformIntegration ()=default
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 32 of file qcocoaintegration.h.

Member Enumeration Documentation

◆ Option

Enumerator
UseFreeTypeFontEngine 

Definition at line 39 of file qcocoaintegration.h.

Constructor & Destructor Documentation

◆ QCocoaIntegration()

◆ ~QCocoaIntegration()

QCocoaIntegration::~QCocoaIntegration ( )

Definition at line 182 of file qcocoaintegration.mm.

References Qt::AA_PluginApplication, QMacMimeRegistry::destroyMimeTypes(), pool, qt_resetNSApplicationSendEvent(), and QCoreApplication::testAttribute().

+ Here is the call graph for this function:

Member Function Documentation

◆ beep()

void QCocoaIntegration::beep ( ) const
overridevirtual
Since
5.7

Should sound a bell, using the default volume and sound.

See also
QApplication::beep()

Reimplemented from QPlatformIntegration.

Definition at line 424 of file qcocoaintegration.mm.

◆ clipboard()

QCocoaClipboard * QCocoaIntegration::clipboard ( ) const
overridevirtual

Accessor for the platform integration's clipboard.

Default implementation returns a default QPlatformClipboard.

See also
QPlatformClipboard

Reimplemented from QPlatformIntegration.

Definition at line 359 of file qcocoaintegration.mm.

◆ createEventDispatcher()

QAbstractEventDispatcher * QCocoaIntegration::createEventDispatcher ( ) const
overridevirtual

Factory function for the GUI event dispatcher.

The platform plugin should create and return a QAbstractEventDispatcher subclass when this function is called.

If the platform plugin for some reason creates the event dispatcher outside of this function (for example in the constructor), it needs to handle the case where this function is never called, ensuring that the event dispatcher is still deleted at some point (typically in the destructor).

Note that the platform plugin should never explicitly set the event dispatcher itself, using QCoreApplication::setEventDispatcher(), but let QCoreApplication decide when and which event dispatcher to create.

Since
5.2

Implements QPlatformIntegration.

Definition at line 318 of file qcocoaintegration.mm.

◆ createForeignWindow()

QPlatformWindow * QCocoaIntegration::createForeignWindow ( QWindow window,
WId  nativeHandle 
) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 256 of file qcocoaintegration.mm.

References window().

+ Here is the call graph for this function:

◆ createOpenGLContext()

QOpenGLContext * QCocoaIntegration::createOpenGLContext ( NSOpenGLContext *  nativeContext,
QOpenGLContext shareContext 
) const
override

Definition at line 285 of file qcocoaintegration.mm.

References context, and QOpenGLContextPrivate::get().

+ Here is the call graph for this function:

◆ createPlatformBackingStore()

QPlatformBackingStore * QCocoaIntegration::createPlatformBackingStore ( QWindow window) const
overridevirtual

Factory function for QPlatformBackingStore.

The QWindow parameter is a pointer to the top level widget(tlw) the window surface is created for. A QPlatformWindow is always created before the QPlatformBackingStore for tlw where the widget also requires a backing store.

See also
QBackingStore
createPlatformWindow()

Implements QPlatformIntegration.

Definition at line 299 of file qcocoaintegration.mm.

References QSurface::MetalSurface, QSurface::OpenGLSurface, qWarning, QSurface::RasterSurface, and window().

+ Here is the call graph for this function:

◆ createPlatformOffscreenSurface()

QPlatformOffscreenSurface * QCocoaIntegration::createPlatformOffscreenSurface ( QOffscreenSurface surface) const
overridevirtual

Factory function for QOffscreenSurface.

An offscreen surface will typically be implemented with a pixel buffer (pbuffer). If the platform doesn't support offscreen surfaces, an invisible window will be used by QOffscreenSurface instead.

Reimplemented from QPlatformIntegration.

Definition at line 274 of file qcocoaintegration.mm.

◆ createPlatformOpenGLContext()

QPlatformOpenGLContext * QCocoaIntegration::createPlatformOpenGLContext ( QOpenGLContext context) const
overridevirtual

Factory function for QPlatformOpenGLContext.

The context parameter is a pointer to the context for which a platform-specific context backend needs to be created. Configuration settings like the format, share context and screen have to be taken from this QOpenGLContext and the resulting platform context is expected to be backed by a native context that fulfills these criteria.

If the context has native handles set, no new native context is expected to be created. Instead, the provided handles have to be used. In this case the ownership of the handle must not be taken and the platform implementation is not allowed to destroy the native context. Configuration parameters like the format are also to be ignored. Instead, the platform implementation is responsible for querying the configuriation from the provided native context.

Returns a pointer to a QPlatformOpenGLContext instance or \nullptr if the context could not be created.

See also
QOpenGLContext

Reimplemented from QPlatformIntegration.

Definition at line 280 of file qcocoaintegration.mm.

References context.

◆ createPlatformTheme()

QPlatformTheme * QCocoaIntegration::createPlatformTheme ( const QString name) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 375 of file qcocoaintegration.mm.

References QPlatformIntegration::createPlatformTheme(), and QCocoaTheme::name.

+ Here is the call graph for this function:

◆ createPlatformWindow()

QPlatformWindow * QCocoaIntegration::createPlatformWindow ( QWindow window) const
overridevirtual

Factory function for QPlatformWindow.

The window parameter is a pointer to the window which the QPlatformWindow is supposed to be created for.

All windows have to have a QPlatformWindow, and it will be created on-demand when the QWindow is made visible for the first time, or explicitly through calling QWindow::create().

In the constructor, of the QPlatformWindow, the window flags, state, title and geometry of the window should be applied to the underlying window. If the resulting flags or state differs, the resulting values should be set on the window using QWindow::setWindowFlags() or QWindow::setWindowState(), respectively.

See also
QPlatformWindow, QPlatformWindowFormat
createPlatformBackingStore()

Implements QPlatformIntegration.

Definition at line 251 of file qcocoaintegration.mm.

References window().

+ Here is the call graph for this function:

◆ drag()

QCocoaDrag * QCocoaIntegration::drag ( ) const
override

Definition at line 365 of file qcocoaintegration.mm.

References QScopedPointer< T, Cleanup >::data().

+ Here is the call graph for this function:

◆ fontDatabase()

QCoreTextFontDatabase * QCocoaIntegration::fontDatabase ( ) const
overridevirtual

Accessor for the platform integration's fontdatabase.

Default implementation returns a default QPlatformFontDatabase.

See also
QPlatformFontDatabase

Reimplemented from QPlatformIntegration.

Definition at line 336 of file qcocoaintegration.mm.

References QScopedPointer< T, Cleanup >::data().

+ Here is the call graph for this function:

◆ hasCapability()

◆ inputContext()

QPlatformInputContext * QCocoaIntegration::inputContext ( ) const
overridevirtual

Returns the platforms input context.

The default implementation returns \nullptr, implying no input method support.

Reimplemented from QPlatformIntegration.

Definition at line 346 of file qcocoaintegration.mm.

References QScopedPointer< T, Cleanup >::data().

+ Here is the call graph for this function:

◆ instance()

QCocoaIntegration * QCocoaIntegration::instance ( )
static

Definition at line 208 of file qcocoaintegration.mm.

Referenced by QCocoaWindow::~QCocoaWindow(), and QNSView(Mouse)::initMouse.

+ Here is the caller graph for this function:

◆ nativeInterface()

QCocoaNativeInterface * QCocoaIntegration::nativeInterface ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 341 of file qcocoaintegration.mm.

References QScopedPointer< T, Cleanup >::data().

+ Here is the call graph for this function:

◆ options()

QCocoaIntegration::Options QCocoaIntegration::options ( ) const

Definition at line 213 of file qcocoaintegration.mm.

◆ possibleKeys()

QList< int > QCocoaIntegration::possibleKeys ( const QKeyEvent ) const
overridevirtual

Should be used to obtain a list of possible shortcuts for the given key event.

Shortcuts should be encoded as int(Qt::Key + Qt::KeyboardModifiers).

One example for more than one possibility is the key combination of Shift+5. That one might trigger a shortcut which is set as "Shift+5" as well as one using %. These combinations depend on the currently set keyboard layout.

Note
This function should be called only from key event handlers.

Reimplemented from QPlatformIntegration.

Definition at line 407 of file qcocoaintegration.mm.

References QAppleKeyMapper::possibleKeys().

+ Here is the call graph for this function:

◆ queryKeyboardModifiers()

Qt::KeyboardModifiers QCocoaIntegration::queryKeyboardModifiers ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 402 of file qcocoaintegration.mm.

References QAppleKeyMapper::queryKeyboardModifiers().

+ Here is the call graph for this function:

◆ quit()

void QCocoaIntegration::quit ( ) const
overridevirtual
Since
6.0

Asks the platform to terminate the application.

Overrides should ensure there's a callback into the QWSI function handleApplicationTermination so that the quit can be propagated to QtGui and the application.

Reimplemented from QPlatformIntegration.

Definition at line 429 of file qcocoaintegration.mm.

References qCDebug.

◆ services()

QCocoaServices * QCocoaIntegration::services ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 382 of file qcocoaintegration.mm.

References QScopedPointer< T, Cleanup >::data().

+ Here is the call graph for this function:

◆ setApplicationBadge()

void QCocoaIntegration::setApplicationBadge ( qint64  number)
overridevirtual
Since
6.5

Should set the application's badge to number.

If the number is 0 the badge should be cleared.

See also
QGuiApplication::setBadge()

Reimplemented from QPlatformIntegration.

Definition at line 419 of file qcocoaintegration.mm.

References number.

◆ setApplicationIcon()

void QCocoaIntegration::setApplicationIcon ( const QIcon icon) const
overridevirtual
Since
5.5

Platform integration function for setting the application icon.

See also
QGuiApplication::setWindowIcon()

Reimplemented from QPlatformIntegration.

Definition at line 412 of file qcocoaintegration.mm.

References icon, and qGuiApp.

◆ styleHint()

QVariant QCocoaIntegration::styleHint ( StyleHint  hint) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 387 of file qcocoaintegration.mm.

References QPlatformIntegration::FontSmoothingGamma, QCoreTextFontEngine::fontSmoothingGamma(), hint(), QPlatformIntegration::ReplayMousePressOutsidePopup, QPlatformIntegration::ShowShortcutsInContextMenus, and QPlatformIntegration::styleHint().

+ Here is the call graph for this function:

◆ themeNames()

QStringList QCocoaIntegration::themeNames ( ) const
overridevirtual

Reimplemented from QPlatformIntegration.

Definition at line 370 of file qcocoaintegration.mm.

References QCocoaTheme::name.


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