File: qgsscrollarea.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (73 lines) | stat: -rw-r--r-- 2,443 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsscrollarea.h                                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsScrollArea : QScrollArea
{
%Docstring(signature="appended")
A QScrollArea subclass with improved scrolling behavior.

:py:class:`QgsScrollArea` should be used instead of QScrollArea widgets.
In most cases the use is identical, however :py:class:`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.

All QGIS code and plugins should use :py:class:`QgsScrollArea` in place
of QScrollArea.
%End

%TypeHeaderCode
#include "qgsscrollarea.h"
%End
  public:
    explicit QgsScrollArea( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsScrollArea.
%End

    void scrollOccurred();
%Docstring
Should be called when a scroll occurs on with the QScrollArea itself or
its child :py:func:`~QgsScrollArea.viewport`.
%End

    bool hasScrolled() const;
%Docstring
Returns ``True`` if a scroll recently occurred within the QScrollArea or
its child :py:func:`~QgsScrollArea.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
%End

  protected:
    virtual void wheelEvent( QWheelEvent *event );

    virtual void resizeEvent( QResizeEvent *event );


};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsscrollarea.h                                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/