KLayout Manual: Main Index » Class Index » API reference - Class QScrollArea

API reference - Class QScrollArea

Notation used in Ruby API documentation

Description: Binding of QScrollArea

Class hierarchy: QScrollArea » QAbstractScrollArea » QFrame » QWidget » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[virtual] void actionEvent(QActionEvent ptr arg1)

Description: Virtual method void QScrollArea::actionEvent(QActionEvent *)

This method can be reimplemented in a derived class.

[const] Qt_QFlags_AlignmentFlag alignment

Description: Method QFlags<Qt::AlignmentFlag> QScrollArea::alignment()

Python specific notes:

The object exposes a readable attribute 'alignment'. This is the getter.

void alignment=(const Qt_QFlags_AlignmentFlag arg1)

Description: Method void QScrollArea::setAlignment(QFlags<Qt::AlignmentFlag>)

Python specific notes:

The object exposes a writable attribute 'alignment'. This is the setter.

[virtual] void changeEvent(QEvent ptr arg1)

Description: Virtual method void QScrollArea::changeEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QScrollArea::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

[virtual] void closeEvent(QCloseEvent ptr arg1)

Description: Virtual method void QScrollArea::closeEvent(QCloseEvent *)

This method can be reimplemented in a derived class.

[virtual] void contextMenuEvent(QContextMenuEvent ptr arg1)

Description: Virtual method void QScrollArea::contextMenuEvent(QContextMenuEvent *)

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[event] void customContextMenuRequested(const QPoint pos)

Description: Signal declaration for QScrollArea::customContextMenuRequested(const QPoint &pos)

You can bind a procedure to this signal.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QScrollArea::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QScrollArea::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QScrollArea::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] void dragEnterEvent(QDragEnterEvent ptr arg1)

Description: Virtual method void QScrollArea::dragEnterEvent(QDragEnterEvent *)

This method can be reimplemented in a derived class.

[virtual] void dragLeaveEvent(QDragLeaveEvent ptr arg1)

Description: Virtual method void QScrollArea::dragLeaveEvent(QDragLeaveEvent *)

This method can be reimplemented in a derived class.

[virtual] void dragMoveEvent(QDragMoveEvent ptr arg1)

Description: Virtual method void QScrollArea::dragMoveEvent(QDragMoveEvent *)

This method can be reimplemented in a derived class.

void drawFrame(QPainter ptr arg1)

Description: Method void QScrollArea::drawFrame(QPainter *)

This method is protected and can only be called from inside a derived class.

[virtual] void dropEvent(QDropEvent ptr arg1)

Description: Virtual method void QScrollArea::dropEvent(QDropEvent *)

This method can be reimplemented in a derived class.

[virtual] void enabledChange(bool arg1)

Description: Virtual method void QScrollArea::enabledChange(bool)

This method can be reimplemented in a derived class.

void ensureVisible(int x,int y,int xmargin = 50,int ymargin = 50)

Description: Method void QScrollArea::ensureVisible(int x, int y, int xmargin, int ymargin)

void ensureWidgetVisible(QWidget ptr childWidget,int xmargin = 50,int ymargin = 50)

Description: Method void QScrollArea::ensureWidgetVisible(QWidget *childWidget, int xmargin, int ymargin)

[virtual] void enterEvent(QEvent ptr arg1)

Description: Virtual method void QScrollArea::enterEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QScrollArea::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QScrollArea::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[virtual] void focusInEvent(QFocusEvent ptr arg1)

Description: Virtual method void QScrollArea::focusInEvent(QFocusEvent *)

This method can be reimplemented in a derived class.

bool focusNextChild

Description: Method bool QScrollArea::focusNextChild()

This method is protected and can only be called from inside a derived class.

[virtual] bool focusNextPrevChild(bool next)

Description: Virtual method bool QScrollArea::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

[virtual] void focusOutEvent(QFocusEvent ptr arg1)

