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
QtGradientStopsWidgetPrivate Class Reference
+ Inheritance diagram for QtGradientStopsWidgetPrivate:
+ Collaboration diagram for QtGradientStopsWidgetPrivate:

Public Member Functions

void setGradientStopsModel (QtGradientStopsModel *model)
 
void slotStopAdded (QtGradientStop *stop)
 
void slotStopRemoved (QtGradientStop *stop)
 
void slotStopMoved (QtGradientStop *stop, qreal newPos)
 
void slotStopsSwapped (QtGradientStop *stop1, QtGradientStop *stop2)
 
void slotStopChanged (QtGradientStop *stop, QColor newColor)
 
void slotStopSelected (QtGradientStop *stop, bool selected)
 
void slotCurrentStopChanged (QtGradientStop *stop)
 
void slotNewStop ()
 
void slotDelete ()
 
void slotFlipAll ()
 
void slotSelectAll ()
 
void slotZoomIn ()
 
void slotZoomOut ()
 
void slotResetZoom ()
 
double fromViewport (int x) const
 
double toViewport (double x) const
 
QtGradientStopstopAt (QPoint viewportPos) const
 
QList< QtGradientStop * > stopsAt (QPoint viewportPos) const
 
void setupMove (QtGradientStop *stop, int x)
 
void ensureVisible (double x)
 
void ensureVisible (QtGradientStop *stop)
 
QtGradientStopnewStop (QPoint viewportPos)
 
void clearDrag ()
 
void removeClonedStop ()
 
void restoreChangedStop ()
 
void changeStop (qreal pos)
 
void cloneStop (qreal pos)
 
void setGradientStopsModel (QtGradientStopsModel *model)
 
void slotStopAdded (QtGradientStop *stop)
 
void slotStopRemoved (QtGradientStop *stop)
 
void slotStopMoved (QtGradientStop *stop, qreal newPos)
 
void slotStopsSwapped (QtGradientStop *stop1, QtGradientStop *stop2)
 
void slotStopChanged (QtGradientStop *stop, QColor newColor)
 
void slotStopSelected (QtGradientStop *stop, bool selected)
 
void slotCurrentStopChanged (QtGradientStop *stop)
 
void slotNewStop ()
 
void slotDelete ()
 
void slotFlipAll ()
 
void slotSelectAll ()
 
void slotZoomIn ()
 
void slotZoomOut ()
 
void slotResetZoom ()
 
double fromViewport (int x) const
 
double toViewport (double x) const
 
QtGradientStopstopAt (QPoint viewportPos) const
 
QList< QtGradientStop * > stopsAt (QPoint viewportPos) const
 
void setupMove (QtGradientStop *stop, int x)
 
void ensureVisible (double x)
 
void ensureVisible (QtGradientStop *stop)
 
QtGradientStopnewStop (QPoint viewportPos)
 
void clearDrag ()
 
void removeClonedStop ()
 
void restoreChangedStop ()
 
void changeStop (qreal pos)
 
void cloneStop (qreal pos)
 
- 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.
 
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 Attributes

bool m_backgroundCheckered
 
QtGradientStopsModelm_model
 
double m_handleSize
 
int m_scaleFactor
 
double m_zoom
 
QtGradientStopm_dragStop
 
QtGradientStopm_changedStop
 
QtGradientStopm_clonedStop
 
QtGradientStopsModelm_dragModel
 
QColor m_dragColor
 
QRubberBandm_rubber
 
QPoint m_clickPos
 
QList< QtGradientStop * > m_stops
 
bool m_moving
 
int m_moveOffset
 
QHash< QtGradientStop *, qrealm_moveStops
 
QMap< qreal, QColorm_moveOriginal
 

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 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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 19 of file qtgradientstopswidget.cpp.

Member Function Documentation

◆ changeStop() [1/2]

void QtGradientStopsWidgetPrivate::changeStop ( qreal pos)

Definition at line 1045 of file qtgradientstopswidget.cpp.

References m_changedStop, m_dragModel, m_dragStop, and m_model.

◆ changeStop() [2/2]

void QtGradientStopsWidgetPrivate::changeStop ( qreal pos)

◆ clearDrag() [1/2]

void QtGradientStopsWidgetPrivate::clearDrag ( )

Definition at line 1020 of file qtgradientstopswidget.cpp.

References m_dragModel, removeClonedStop(), and restoreChangedStop().

+ Here is the call graph for this function:

◆ clearDrag() [2/2]

