Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QScrollBar widget provides a vertical or horizontal scroll bar. More...
#include <qscrollbar.h>
Public Member Functions | |
QScrollBar (QWidget *parent=nullptr) | |
Constructs a vertical scroll bar. | |
QScrollBar (Qt::Orientation, QWidget *parent=nullptr) | |
Constructs a scroll bar with the given orientation. | |
~QScrollBar () | |
Destroys the scroll bar. | |
QSize | sizeHint () const override |
\reimp | |
bool | event (QEvent *event) override |
\reimp | |
Public Member Functions inherited from QAbstractSlider | |
QAbstractSlider (QWidget *parent=nullptr) | |
Constructs an abstract slider. | |
~QAbstractSlider () | |
Destroys the slider. | |
Qt::Orientation | orientation () const |
void | setMinimum (int) |
int | minimum () const |
void | setMaximum (int) |
int | maximum () const |
void | setSingleStep (int) |
int | singleStep () const |
void | setPageStep (int) |
int | pageStep () const |
void | setTracking (bool enable) |
bool | hasTracking () const |
void | setSliderDown (bool) |
bool | isSliderDown () const |
void | setSliderPosition (int) |
int | sliderPosition () const |
void | setInvertedAppearance (bool) |
bool | invertedAppearance () const |
void | setInvertedControls (bool) |
bool | invertedControls () const |
int | value () const |
void | triggerAction (SliderAction action) |
Triggers a slider action. | |
Public Member Functions inherited from QWidget | |
QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags()) | |
Constructs a widget which is a child of parent, with widget flags set to f. | |
~QWidget () | |
Destroys the widget. | |
int | devType () const override |
WId | winId () const |
Returns the window system identifier of the widget. | |
void | createWinId () |
WId | internalWinId () const |
WId | effectiveWinId () const |
QStyle * | style () const |
void | setStyle (QStyle *) |
Sets the widget's GUI style to style. | |
bool | isWindow () const |
Returns true if the widget is an independent window, otherwise returns false . | |
bool | isModal () const |
Qt::WindowModality | windowModality () const |
void | setWindowModality (Qt::WindowModality windowModality) |
bool | isEnabled () const |
bool | isEnabledTo (const QWidget *) const |
Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false . | |
QRect | frameGeometry () const |
const QRect & | geometry () const |
QRect | normalGeometry () const |
int | x () const |
int | y () const |
QPoint | pos () const |
QSize | frameSize () const |
QSize | size () const |
int | width () const |
int | height () const |
QRect | rect () const |
QRect | childrenRect () const |
QRegion | childrenRegion () const |
QSize | minimumSize () const |
QSize | maximumSize () const |
int | minimumWidth () const |
int | minimumHeight () const |
int | maximumWidth () const |
int | maximumHeight () const |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)). | |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)). | |
void | setMinimumWidth (int minw) |
void | setMinimumHeight (int minh) |
void | setMaximumWidth (int maxw) |
void | setMaximumHeight (int maxh) |
QSize | sizeIncrement () const |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h. | |
QSize | baseSize () const |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)). | |
void | setFixedSize (const QSize &) |
Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking. | |
void | setFixedSize (int w, int h) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h. | |
void | setFixedWidth (int w) |
Sets both the minimum and maximum width of the widget to w without changing the heights. | |
void | setFixedHeight (int h) |
Sets both the minimum and maximum heights of the widget to h without changing the widths. | |
QPointF | mapToGlobal (const QPointF &) const |
Translates the widget coordinate pos to global screen coordinates. | |
QPoint | mapToGlobal (const QPoint &) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QPointF | mapFromGlobal (const QPointF &) const |
Translates the global screen coordinate pos to widget coordinates. | |
QPoint | mapFromGlobal (const QPoint &) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QPointF | mapToParent (const QPointF &) const |
Translates the widget coordinate pos to a coordinate in the parent widget. | |
QPoint | mapToParent (const QPoint &) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QPointF | mapFromParent (const QPointF &) const |
Translates the parent widget coordinate pos to widget coordinates. | |
QPoint | mapFromParent (const QPoint &) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QPointF | mapTo (const QWidget *, const QPointF &) const |
Translates the widget coordinate pos to the coordinate system of parent. | |
QPoint | mapTo (const QWidget *, const QPoint &) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QPointF | mapFrom (const QWidget *, const QPointF &) const |
Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. | |
QPoint | mapFrom (const QWidget *, const QPoint &) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QWidget * | window () const |
Returns the window for this widget, i.e. | |
QWidget * | nativeParentWidget () const |
QWidget * | topLevelWidget () const |
const QPalette & | palette () const |
void | setPalette (const QPalette &) |
void | setBackgroundRole (QPalette::ColorRole) |
Sets the background role of the widget to role. | |
QPalette::ColorRole | backgroundRole () const |
Returns the background role of the widget. | |
void | setForegroundRole (QPalette::ColorRole) |
Sets the foreground role of the widget to role. | |
QPalette::ColorRole | foregroundRole () const |
Returns the foreground role. | |
const QFont & | font () const |
void | setFont (const QFont &) |
QFontMetrics | fontMetrics () const |
Returns the font metrics for the widget's current font. | |
QFontInfo | fontInfo () const |
Returns the font info for the widget's current font. | |
QCursor | cursor () const |
void | setCursor (const QCursor &) |
void | unsetCursor () |
void | setMouseTracking (bool enable) |
bool | hasMouseTracking () const |
bool | underMouse () const |
Returns true if the widget is under the mouse cursor; otherwise returns false . | |
void | setTabletTracking (bool enable) |
bool | hasTabletTracking () const |
void | setMask (const QBitmap &) |
Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. | |
void | setMask (const QRegion &) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible. | |
QRegion | mask () const |
Returns the mask currently set on a widget. | |
void | clearMask () |
Removes any mask set by setMask(). | |
void | render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren)) |
void | render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren)) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device(). | |
Q_INVOKABLE QPixmap | grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1))) |
void | grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags()) |
Subscribes the widget to a given gesture with specific flags. | |
void | ungrabGesture (Qt::GestureType type) |
Unsubscribes the widget from a given gesture type. | |
QString | styleSheet () const |
QString | windowTitle () const |
void | setWindowIcon (const QIcon &icon) |
QIcon | windowIcon () const |
void | setWindowIconText (const QString &) |
QString | windowIconText () const |
void | setWindowRole (const QString &) |
Sets the window's role to role. | |
QString | windowRole () const |
Returns the window's role, or an empty string. | |
void | setWindowFilePath (const QString &filePath) |
QString | windowFilePath () const |
void | setWindowOpacity (qreal level) |
qreal | windowOpacity () const |
bool | isWindowModified () const |
void | setLayoutDirection (Qt::LayoutDirection direction) |
Qt::LayoutDirection | layoutDirection () const |
void | unsetLayoutDirection () |
void | setLocale (const QLocale &locale) |
QLocale | locale () const |
void | unsetLocale () |
bool | isRightToLeft () const |
bool | isLeftToRight () const |
bool | isActiveWindow () const |
void | activateWindow () |
Sets the top-level widget containing this widget to be the active window. | |
void | clearFocus () |
Takes keyboard input focus from the widget. | |
void | setFocus (Qt::FocusReason reason) |
Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}. | |
Qt::FocusPolicy | focusPolicy () const |
void | setFocusPolicy (Qt::FocusPolicy policy) |
bool | hasFocus () const |
void | setFocusProxy (QWidget *) |
Sets the widget's focus proxy to widget w. | |
QWidget * | focusProxy () const |
Returns the focus proxy, or \nullptr if there is no focus proxy. | |
Qt::ContextMenuPolicy | contextMenuPolicy () const |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | grabMouse () |
Grabs the mouse input. | |
void | grabMouse (const QCursor &) |
void | releaseMouse () |
Releases the mouse grab. | |
void | grabKeyboard () |
Grabs the keyboard input. | |
void | releaseKeyboard () |
Releases the keyboard grab. | |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut) |
Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. | |
void | releaseShortcut (int id) |
Removes the shortcut with the given id from Qt's shortcut system. | |
void | setShortcutEnabled (int id, bool enable=true) |
If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled. | |
void | setShortcutAutoRepeat (int id, bool enable=true) |
bool | updatesEnabled () const |
void | setUpdatesEnabled (bool enable) |
void | update (int x, int y, int w, int h) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget. | |
void | update (const QRect &) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget. | |
void | update (const QRegion &) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget. | |
void | repaint (int x, int y, int w, int h) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget. | |
void | repaint (const QRect &) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget. | |
void | repaint (const QRegion &) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget. | |
void | stackUnder (QWidget *) |
Places the widget under w in the parent widget's stack. | |
void | move (int x, int y) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)). | |
void | move (const QPoint &) |
void | resize (int w, int h) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)). | |
void | resize (const QSize &) |
void | setGeometry (int x, int y, int w, int h) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)). | |
void | setGeometry (const QRect &) |
QByteArray | saveGeometry () const |
bool | restoreGeometry (const QByteArray &geometry) |
void | adjustSize () |
Adjusts the size of the widget to fit its contents. | |
bool | isVisible () const |
bool | isVisibleTo (const QWidget *) const |
Returns true if this widget would become visible if ancestor is shown; otherwise returns false . | |
bool | isHidden () const |
Returns true if the widget is hidden, otherwise returns false . | |
bool | isMinimized () const |
bool | isMaximized () const |
bool | isFullScreen () const |
Qt::WindowStates | windowState () const |
Returns the current window state. | |
void | setWindowState (Qt::WindowStates state) |
Sets the window state to windowState. | |
void | overrideWindowState (Qt::WindowStates state) |
virtual QSize | minimumSizeHint () const |
QSizePolicy | sizePolicy () const |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width. | |
virtual int | heightForWidth (int) const |
Returns the preferred height for this widget, given the width w. | |
virtual bool | hasHeightForWidth () const |
QRegion | visibleRegion () const |
Returns the unobscured region where paint events can occur. | |
void | setContentsMargins (int left, int top, int right, int bottom) |
Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. | |
void | setContentsMargins (const QMargins &margins) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QMargins | contentsMargins () const |
The contentsMargins function returns the widget's contents margins. | |
QRect | contentsRect () const |
Returns the area inside the widget's margins. | |
QLayout * | layout () const |
Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed. | |
void | setLayout (QLayout *) |
Sets the layout manager for this widget to layout. | |
void | updateGeometry () |
Notifies the layout system that this widget has changed and may need to change geometry. | |
void | setParent (QWidget *parent) |
Sets the parent of the widget to parent, and resets the window flags. | |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument. | |
void | scroll (int dx, int dy) |
Scrolls the widget including its children dx pixels to the right and dy downward. | |
void | scroll (int dx, int dy, const QRect &) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget. | |
QWidget * | focusWidget () const |
Returns the last child of this widget that setFocus had been called on. | |
QWidget * | nextInFocusChain () const |
Returns the next widget in this widget's focus chain. | |
QWidget * | previousInFocusChain () const |
The previousInFocusChain function returns the previous widget in this widget's focus chain. | |
bool | acceptDrops () const |
void | setAcceptDrops (bool on) |
void | addAction (QAction *action) |
Appends the action action to this widget's list of actions. | |
void | addActions (const QList< QAction * > &actions) |
Appends the actions actions to this widget's list of actions. | |
void | insertActions (QAction *before, const QList< QAction * > &actions) |
Inserts the actions actions to this widget's list of actions, before the action before. | |
void | insertAction (QAction *before, QAction *action) |
Inserts the action action to this widget's list of actions, before the action before. | |
void | removeAction (QAction *action) |
Removes the action action from this widget's list of actions. | |
QList< QAction * > | actions () const |
Returns the (possibly empty) list of this widget's actions. | |
QAction * | addAction (const QString &text) |
QAction * | addAction (const QIcon &icon, const QString &text) |
QAction * | addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection) |
QAction * | addAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename... Args, typename = compatible_action_slot_args<Args...>> | |
QAction * | addAction (const QString &text, Args &&...args) |
template<typename... Args, typename = compatible_action_slot_args<Args...>> | |
QAction * | addAction (const QIcon &icon, const QString &text, Args &&...args) |
QWidget * | parentWidget () const |
Returns the parent of this widget, or \nullptr if it does not have any parent widget. | |
void | setWindowFlags (Qt::WindowFlags type) |
Qt::WindowFlags | windowFlags () const |
Window flags are a combination of a type (e.g. | |
void | setWindowFlag (Qt::WindowType, bool on=true) |
void | overrideWindowFlags (Qt::WindowFlags type) |
Sets the window flags for the widget to flags, without telling the window system. | |
Qt::WindowType | windowType () const |
Returns the window type of this widget. | |
QWidget * | childAt (int x, int y) const |
Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. | |
QWidget * | childAt (const QPoint &p) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system. | |
QWidget * | childAt (const QPointF &p) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | setAttribute (Qt::WidgetAttribute, bool on=true) |
Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. | |
bool | testAttribute (Qt::WidgetAttribute) const |
Returns true if attribute attribute is set on this widget; otherwise returns false . | |
QPaintEngine * | paintEngine () const override |
Returns the widget's paint engine. | |
void | ensurePolished () const |
Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette). | |
bool | isAncestorOf (const QWidget *child) const |
Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false . | |
bool | autoFillBackground () const |
void | setAutoFillBackground (bool enabled) |
QBackingStore * | backingStore () const |
QWindow * | windowHandle () const |
If this is a native widget, return the associated QWindow. | |
QScreen * | screen () const |
Returns the screen the widget is on. | |
void | setScreen (QScreen *) |
Sets the screen on which the widget should be shown to screen. | |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery) const |
This method is only relevant for input widgets. | |
Qt::InputMethodHints | inputMethodHints () const |
void | setInputMethodHints (Qt::InputMethodHints hints) |
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 . | |
Public Member Functions inherited from QPaintDevice | |
virtual | ~QPaintDevice () |
bool | paintingActive () const |
int | width () const |
int | height () const |
int | widthMM () const |
int | heightMM () const |
int | logicalDpiX () const |
int | logicalDpiY () const |
int | physicalDpiX () const |
int | physicalDpiY () const |
qreal | devicePixelRatio () const |
qreal | devicePixelRatioF () const |
int | colorCount () const |
int | depth () const |
Protected Member Functions | |
void | paintEvent (QPaintEvent *) override |
\reimp | |
void | mousePressEvent (QMouseEvent *) override |
\reimp | |
void | mouseReleaseEvent (QMouseEvent *) override |
\reimp | |
void | mouseMoveEvent (QMouseEvent *) override |
\reimp | |
void | hideEvent (QHideEvent *) override |
\reimp | |
void | sliderChange (SliderChange change) override |
\reimp | |
void | contextMenuEvent (QContextMenuEvent *) override |
\reimp | |
virtual void | initStyleOption (QStyleOptionSlider *option) const |
Initialize option with the values from this QScrollBar. | |
Protected Member Functions inherited from QAbstractSlider | |
void | setRepeatAction (SliderAction action, int thresholdTime=500, int repeatTime=50) |
Sets action action to be triggered repetitively in intervals of repeatTime, after an initial delay of thresholdTime. | |
SliderAction | repeatAction () const |
Returns the current repeat action. | |
void | keyPressEvent (QKeyEvent *ev) override |
\reimp | |
void | timerEvent (QTimerEvent *) override |
\reimp | |
void | changeEvent (QEvent *e) override |
\reimp | |
QAbstractSlider (QAbstractSliderPrivate &dd, QWidget *parent=nullptr) | |
Protected Member Functions inherited from QWidget | |
bool | event (QEvent *event) override |
This is the main event handler; it handles event event. | |
virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget. | |
virtual void | keyReleaseEvent (QKeyEvent *event) |
This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget. | |
virtual void | focusInEvent (QFocusEvent *event) |
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. | |
virtual void | focusOutEvent (QFocusEvent *event) |
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. | |
virtual void | enterEvent (QEnterEvent *event) |
This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter. | |
virtual void | leaveEvent (QEvent *event) |
This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter. | |
virtual void | moveEvent (QMoveEvent *event) |
This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. | |
virtual void | resizeEvent (QResizeEvent *event) |
This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter. | |
virtual void | closeEvent (QCloseEvent *event) |
This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system. | |
virtual void | actionEvent (QActionEvent *event) |
This event handler is called with the given event whenever the widget's actions are changed. | |
virtual void | showEvent (QShowEvent *event) |
This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter. | |
virtual bool | nativeEvent (const QByteArray &eventType, void *message, qintptr *result) |
This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter. | |
int | metric (PaintDeviceMetric) const override |
Internal implementation of the virtual QPaintDevice::metric() function. | |
void | initPainter (QPainter *painter) const override |
Initializes the painter pen, background and font to the same as the given widget's. | |
QPaintDevice * | redirected (QPoint *offset) const override |
QPainter * | sharedPainter () const override |
virtual void | inputMethodEvent (QInputMethodEvent *) |
This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events. | |
void | create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true) |
Creates a new widget window. | |
void | destroy (bool destroyWindow=true, bool destroySubWindows=true) |
Frees up window system resources. | |
virtual bool | focusNextPrevChild (bool next) |
Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't. | |
bool | focusNextChild () |
Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't. | |
bool | focusPreviousChild () |
Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't. | |
QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f) | |
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 | 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 QPaintDevice | |
QPaintDevice () noexcept | |
double | getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const |
Friends | |
class | QAbstractScrollAreaPrivate |
Q_WIDGETS_EXPORT QStyleOptionSlider | qt_qscrollbarStyleOption (QScrollBar *scrollBar) |
Additional Inherited Members | |
Public Types inherited from QAbstractSlider | |
enum | SliderAction { SliderNoAction , SliderSingleStepAdd , SliderSingleStepSub , SliderPageStepAdd , SliderPageStepSub , SliderToMinimum , SliderToMaximum , SliderMove } |
\value SliderNoAction \value SliderSingleStepAdd \value SliderSingleStepSub \value SliderPageStepAdd \value SliderPageStepSub \value SliderToMinimum \value SliderToMaximum \value SliderMove More... | |
Public Types inherited from QWidget | |
enum | RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 } |
This enum describes how to render the widget when calling QWidget::render(). More... | |
Public Types inherited from QPaintDevice | |
enum | PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled , PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB } |
Public Slots inherited from QAbstractSlider | |
void | setValue (int) |
void | setOrientation (Qt::Orientation) |
void | setRange (int min, int max) |
Sets the slider's minimum to min and its maximum to max. | |
Public Slots inherited from QWidget | |
void | setEnabled (bool) |
void | setDisabled (bool) |
Disables widget input events if disable is true; otherwise enables input events. | |
void | setWindowModified (bool) |
void | setWindowTitle (const QString &) |
void | setStyleSheet (const QString &styleSheet) |
void | setFocus () |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}. | |
void | update () |
Updates the widget unless updates are disabled or the widget is hidden. | |
void | repaint () |
Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. | |
virtual void | setVisible (bool visible) |
void | setHidden (bool hidden) |
Convenience function, equivalent to setVisible(!hidden). | |
void | show () |
Shows the widget and its child widgets. | |
void | hide () |
Hides the widget. | |
void | showMinimized () |
Shows the widget minimized, as an icon. | |
void | showMaximized () |
Shows the widget maximized. | |
void | showFullScreen () |
Shows the widget in full-screen mode. | |
void | showNormal () |
Restores the widget after it has been maximized or minimized. | |
bool | close () |
Closes this widget. | |
void | raise () |
Raises this widget to the top of the parent widget's stack. | |
void | lower () |
Lowers the widget to the bottom of the parent widget's stack. | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals inherited from QAbstractSlider | |
void | valueChanged (int value) |
This signal is emitted when the slider value has changed, with the new slider value as argument. | |
void | sliderPressed () |
This signal is emitted when the user presses the slider with the mouse, or programmatically when setSliderDown(true) is called. | |
void | sliderMoved (int position) |
This signal is emitted when sliderDown is true and the slider moves. | |
void | sliderReleased () |
This signal is emitted when the user releases the slider with the mouse, or programmatically when setSliderDown(false) is called. | |
void | rangeChanged (int min, int max) |
This signal is emitted when the slider range has changed, with min being the new minimum, and max being the new maximum. | |
void | actionTriggered (int action) |
This signal is emitted when the slider action action is triggered. | |
Signals inherited from QWidget | |
void | windowTitleChanged (const QString &title) |
This signal is emitted when the window's title has changed, with the new title as an argument. | |
void | windowIconChanged (const QIcon &icon) |
This signal is emitted when the window's icon has changed, with the new icon as an argument. | |
void | windowIconTextChanged (const QString &iconText) |
This signal is emitted when the window's icon text has changed, with the new iconText as an argument. | |
void | customContextMenuRequested (const QPoint &pos) |
This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. | |
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 QWidget | |
static void | setTabOrder (QWidget *, QWidget *) |
Puts the second widget after the first widget in the focus order. | |
static void | setTabOrder (std::initializer_list< QWidget * > widgets) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static QWidget * | mouseGrabber () |
Returns the widget that is currently grabbing the mouse input. | |
static QWidget * | keyboardGrabber () |
Returns the widget that is currently grabbing the keyboard input. | |
static QWidget * | find (WId) |
Returns a pointer to the widget with window identifier/handle id. | |
static QWidget * | createWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) |
Creates a QWidget that makes it possible to embed window into a QWidget-based application. | |
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) |
Static Public Member Functions inherited from QPaintDevice | |
static qreal | devicePixelRatioFScale () |
static int | encodeMetricF (PaintDeviceMetric metric, double value) |
Protected Types inherited from QAbstractSlider | |
enum | SliderChange { SliderRangeChange , SliderOrientationChange , SliderStepsChange , SliderValueChange } |
\value SliderRangeChange \value SliderOrientationChange \value SliderStepsChange \value SliderValueChange More... | |
Protected Slots inherited from QWidget | |
void | updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll) |
Updates the widget's micro focus and informs input methods that the state specified by query has changed. | |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Protected Attributes inherited from QPaintDevice | |
ushort | painters |
Properties inherited from QAbstractSlider | |
int | minimum |
the sliders's minimum value | |
int | maximum |
the slider's maximum value | |
int | singleStep |
the single step. | |
int | pageStep |
the page step. | |
int | value |
the slider's current value | |
int | sliderPosition |
the current slider position | |
bool | tracking |
whether slider tracking is enabled | |
Qt::Orientation | orientation |
the orientation of the slider | |
bool | invertedAppearance |
whether or not a slider shows its values inverted. | |
bool | invertedControls |
whether or not the slider inverts its wheel and key events. | |
bool | sliderDown |
whether the slider is pressed down. | |
Properties inherited from QWidget | |
bool | modal |
whether the widget is a modal widget | |
Qt::WindowModality | windowModality |
which windows are blocked by the modal widget | |
bool | enabled |
whether the widget is enabled | |
QRect | geometry |
the geometry of the widget relative to its parent and excluding the window frame | |
QRect | frameGeometry |
geometry of the widget relative to its parent including any window frame | |
QRect | normalGeometry |
the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget | |
int | x |
the x coordinate of the widget relative to its parent including any window frame | |
int | y |
the y coordinate of the widget relative to its parent and including any window frame | |
QPoint | pos |
the position of the widget within its parent widget | |
QSize | frameSize |
the size of the widget including any window frame | |
QSize | size |
the size of the widget excluding any window frame | |
int | width |
the width of the widget excluding any window frame | |
int | height |
the height of the widget excluding any window frame | |
QRect | rect |
the internal geometry of the widget excluding any window frame | |
QRect | childrenRect |
the bounding rectangle of the widget's children | |
QRegion | childrenRegion |
the combined region occupied by the widget's children | |
QSizePolicy | sizePolicy |
the default layout behavior of the widget | |
QSize | minimumSize |
the widget's minimum size | |
QSize | maximumSize |
the widget's maximum size in pixels | |
int | minimumWidth |
the widget's minimum width in pixels | |
int | minimumHeight |
the widget's minimum height in pixels | |
int | maximumWidth |
the widget's maximum width in pixels | |
int | maximumHeight |
the widget's maximum height in pixels | |
QSize | sizeIncrement |
the size increment of the widget | |
QSize | baseSize |
the base size of the widget | |
QPalette | palette |
the widget's palette | |
QFont | font |
the font currently set for the widget | |
QCursor | cursor |
the cursor shape for this widget | |
bool | mouseTracking |
whether mouse tracking is enabled for the widget | |
bool | tabletTracking |
whether tablet tracking is enabled for the widget | |
bool | isActiveWindow |
whether this widget's window is the active window | |
Qt::FocusPolicy | focusPolicy |
the way the widget accepts keyboard focus | |
bool | focus |
whether this widget (or its focus proxy) has the keyboard input focus | |
Qt::ContextMenuPolicy | contextMenuPolicy |
how the widget shows a context menu | |
bool | updatesEnabled |
whether updates are enabled | |
bool | visible |
whether the widget is visible | |
bool | minimized |
whether this widget is minimized (iconified) | |
bool | maximized |
whether this widget is maximized | |
bool | fullScreen |
whether the widget is shown in full screen mode | |
QSize | sizeHint |
the recommended size for the widget | |
QSize | minimumSizeHint |
the recommended minimum size for the widget | |
bool | acceptDrops |
whether drop events are enabled for this widget | |
QString | windowTitle |
the window title (caption) | |
QIcon | windowIcon |
the widget's icon | |
QString | windowIconText |
the text to be displayed on the icon of a minimized window | |
double | windowOpacity |
The level of opacity for the window. | |
bool | windowModified |
whether the document shown in the window has unsaved changes | |
Qt::LayoutDirection | layoutDirection |
the layout direction for this widget. | |
bool | autoFillBackground |
whether the widget background is filled automatically | |
QString | styleSheet |
the widget's style sheet | |
QLocale | locale |
the widget's locale | |
QString | windowFilePath |
the file path associated with a widget | |
Qt::InputMethodHints | inputMethodHints |
What input method specific hints the widget has. | |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Related Symbols inherited from QWidget | |
setupUi (QWidget *widget) | |
\macro QWIDGETSIZE_MAX | |
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) | |
The QScrollBar widget provides a vertical or horizontal scroll bar.
\inmodule QtWidgets
A scroll bar is a control that enables the user to access parts of a document that is larger than the widget used to display it. It provides a visual indication of the user's current position within the document and the amount of the document that is visible. Scroll bars are usually equipped with other controls that enable more accurate navigation. Qt displays scroll bars in a way that is appropriate for each platform.
If you need to provide a scrolling view onto another widget, it may be more convenient to use the QScrollArea class because this provides a viewport widget and scroll bars. QScrollBar is useful if you need to implement similar functionality for specialized widgets using QAbstractScrollArea; for example, if you decide to subclass QAbstractItemView. For most other situations where a slider control is used to obtain a value within a given range, the QSlider class may be more appropriate for your needs.
\table \row
\list
Each scroll bar has a value that indicates how far the slider is from the start of the scroll bar; this is obtained with value() and set with setValue(). This value always lies within the range of values defined for the scroll bar, from \l{QAbstractSlider::minimum()}{minimum()} to \l{QAbstractSlider::minimum()}{maximum()} inclusive. The range of acceptable values can be set with setMinimum() and setMaximum(). At the minimum value, the top edge of the slider (for a vertical scroll bar) or left edge (for a horizontal scroll bar) will be at the top (or left) end of the scroll bar. At the maximum value, the bottom (or right) edge of the slider will be at the bottom (or right) end of the scroll bar.
The length of the slider is usually related to the value of the page step, and typically represents the proportion of the document area shown in a scrolling view. The page step is the amount that the value changes by when the user presses the \uicontrol{Page Up} and \uicontrol{Page Down} keys, and is set with setPageStep(). Smaller changes to the value defined by the line step are made using the cursor keys, and this quantity is set with \l{QAbstractSlider::}{setSingleStep()}.
Note that the range of values used is independent of the actual size of the scroll bar widget. You do not need to take this into account when you choose values for the range and the page step.
The range of values specified for the scroll bar are often determined differently to those for a QSlider because the length of the slider needs to be taken into account. If we have a document with 100 lines, and we can only show 20 lines in a widget, we may wish to construct a scroll bar with a page step of 20, a minimum value of 0, and a maximum value of 80. This would give us a scroll bar with five "pages".
\table \row
QScrollBar only provides integer ranges. Note that although QScrollBar handles very large numbers, scroll bars on current screens cannot usefully represent ranges above about 100,000 pixels. Beyond that, it becomes difficult for the user to control the slider using either the keyboard or the mouse, and the scroll arrows will have limited use.
ScrollBar inherits a comprehensive set of signals from QAbstractSlider: \list
A scroll bar can be controlled by the keyboard, but it has a default focusPolicy() of Qt::NoFocus. Use setFocusPolicy() to enable keyboard interaction with the scroll bar: \list
The slider itself can be controlled by using the \l{QAbstractSlider::triggerAction()}{triggerAction()} function to simulate user interaction with the scroll bar controls. This is useful if you have many different widgets that use a common range of values.
Most GUI styles use the pageStep() value to calculate the size of the slider.
Definition at line 19 of file qscrollbar.h.
Constructs a vertical scroll bar.
The parent argument is sent to the QWidget constructor.
The \l {QAbstractSlider::minimum} {minimum} defaults to 0, the \l {QAbstractSlider::maximum} {maximum} to 99, with a \l {QAbstractSlider::singleStep} {singleStep} size of 1 and a \l {QAbstractSlider::pageStep} {pageStep} size of 10, and an initial \l {QAbstractSlider::value} {value} of 0.
Definition at line 315 of file qscrollbar.cpp.
|
explicit |
Constructs a scroll bar with the given orientation.
The parent argument is passed to the QWidget constructor.
The \l {QAbstractSlider::minimum} {minimum} defaults to 0, the \l {QAbstractSlider::maximum} {maximum} to 99, with a \l {QAbstractSlider::singleStep} {singleStep} size of 1 and a \l {QAbstractSlider::pageStep} {pageStep} size of 10, and an initial \l {QAbstractSlider::value} {value} of 0.
Definition at line 331 of file qscrollbar.cpp.
QScrollBar::~QScrollBar | ( | ) |
Destroys the scroll bar.
Definition at line 343 of file qscrollbar.cpp.
|
overrideprotectedvirtual |
|
overridevirtual |
|
overrideprotectedvirtual |
|
protectedvirtual |
Initialize option with the values from this QScrollBar.
This method is useful for subclasses when they need a QStyleOptionSlider, but don't want to fill in all the information themselves.
Definition at line 277 of file qscrollbar.cpp.
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
|
overridevirtual |
|
overrideprotectedvirtual |
|
friend |
Definition at line 47 of file qscrollbar.h.
|
friend |
Returns the style option for scroll bar.
Definition at line 704 of file qscrollbar.cpp.