QGIS/python/gui/auto_generated/qgsscrollarea.sip.in

76 lines
2.3 KiB
Plaintext
Raw Normal View History

2017-06-08 11:26:03 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsscrollarea.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsScrollArea : QScrollArea
{
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
A QScrollArea subclass with improved scrolling behavior.
2017-06-08 11:26:03 +02:00
2017-12-15 10:36:55 -04:00
QgsScrollArea should be used instead of QScrollArea widgets.
In most cases the use is identical, however QgsScrollArea
has extra logic to avoid wheel events changing child widget
values when the mouse cursor is temporarily located over
a child widget during a scroll event.
2017-06-08 11:26:03 +02:00
2017-12-15 10:36:55 -04:00
All QGIS code and plugins should use QgsScrollArea in place
of QScrollArea.
2017-06-08 11:26:03 +02:00
.. versionadded:: 3.0
%End
2017-06-08 11:26:03 +02:00
%TypeHeaderCode
#include "qgsscrollarea.h"
%End
public:
2017-06-08 11:26:03 +02:00
explicit QgsScrollArea( QWidget *parent /TransferThis/ = 0 );
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsScrollArea.
2017-06-08 11:26:03 +02:00
%End
void scrollOccurred();
2017-06-08 11:26:03 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Should be called when a scroll occurs on with the
QScrollArea itself or its child viewport().
2017-06-08 11:26:03 +02:00
%End
bool hasScrolled() const;
2017-06-08 11:26:03 +02:00
%Docstring
2019-02-26 19:54:09 +10:00
Returns ``True`` if a scroll recently occurred within
2017-12-15 10:36:55 -04:00
the QScrollArea or its child viewport()
%End
void setVerticalOnly( bool verticalOnly );
%Docstring
Sets whether the scroll area only applies vertical.
If set to ``True``, then scroll area children will resize horizontally to match the width of
the scroll area widget.
.. versionadded:: 3.8
2017-06-08 11:26:03 +02:00
%End
protected:
2017-06-08 11:26:03 +02:00
virtual void wheelEvent( QWheelEvent *event );
virtual void resizeEvent( QResizeEvent *event );
};
2017-06-08 11:26:03 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsscrollarea.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/