void QtGradientStopsWidgetPrivate::clearDrag ( )

◆ cloneStop() [1/2]

void QtGradientStopsWidgetPrivate::cloneStop ( qreal pos)

Definition at line 1056 of file qtgradientstopswidget.cpp.

References m_clonedStop, and m_dragModel.

◆ cloneStop() [2/2]

void QtGradientStopsWidgetPrivate::cloneStop ( qreal pos)

◆ ensureVisible() [1/4]

void QtGradientStopsWidgetPrivate::ensureVisible ( double x)

Definition at line 210 of file qtgradientstopswidget.cpp.

References m_scaleFactor, and toViewport().

+ Here is the call graph for this function:

◆ ensureVisible() [2/4]

void QtGradientStopsWidgetPrivate::ensureVisible ( double x)

◆ ensureVisible() [3/4]

void QtGradientStopsWidgetPrivate::ensureVisible ( QtGradientStop * stop)

Definition at line 220 of file qtgradientstopswidget.cpp.

◆ ensureVisible() [4/4]

void QtGradientStopsWidgetPrivate::ensureVisible ( QtGradientStop * stop)

◆ fromViewport() [1/2]

double QtGradientStopsWidgetPrivate::fromViewport ( int x) const

Definition at line 136 of file qtgradientstopswidget.cpp.

References m_scaleFactor.

Referenced by newStop().

+ Here is the caller graph for this function:

◆ fromViewport() [2/2]

double QtGradientStopsWidgetPrivate::fromViewport ( int x) const

◆ newStop() [1/2]

QtGradientStop * QtGradientStopsWidgetPrivate::newStop ( QPoint viewportPos)

Definition at line 227 of file qtgradientstopswidget.cpp.

References QtGradientStop::color(), fromViewport(), and m_model.

+ Here is the call graph for this function:

◆ newStop() [2/2]

QtGradientStop * QtGradientStopsWidgetPrivate::newStop ( QPoint viewportPos)

◆ removeClonedStop() [1/2]

void QtGradientStopsWidgetPrivate::removeClonedStop ( )

Definition at line 1028 of file qtgradientstopswidget.cpp.

References m_clonedStop, m_dragModel, and QtGradientStopsModel::removeStop().

Referenced by clearDrag().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeClonedStop() [2/2]

void QtGradientStopsWidgetPrivate::removeClonedStop ( )

◆ restoreChangedStop() [1/2]

void QtGradientStopsWidgetPrivate::restoreChangedStop ( )

Definition at line 1036 of file qtgradientstopswidget.cpp.

References QtGradientStopsModel::changeStop(), m_changedStop, m_dragModel, m_dragStop, and m_model.

Referenced by clearDrag().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ restoreChangedStop() [2/2]

void QtGradientStopsWidgetPrivate::restoreChangedStop ( )

◆ setGradientStopsModel() [1/2]

void QtGradientStopsWidgetPrivate::setGradientStopsModel ( QtGradientStopsModel * model)

◆ setGradientStopsModel() [2/2]

void QtGradientStopsWidgetPrivate::setGradientStopsModel ( QtGradientStopsModel * model)

◆ setupMove() [1/2]

void QtGradientStopsWidgetPrivate::setupMove ( QtGradientStop * stop,
int x )

Definition at line 185 of file qtgradientstopswidget.cpp.

References m_model, m_moveOffset, QtGradientStopsModel::setCurrentStop(), and toViewport().

+ Here is the call graph for this function:

◆ setupMove() [2/2]

void QtGradientStopsWidgetPrivate::setupMove ( QtGradientStop * stop,
int x )

◆ slotCurrentStopChanged() [1/2]

void QtGradientStopsWidgetPrivate::slotCurrentStopChanged ( QtGradientStop * stop)

Definition at line 285 of file qtgradientstopswidget.cpp.

References m_model.

Referenced by setGradientStopsModel().

+ Here is the caller graph for this function:

◆ slotCurrentStopChanged() [2/2]

void QtGradientStopsWidgetPrivate::slotCurrentStopChanged ( QtGradientStop * stop)

◆ slotDelete() [1/2]

void QtGradientStopsWidgetPrivate::slotDelete ( )

Definition at line 313 of file qtgradientstopswidget.cpp.

References QtGradientStopsModel::deleteStops(), and m_model.

+ Here is the call graph for this function:

◆ slotDelete() [2/2]

void QtGradientStopsWidgetPrivate::slotDelete ( )

◆ slotFlipAll() [1/2]

