File: qgscomposernodesitem.sip

package info (click to toggle)
qgis 2.18.28%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,007,948 kB
  • sloc: cpp: 671,774; python: 158,539; xml: 35,690; ansic: 8,346; sh: 1,766; perl: 1,669; sql: 999; yacc: 836; lex: 461; makefile: 292
file content (111 lines) | stat: -rw-r--r-- 3,947 bytes parent folder | download
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
class QgsComposerNodesItem: QgsComposerItem
{
%TypeHeaderCode
#include <qgscomposernodesitem.h>
%End
  public:

    QgsComposerNodesItem( QString mTagName, QgsComposition* c );
    QgsComposerNodesItem( QString mTagName, QPolygonF polygon, QgsComposition* c );
    ~QgsComposerNodesItem();

    /** Add a node in current shape.
     * @param pt is the location of the new node
     * @param checkArea is a flag to indicate if there's a space constraint.
     * @param radius is the space contraint and is used only if checkArea is
     * true. Typically, if this flag is true, the new node has to be nearest
     * than radius to the shape to be added.
     */
    bool addNode( const QPointF &pt, const bool checkArea = true, const double radius = 10 );

    /** Set a tag to indicate if we want to draw or not the shape's nodes.
     * @param display
     */
    void setDisplayNodes( const bool display = true );

    /** Move a node to a new position.
     * @param index the index of the node to move
     * @param node is the new position in scene coordinate
     */
    bool moveNode( const int index, const QPointF &node );

    /** \brief Reimplementation of QCanvasItem::paint - draw on canvas */
    void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget );

    /** Search the nearest node in shape within a maximal area. Returns the
     * index of the nearest node or -1.
     * @param node is where a shape's node is searched
     * @param searchInRadius is a flag to indicate if the area of research is
     * limited in space.
     * @param radius is only used if searchInRadius is true
     */
    int nodeAtPosition( QPointF node, const bool searchInRadius = true, const double radius = 10 );

    /** Gets the position of a node in scene coordinate.
      * @param index of the node
      * @param position the position of the node
      * @return true if the index is valid and the position is set, false otherwise
      */
    bool nodePosition( const int index, QPointF &position );

    /** Sets state from Dom document
     * @param itemElem is Dom node corresponding to item tag
     * @param doc is Dom document
     */
    bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

    /** Remove a node from the shape.
     * @param index of the node to delete
     */
    bool removeNode( const int index );

    /** Returns the number of nodes in the shape. */
    int nodesSize();

    /** Select a node.
     * @param index the node to select
     */
    bool setSelectedNode( const int index );

    /** Returns the currently selected node.
      * @return the index of the selected node, -1 otherwise
      */
    int selectedNode();

    /** Unselect a node.
     */
    void unselectNode();

    /** Stores state in Dom element
     * @param elem is Dom element corresponding to 'Composer' tag
     * @param doc write template file
     */
    bool writeXML( QDomElement& elem, QDomDocument & doc ) const;

  protected:

    /** Method called in addNode. */
    virtual bool _addNode( const int nodeIndex, const QPointF &newPoint, const double radius ) = 0;

    /** Method called in removeNode. */
    virtual bool _removeNode( const int nodeIndex ) = 0;

    /** Method called in paint. */
    virtual void _draw( QPainter *painter ) = 0;

    /** Method called in readXML. */
    virtual void _readXMLStyle( const QDomElement &elmt ) = 0;

    /** Method called in writeXML. */
    virtual void _writeXMLStyle( QDomDocument &doc, QDomElement &elmt ) const = 0;

    /** Rescale the current shape according to the boudning box. Useful when
     * the shape is resized thanks to the rubber band. */
    void rescaleToFitBoundingBox();

    /** Compute an euclidian distance between 2 nodes. */
    double computeDistance(const QPointF &pt1, const QPointF &pt2) const;

    /** Update the current scene rectangle for this item. */
    void updateSceneRect();
};