Description: Virtual method void QScrollArea::focusOutEvent(QFocusEvent *)

This method can be reimplemented in a derived class.

bool focusPreviousChild

Description: Method bool QScrollArea::focusPreviousChild()

This method is protected and can only be called from inside a derived class.

[virtual] void fontChange(const QFont arg1)

Description: Virtual method void QScrollArea::fontChange(const QFont &)

This method can be reimplemented in a derived class.

[virtual,const] int heightForWidth(int arg1)

Description: Virtual method int QScrollArea::heightForWidth(int)

This method can be reimplemented in a derived class.

[virtual] void hideEvent(QHideEvent ptr arg1)

Description: Virtual method void QScrollArea::hideEvent(QHideEvent *)

This method can be reimplemented in a derived class.

[virtual] void inputMethodEvent(QInputMethodEvent ptr arg1)

Description: Virtual method void QScrollArea::inputMethodEvent(QInputMethodEvent *)

This method can be reimplemented in a derived class.

[virtual,const] QVariant inputMethodQuery(const Qt_InputMethodQuery arg1)

Description: Virtual method QVariant QScrollArea::inputMethodQuery(Qt::InputMethodQuery)

This method can be reimplemented in a derived class.

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[virtual] void keyPressEvent(QKeyEvent ptr arg1)

Description: Virtual method void QScrollArea::keyPressEvent(QKeyEvent *)

This method can be reimplemented in a derived class.

[virtual] void keyReleaseEvent(QKeyEvent ptr arg1)

Description: Virtual method void QScrollArea::keyReleaseEvent(QKeyEvent *)

This method can be reimplemented in a derived class.

[virtual] void languageChange

Description: Virtual method void QScrollArea::languageChange()

This method can be reimplemented in a derived class.

[virtual] void leaveEvent(QEvent ptr arg1)