void QtGradientStopsWidgetPrivate::slotFlipAll ( )

Definition at line 321 of file qtgradientstopswidget.cpp.

References QtGradientStopsModel::flipAll(), and m_model.

+ Here is the call graph for this function:

◆ slotFlipAll() [2/2]

void QtGradientStopsWidgetPrivate::slotFlipAll ( )

◆ slotNewStop() [1/2]

void QtGradientStopsWidgetPrivate::slotNewStop ( )

Definition at line 298 of file qtgradientstopswidget.cpp.

References QtGradientStopsModel::clearSelection(), m_model, QtGradientStopsModel::selectStop(), and QtGradientStopsModel::setCurrentStop().

+ Here is the call graph for this function:

◆ slotNewStop() [2/2]

void QtGradientStopsWidgetPrivate::slotNewStop ( )

◆ slotResetZoom() [1/2]

void QtGradientStopsWidgetPrivate::slotResetZoom ( )

Definition at line 361 of file qtgradientstopswidget.cpp.

◆ slotResetZoom() [2/2]

void QtGradientStopsWidgetPrivate::slotResetZoom ( )

◆ slotSelectAll() [1/2]

void QtGradientStopsWidgetPrivate::slotSelectAll ( )

Definition at line 329 of file qtgradientstopswidget.cpp.

References m_model, and QtGradientStopsModel::selectAll().

+ Here is the call graph for this function:

◆ slotSelectAll() [2/2]

void QtGradientStopsWidgetPrivate::slotSelectAll ( )

◆ slotStopAdded() [1/2]

void QtGradientStopsWidgetPrivate::slotStopAdded ( QtGradientStop * stop)

Definition at line 245 of file qtgradientstopswidget.cpp.

Referenced by setGradientStopsModel().

+ Here is the caller graph for this function:

◆ slotStopAdded() [2/2]

void QtGradientStopsWidgetPrivate::slotStopAdded ( QtGradientStop * stop)

◆ slotStopChanged() [1/2]

void QtGradientStopsWidgetPrivate::slotStopChanged ( QtGradientStop * stop,
QColor newColor )

Definition at line 271 of file qtgradientstopswidget.cpp.

Referenced by setGradientStopsModel().

+ Here is the caller graph for this function:

◆ slotStopChanged() [2/2]

void QtGradientStopsWidgetPrivate::slotStopChanged ( QtGradientStop * stop,
QColor newColor )

◆ slotStopMoved() [1/2]

void QtGradientStopsWidgetPrivate::slotStopMoved ( QtGradientStop * stop,
qreal newPos )

Definition at line 257 of file qtgradientstopswidget.cpp.

◆ slotStopMoved() [2/2]

void QtGradientStopsWidgetPrivate::slotStopMoved ( QtGradientStop * stop,
qreal newPos )

◆ slotStopRemoved() [1/2]

void QtGradientStopsWidgetPrivate::slotStopRemoved ( QtGradientStop * stop)

Definition at line 251 of file qtgradientstopswidget.cpp.

Referenced by setGradientStopsModel().

+ Here is the caller graph for this function:

◆ slotStopRemoved() [2/2]

void QtGradientStopsWidgetPrivate::slotStopRemoved ( QtGradientStop * stop)

◆ slotStopSelected() [1/2]

void QtGradientStopsWidgetPrivate::slotStopSelected ( QtGradientStop * stop,
bool selected )

Definition at line 278 of file qtgradientstopswidget.cpp.

Referenced by setGradientStopsModel().

+ Here is the caller graph for this function:

◆ slotStopSelected() [2/2]

void QtGradientStopsWidgetPrivate::slotStopSelected ( QtGradientStop * stop,
bool selected )

◆ slotStopsSwapped() [1/2]

void QtGradientStopsWidgetPrivate::slotStopsSwapped ( QtGradientStop * stop1,
QtGradientStop * stop2 )

Definition at line 264 of file qtgradientstopswidget.cpp.

Referenced by setGradientStopsModel().

+ Here is the caller graph for this function:

◆ slotStopsSwapped() [2/2]

void QtGradientStopsWidgetPrivate::slotStopsSwapped ( QtGradientStop * stop1,
QtGradientStop * stop2 )

◆ slotZoomIn() [1/2]

void QtGradientStopsWidgetPrivate::slotZoomIn ( )

Definition at line 337 of file qtgradientstopswidget.cpp.

◆ slotZoomIn() [2/2]

void QtGradientStopsWidgetPrivate::slotZoomIn ( )

◆ slotZoomOut() [1/2]

void QtGradientStopsWidgetPrivate::slotZoomOut ( )

Definition at line 349 of file qtgradientstopswidget.cpp.

◆ slotZoomOut() [2/2]

void QtGradientStopsWidgetPrivate::slotZoomOut ( )

◆ stopAt() [1/2]

QtGradientStop * QtGradientStopsWidgetPrivate::stopAt ( QPoint viewportPos) const

Definition at line 154 of file qtgradientstopswidget.cpp.

References m_handleSize.

◆ stopAt() [2/2]

QtGradientStop * QtGradientStopsWidgetPrivate::stopAt ( QPoint viewportPos) const

◆ stopsAt() [1/2]

QList< QtGradientStop * > QtGradientStopsWidgetPrivate::stopsAt ( QPoint viewportPos) const

Definition at line 169 of file qtgradientstopswidget.cpp.

References m_handleSize.

◆ stopsAt() [2/2]

QList< QtGradientStop * > QtGradientStopsWidgetPrivate::stopsAt ( QPoint viewportPos) const

◆ toViewport() [1/2]

double QtGradientStopsWidgetPrivate::toViewport ( double x) const

Definition at line 145 of file qtgradientstopswidget.cpp.

References m_scaleFactor.

Referenced by ensureVisible(), and setupMove().

+ Here is the caller graph for this function:

◆ toViewport() [2/2]

double QtGradientStopsWidgetPrivate::toViewport ( double x) const

Member Data Documentation

◆ m_backgroundCheckered

bool QtGradientStopsWidgetPrivate::m_backgroundCheckered

Definition at line 51 of file qtgradientstopswidget.cpp.

◆ m_changedStop

QtGradientStop * QtGradientStopsWidgetPrivate::m_changedStop

Definition at line 59 of file qtgradientstopswidget.cpp.

Referenced by changeStop(), and restoreChangedStop().

◆ m_clickPos

QPoint QtGradientStopsWidgetPrivate::m_clickPos

Definition at line 71 of file qtgradientstopswidget.cpp.

◆ m_clonedStop

QtGradientStop * QtGradientStopsWidgetPrivate::m_clonedStop

Definition at line 60 of file qtgradientstopswidget.cpp.

Referenced by cloneStop(), and removeClonedStop().

◆ m_dragColor

QColor QtGradientStopsWidgetPrivate::m_dragColor

Definition at line 62 of file qtgradientstopswidget.cpp.

◆ m_dragModel

QtGradientStopsModel * QtGradientStopsWidgetPrivate::m_dragModel

◆ m_dragStop

QtGradientStop * QtGradientStopsWidgetPrivate::m_dragStop

Definition at line 58 of file qtgradientstopswidget.cpp.

Referenced by changeStop(), and restoreChangedStop().

◆ m_handleSize

double QtGradientStopsWidgetPrivate::m_handleSize

Definition at line 53 of file qtgradientstopswidget.cpp.

Referenced by stopAt(), and stopsAt().

◆ m_model

◆ m_moveOffset

int QtGradientStopsWidgetPrivate::m_moveOffset

Definition at line 76 of file qtgradientstopswidget.cpp.

Referenced by setupMove().

◆ m_moveOriginal

QMap< qreal, QColor > QtGradientStopsWidgetPrivate::m_moveOriginal

Definition at line 79 of file qtgradientstopswidget.cpp.

◆ m_moveStops

QHash< QtGradientStop *, qreal > QtGradientStopsWidgetPrivate::m_moveStops

Definition at line 77 of file qtgradientstopswidget.cpp.

◆ m_moving

bool QtGradientStopsWidgetPrivate::m_moving

Definition at line 75 of file qtgradientstopswidget.cpp.

◆ m_rubber

QRubberBand * QtGradientStopsWidgetPrivate::m_rubber

Definition at line 70 of file qtgradientstopswidget.cpp.

◆ m_scaleFactor

int QtGradientStopsWidgetPrivate::m_scaleFactor

Definition at line 54 of file qtgradientstopswidget.cpp.

Referenced by ensureVisible(), fromViewport(), and toViewport().

◆ m_stops

QList< QtGradientStop * > QtGradientStopsWidgetPrivate::m_stops

Definition at line 73 of file qtgradientstopswidget.cpp.

◆ m_zoom

double QtGradientStopsWidgetPrivate::m_zoom

Definition at line 55 of file qtgradientstopswidget.cpp.


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