Description: Virtual method void QScrollArea::leaveEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual,const] int metric(const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QScrollArea::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

[virtual,const] QSize minimumSizeHint

Description: Virtual method QSize QScrollArea::minimumSizeHint()

This method can be reimplemented in a derived class.

[virtual] void mouseDoubleClickEvent(QMouseEvent ptr arg1)

Description: Virtual method void QScrollArea::mouseDoubleClickEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

[virtual] void mouseMoveEvent(QMouseEvent ptr arg1)

Description: Virtual method void QScrollArea::mouseMoveEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

[virtual] void mousePressEvent(QMouseEvent ptr arg1)

Description: Virtual method void QScrollArea::mousePressEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

[virtual] void mouseReleaseEvent(QMouseEvent ptr arg1)

Description: Virtual method void QScrollArea::mouseReleaseEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

[virtual] void moveEvent(QMoveEvent ptr arg1)

Description: Virtual method void QScrollArea::moveEvent(QMoveEvent *)

This method can be reimplemented in a derived class.

[static] new QScrollArea new(QWidget ptr parent = 0)

Description: Constructor QScrollArea::QScrollArea(QWidget *parent)

This method creates an object of class QScrollArea.

Python specific notes:

This method is the default initializer of the object

[virtual,const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QScrollArea::paintEngine()

This method can be reimplemented in a derived class.

[virtual] void paintEvent(QPaintEvent ptr arg1)

Description: Virtual method void QScrollArea::paintEvent(QPaintEvent *)

This method can be reimplemented in a derived class.

[virtual] void paletteChange(const QPalette arg1)

Description: Virtual method void QScrollArea::paletteChange(const QPalette &)

This method can be reimplemented in a derived class.

void qt_create(unsigned long arg1 = 0,bool initializeWindow = true,bool destroyOldWindow = true)

Description: Method void QScrollArea::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

void qt_destroy(bool destroyWindow = true,bool destroySubWindows = true)

Description: Method void QScrollArea::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

[const] int receivers(string signal)

Description: Method int QScrollArea::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

void resetInputContext

Description: Method void QScrollArea::resetInputContext()

This method is protected and can only be called from inside a derived class.

[virtual] void resizeEvent(QResizeEvent ptr arg1)

Description: Virtual method void QScrollArea::resizeEvent(QResizeEvent *)

This method can be reimplemented in a derived class.

[virtual] void scrollContentsBy(int dx,int dy)

Description: Virtual method void QScrollArea::scrollContentsBy(int dx, int dy)

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject *QScrollArea::sender()

This method is protected and can only be called from inside a derived class.

void setAlignment(const Qt_QFlags_AlignmentFlag arg1)

Description: Method void QScrollArea::setAlignment(QFlags<Qt::AlignmentFlag>)

Python specific notes:

The object exposes a writable attribute 'alignment'. This is the setter.

void setViewportMargins(int left,int top,int right,int bottom)

Description: Method void QScrollArea::setViewportMargins(int left, int top, int right, int bottom)

This method is protected and can only be called from inside a derived class.

void setViewportMargins(const QMargins margins)

Description: Method void QScrollArea::setViewportMargins(const QMargins &margins)

This method is protected and can only be called from inside a derived class.

[virtual] void setVisible(bool visible)

Description: Virtual method void QScrollArea::setVisible(bool visible)

This method can be reimplemented in a derived class.

void setWidget(QWidget ptr widget)

Description: Method void QScrollArea::setWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'widget'. This is the setter.

void setWidgetResizable(bool resizable)

Description: Method void QScrollArea::setWidgetResizable(bool resizable)

Python specific notes:

The object exposes a writable attribute 'widgetResizable'. This is the setter.

void setupViewport(QWidget ptr viewport)

Description: Method void QScrollArea::setupViewport(QWidget *viewport)

This method is protected and can only be called from inside a derived class.

[virtual] void showEvent(QShowEvent ptr arg1)

Description: Virtual method void QScrollArea::showEvent(QShowEvent *)

This method can be reimplemented in a derived class.

[virtual,const] QSize sizeHint

Description: Virtual method QSize QScrollArea::sizeHint()

This method can be reimplemented in a derived class.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void styleChange(QStyle arg1)

Description: Virtual method void QScrollArea::styleChange(QStyle &)

This method can be reimplemented in a derived class.

[virtual] void tabletEvent(QTabletEvent ptr arg1)

Description: Virtual method void QScrollArea::tabletEvent(QTabletEvent *)

This method can be reimplemented in a derived class.

new QWidget ptr takeWidget

Description: Method QWidget *QScrollArea::takeWidget()

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QScrollArea::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QScrollArea::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QScrollArea::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QScrollArea::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QScrollArea::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

void updateMicroFocus

Description: Method void QScrollArea::updateMicroFocus()

This method is protected and can only be called from inside a derived class.

[virtual] bool viewportEvent(QEvent ptr arg1)

Description: Virtual method bool QScrollArea::viewportEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual] void wheelEvent(QWheelEvent ptr arg1)

Description: Virtual method void QScrollArea::wheelEvent(QWheelEvent *)

This method can be reimplemented in a derived class.

[const] QWidget ptr widget

Description: Method QWidget *QScrollArea::widget()

Python specific notes:

The object exposes a readable attribute 'widget'. This is the getter.

void widget=(QWidget ptr widget)

Description: Method void QScrollArea::setWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'widget'. This is the setter.

[const] bool widgetResizable

Description: Method bool QScrollArea::widgetResizable()

Python specific notes:

The object exposes a readable attribute 'widgetResizable'. This is the getter.

void widgetResizable=(bool resizable)

Description: Method void QScrollArea::setWidgetResizable(bool resizable)

Python specific notes:

The object exposes a writable attribute 'widgetResizable'. This is the setter.

[virtual] void windowActivationChange(bool arg1)

Description: Virtual method void QScrollArea::windowActivationChange(bool)

This method can be reimplemented in a derived class.