-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslayoutitemmapgrid.sip.in
877 lines (625 loc) · 22 KB
/
qgslayoutitemmapgrid.sip.in
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemmapgrid.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutItemMapGridStack : QgsLayoutItemMapItemStack
{
%Docstring
A collection of grids which is drawn above the map content in a
QgsLayoutItemMap. The grid stack controls which grids are drawn and the
order they are drawn in.
.. seealso:: :py:class:`QgsLayoutItemMapGrid`
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutitemmapgrid.h"
%End
public:
QgsLayoutItemMapGridStack( QgsLayoutItemMap *map );
%Docstring
Constructor for QgsLayoutItemMapGridStack, attached to the specified ``map``.
%End
void addGrid( QgsLayoutItemMapGrid *grid /Transfer/ );
%Docstring
Adds a new map ``grid`` to the stack and takes ownership of the grid.
The grid will be added to the end of the stack, and rendered
above any existing map grids already present in the stack.
.. note::
After adding a grid to the stack, updateBoundingRect() and update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
.. seealso:: :py:func:`removeGrid`
%End
void removeGrid( const QString &gridId );
%Docstring
Removes a grid with matching ``gridId`` from the stack and deletes the corresponding :py:class:`QgsLayoutItemMapGrid`.
.. note::
After removing a grid from the stack, updateBoundingRect() and update()
should be called for the QgsLayoutItemMap to prevent rendering artifacts.
.. seealso:: :py:func:`addGrid`
%End
void moveGridUp( const QString &gridId );
%Docstring
Moves a grid with matching ``gridId`` up the stack, causing it to be rendered above other grids.
.. note::
After moving a grid within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
.. seealso:: :py:func:`moveGridDown`
%End
void moveGridDown( const QString &gridId );
%Docstring
Moves a grid with matching ``gridId`` down the stack, causing it to be rendered below other grids.
.. note::
After moving a grid within the stack, update() should be
called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
.. seealso:: :py:func:`moveGridUp`
%End
QgsLayoutItemMapGrid *grid( const QString &gridId ) const;
%Docstring
Returns a reference to a grid with matching ``gridId`` within the stack.
%End
QgsLayoutItemMapGrid *grid( int index ) const;
%Docstring
Returns a reference to a grid at the specified ``index`` within the stack.
%End
QgsLayoutItemMapGrid &operator[]( int index );
QList< QgsLayoutItemMapGrid * > asList() const;
%Docstring
Returns a list of QgsLayoutItemMapGrids contained by the stack.
%End
virtual bool readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context );
double maxGridExtension() const;
%Docstring
Calculates the maximum distance grids within the stack extend
beyond the QgsLayoutItemMap's item rect.
.. seealso:: :py:func:`calculateMaxGridExtension`
%End
void calculateMaxGridExtension( double &top, double &right, double &bottom, double &left ) const;
%Docstring
Calculates the maximum distance grids within the stack extend beyond the
QgsLayoutItemMap's item rect. This method calculates the distance for each side of the
map item separately.
.. seealso:: :py:func:`maxGridExtension`
%End
};
class QgsLayoutItemMapGrid : QgsLayoutItemMapItem
{
%Docstring
An individual grid which is drawn above the map content in a
:py:class:`QgsLayoutItemMap`.
.. seealso:: :py:class:`QgsLayoutItemMapGridStack`
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutitemmapgrid.h"
%End
public:
enum GridUnit
{
MapUnit,
MM,
CM
};
enum GridStyle
{
Solid,
Cross,
Markers,
FrameAnnotationsOnly
};
enum DisplayMode
{
ShowAll,
LatitudeOnly,
LongitudeOnly,
HideAll
};
enum AnnotationPosition
{
InsideMapFrame,
OutsideMapFrame,
};
enum AnnotationDirection
{
Horizontal,
Vertical,
VerticalDescending,
BoundaryDirection
};
enum AnnotationFormat
{
Decimal,
DegreeMinute,
DegreeMinuteSecond,
DecimalWithSuffix,
DegreeMinuteNoSuffix,
DegreeMinutePadded,
DegreeMinuteSecondNoSuffix,
DegreeMinuteSecondPadded,
CustomFormat
};
enum BorderSide
{
Left,
Right,
Bottom,
Top
};
enum FrameStyle
{
NoFrame,
Zebra,
InteriorTicks,
ExteriorTicks,
InteriorExteriorTicks,
LineBorder,
LineBorderNautical
};
enum FrameSideFlag
{
FrameLeft,
FrameRight,
FrameTop,
FrameBottom
};
typedef QFlags<QgsLayoutItemMapGrid::FrameSideFlag> FrameSideFlags;
enum AnnotationCoordinate
{
Longitude,
Latitude
};
QgsLayoutItemMapGrid( const QString &name, QgsLayoutItemMap *map );
%Docstring
Constructor for QgsLayoutItemMapGrid.
:param name: friendly display name for grid
:param map: QgsLayoutItemMap the grid is attached to
%End
virtual void draw( QPainter *painter );
virtual bool writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const;
virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context );
void setCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the ``crs`` for the grid.
.. seealso:: :py:func:`crs`
%End
QgsCoordinateReferenceSystem crs() const;
%Docstring
Retrieves the CRS for the grid.
.. seealso:: :py:func:`setCrs`
%End
void setBlendMode( const QPainter::CompositionMode mode );
%Docstring
Sets the blending ``mode`` used for drawing the grid.
.. seealso:: :py:func:`blendMode`
%End
QPainter::CompositionMode blendMode() const;
%Docstring
Retrieves the blending mode used for drawing the grid.
.. seealso:: :py:func:`setBlendMode`
%End
virtual bool usesAdvancedEffects() const;
double maxExtension() const;
%Docstring
Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap's
item rect (in layout units).
%End
void calculateMaxExtension( double &top, double &right, double &bottom, double &left ) const;
%Docstring
Calculates the maximum distance the grid extends beyond the
QgsLayoutItemMap's item rect. This method calculates the distance for each side of the
map item separately.
.. seealso:: :py:func:`maxExtension`
%End
void setUnits( GridUnit unit );
%Docstring
Sets the ``unit`` to use for grid measurements such as the interval
and offset for grid lines.
.. seealso:: :py:func:`units`
%End
GridUnit units() const;
%Docstring
Returns the units used for grid measurements such as the interval
and offset for grid lines.
.. seealso:: :py:func:`setUnits`
%End
void setIntervalX( double interval );
%Docstring
Sets the ``interval`` between grid lines in the x-direction. The units
are controlled through the setUnits method
.. seealso:: :py:func:`setIntervalY`
.. seealso:: :py:func:`intervalX`
%End
double intervalX() const;
%Docstring
Returns the interval between grid lines in the x-direction. The units
are retrieved through the units() method.
.. seealso:: :py:func:`setIntervalX`
.. seealso:: :py:func:`intervalY`
%End
void setIntervalY( double interval );
%Docstring
Sets the ``interval`` between grid lines in the y-direction. The units
are controlled through the setUnits method
.. seealso:: :py:func:`setIntervalX`
.. seealso:: :py:func:`intervalY`
%End
double intervalY() const;
%Docstring
Returns the interval between grid lines in the y-direction. The units
are retrieved through the units() method.
.. seealso:: :py:func:`setIntervalY`
.. seealso:: :py:func:`intervalX`
%End
void setOffsetX( double offset );
%Docstring
Sets the ``offset`` for grid lines in the x-direction. The units
are controlled through the setUnits method.
.. seealso:: :py:func:`setOffsetY`
.. seealso:: :py:func:`offsetX`
%End
double offsetX() const;
%Docstring
Returns the offset for grid lines in the x-direction. The units
are retrieved through the units() method.
.. seealso:: :py:func:`setOffsetX`
.. seealso:: :py:func:`offsetY`
%End
void setOffsetY( double offset );
%Docstring
Sets the ``offset`` for grid lines in the y-direction. The units
are controlled through the setUnits method.
.. seealso:: :py:func:`setOffsetX`
.. seealso:: :py:func:`offsetY`
%End
double offsetY() const;
%Docstring
Returns the offset for grid lines in the y-direction. The units
are retrieved through the units() method.
.. seealso:: :py:func:`setOffsetY`
.. seealso:: :py:func:`offsetX`
%End
void setStyle( GridStyle style );
%Docstring
Sets the grid ``style``, which controls how the grid is drawn
over the map's contents.
.. seealso:: :py:func:`style`
%End
GridStyle style() const;
%Docstring
Returns the grid's style, which controls how the grid is drawn
over the map's contents.
.. seealso:: :py:func:`setStyle`
%End
void setCrossLength( const double length );
%Docstring
Sets the ``length`` (in layout units) of the cross segments drawn for the grid. This is only used for grids
with QgsLayoutItemMapGrid.Cross styles.
.. seealso:: :py:func:`crossLength`
%End
double crossLength() const;
%Docstring
Retrieves the length (in layout units) of the cross segments drawn for the grid. This is only used for grids
with QgsLayoutItemMapGrid.Cross styles.
.. seealso:: :py:func:`setCrossLength`
%End
void setGridLineWidth( double width );
%Docstring
Sets the ``width`` of grid lines (in layout units). This is only used for grids with QgsLayoutItemMapGrid.Solid
or QgsLayoutItemMapGrid.Cross styles. For more control over grid line appearance, use
setLineSymbol instead.
.. seealso:: :py:func:`setLineSymbol`
.. seealso:: :py:func:`setGridLineColor`
%End
void setGridLineColor( const QColor &color );
%Docstring
Sets the ``color`` of grid lines. This is only used for grids with QgsLayoutItemMapGrid.Solid
or QgsLayoutItemMapGrid.Cross styles. For more control over grid line appearance, use
setLineSymbol instead.
.. seealso:: :py:func:`setLineSymbol`
.. seealso:: :py:func:`setGridLineWidth`
%End
void setLineSymbol( QgsLineSymbol *symbol /Transfer/ );
%Docstring
Sets the line ``symbol`` used for drawing grid lines. This is only used for grids with
QgsLayoutItemMapGrid.Solid or QgsLayoutItemMapGrid.Cross styles.
Ownership of ``symbol`` is transferred to the grid.
.. seealso:: :py:func:`lineSymbol`
.. seealso:: :py:func:`setMarkerSymbol`
.. seealso:: :py:func:`setStyle`
%End
QgsLineSymbol *lineSymbol();
%Docstring
Returns the line symbol used for drawing grid lines. This is only used for grids with
QgsLayoutItemMapGrid.Solid or QgsLayoutItemMapGrid.Cross styles.
.. seealso:: :py:func:`setLineSymbol`
.. seealso:: :py:func:`markerSymbol`
.. seealso:: :py:func:`style`
%End
void setMarkerSymbol( QgsMarkerSymbol *symbol /Transfer/ );
%Docstring
Sets the marker ``symbol`` used for drawing grid points. This is only used for grids with a
QgsLayoutItemMapGrid.Markers style.
Ownership of ``symbol`` is transferred to the grid.
.. seealso:: :py:func:`markerSymbol`
.. seealso:: :py:func:`setLineSymbol`
.. seealso:: :py:func:`setStyle`
%End
QgsMarkerSymbol *markerSymbol();
%Docstring
Returns the marker symbol used for drawing grid points. This is only used for grids with a
QgsLayoutItemMapGrid.Markers style.
.. seealso:: :py:func:`setMarkerSymbol`
.. seealso:: :py:func:`lineSymbol`
.. seealso:: :py:func:`style`
%End
void setAnnotationEnabled( const bool enabled );
%Docstring
Sets whether annotations should be shown for the grid.
.. seealso:: :py:func:`annotationEnabled`
%End
bool annotationEnabled() const;
%Docstring
Returns whether annotations are shown for the grid.
.. seealso:: :py:func:`setAnnotationEnabled`
%End
void setAnnotationFont( const QFont &font );
%Docstring
Sets the ``font`` used for drawing grid annotations.
.. seealso:: :py:func:`annotationFont`
%End
QFont annotationFont() const;
%Docstring
Returns the font used for drawing grid annotations.
.. seealso:: :py:func:`setAnnotationFont`
%End
void setAnnotationFontColor( const QColor &color );
%Docstring
Sets the font ``color`` used for drawing grid annotations.
.. seealso:: :py:func:`annotationFontColor`
%End
QColor annotationFontColor() const;
%Docstring
Returns the font color used for drawing grid annotations.
.. seealso:: :py:func:`setAnnotationFontColor`
%End
void setAnnotationPrecision( const int precision );
%Docstring
Sets the coordinate ``precision`` for grid annotations.
The ``precision`` indicates the number of decimal places to show when drawing grid annotations.
.. seealso:: :py:func:`annotationPrecision`
%End
int annotationPrecision() const;
%Docstring
Returns the coordinate precision for grid annotations, which is the
number of decimal places shown when drawing grid annotations.
.. seealso:: :py:func:`setAnnotationPrecision`
%End
void setAnnotationDisplay( DisplayMode display, BorderSide border );
%Docstring
Sets what types of grid annotations should be drawn for a specified side of the map frame,
or whether grid annotations should be disabled for the side.
:param display: display mode for annotations
:param border: side of map for annotations
.. seealso:: :py:func:`annotationDisplay`
%End
DisplayMode annotationDisplay( BorderSide border ) const;
%Docstring
Returns the display mode for the grid annotations on a specified side of the map
frame. This property also specifies whether annotations have been disabled
from a side of the map frame.
:param border: side of map for annotations
:return: display mode for grid annotations
.. seealso:: :py:func:`setAnnotationDisplay`
%End
void setAnnotationPosition( AnnotationPosition position, BorderSide side );
%Docstring
Sets the ``position`` for the grid annotations on a specified ``side`` of the map
frame.
.. seealso:: :py:func:`annotationPosition`
%End
AnnotationPosition annotationPosition( BorderSide side ) const;
%Docstring
Returns the position for the grid annotations on a specified ``side`` of the map
frame.
.. seealso:: :py:func:`setAnnotationPosition`
%End
void setAnnotationFrameDistance( const double distance );
%Docstring
Sets the ``distance`` between the map frame and annotations. Units are layout units.
.. seealso:: :py:func:`annotationFrameDistance`
%End
double annotationFrameDistance() const;
%Docstring
Returns the distance between the map frame and annotations. Units are in layout units.
.. seealso:: :py:func:`setAnnotationFrameDistance`
%End
void setAnnotationDirection( AnnotationDirection direction, BorderSide side );
%Docstring
Sets the ``direction`` for drawing frame annotations for the specified map ``side``.
.. seealso:: :py:func:`annotationDirection`
%End
void setAnnotationDirection( AnnotationDirection direction );
%Docstring
Sets the ``direction`` for drawing all frame annotations.
.. seealso:: :py:func:`annotationDirection`
%End
AnnotationDirection annotationDirection( BorderSide border ) const;
%Docstring
Returns the direction for drawing frame annotations, on the specified ``side``
of the map.
.. seealso:: :py:func:`setAnnotationDirection`
%End
void setAnnotationFormat( const AnnotationFormat format );
%Docstring
Sets the ``format`` for drawing grid annotations.
.. seealso:: :py:func:`annotationFormat`
%End
AnnotationFormat annotationFormat() const;
%Docstring
Returns the format for drawing grid annotations.
.. seealso:: :py:func:`setAnnotationFormat`
%End
void setAnnotationExpression( const QString &expression );
%Docstring
Sets the ``expression`` used for drawing grid annotations. This is only used when annotationFormat()
is QgsLayoutItemMapGrid.CustomFormat.
.. seealso:: :py:func:`annotationExpression`
%End
QString annotationExpression() const;
%Docstring
Returns the expression used for drawing grid annotations. This is only used when annotationFormat()
is QgsLayoutItemMapGrid.CustomFormat.
.. seealso:: :py:func:`setAnnotationExpression`
%End
void setFrameStyle( const FrameStyle style );
%Docstring
Sets the grid frame ``style``.
.. seealso:: :py:func:`frameStyle`
%End
FrameStyle frameStyle() const;
%Docstring
Returns the grid frame style.
.. seealso:: :py:func:`setFrameStyle`
%End
void setFrameDivisions( DisplayMode divisions, BorderSide side );
%Docstring
Sets what type of grid ``divisions`` should be used for frames on a specified ``side`` of the map.
.. seealso:: :py:func:`frameDivisions`
%End
DisplayMode frameDivisions( BorderSide side ) const;
%Docstring
Returns the type of grid divisions which are used for frames on a specified ``side`` of the map.
.. seealso:: :py:func:`setFrameDivisions`
%End
void setFrameSideFlags( QgsLayoutItemMapGrid::FrameSideFlags flags );
%Docstring
Sets ``flags`` for grid frame sides. Setting these flags controls which sides
of the map item the grid frame is drawn on.
.. seealso:: :py:func:`setFrameSideFlag`
.. seealso:: :py:func:`frameSideFlags`
.. seealso:: :py:func:`testFrameSideFlag`
%End
void setFrameSideFlag( QgsLayoutItemMapGrid::FrameSideFlag flag, bool on = true );
%Docstring
Sets whether the grid frame is drawn for a certain side of the map item.
:param flag: flag for grid frame side
:param on: set to true to draw grid frame on that side of the map
.. seealso:: :py:func:`setFrameSideFlags`
.. seealso:: :py:func:`frameSideFlags`
.. seealso:: :py:func:`testFrameSideFlag`
%End
QgsLayoutItemMapGrid::FrameSideFlags frameSideFlags() const;
%Docstring
Returns the flags which control which sides of the map item the grid frame
is drawn on.
.. seealso:: :py:func:`setFrameSideFlags`
.. seealso:: :py:func:`setFrameSideFlag`
.. seealso:: :py:func:`testFrameSideFlag`
%End
bool testFrameSideFlag( FrameSideFlag flag ) const;
%Docstring
Tests whether the grid frame should be drawn on a specified side of the map
item.
:param flag: flag for grid frame side
:return: true if grid frame should be drawn for that side of the map
.. seealso:: :py:func:`setFrameSideFlags`
.. seealso:: :py:func:`setFrameSideFlag`
.. seealso:: :py:func:`frameSideFlags`
%End
void setFrameWidth( const double width );
%Docstring
Sets the grid frame ``width`` (in layout units). This property controls how wide the grid frame is.
The size of the line outlines drawn in the frame is controlled through the
setFramePenSize method.
.. seealso:: :py:func:`frameWidth`
%End
double frameWidth() const;
%Docstring
Gets the grid frame width in layout units. This property controls how wide the grid frame is.
The size of the line outlines drawn in the frame can be retrieved via the
framePenSize method.
.. seealso:: :py:func:`setFrameWidth`
%End
void setGridFrameMargin( const double margin );
%Docstring
Sets the grid frame margin (in layout units).
This property controls distance between the map frame and the grid frame.
.. seealso:: :py:func:`gridFrameMargin`
.. versionadded:: 3.6
%End
double gridFrameMargin() const;
%Docstring
Sets the grid frame Margin (in layout units).
This property controls distance between the map frame and the grid frame.
.. seealso:: :py:func:`setGridFrameMargin`
.. versionadded:: 3.6
%End
void setFramePenSize( const double width );
%Docstring
Sets the ``width`` of the stroke drawn in the grid frame.
.. seealso:: :py:func:`framePenSize`
.. seealso:: :py:func:`setFramePenColor`
%End
double framePenSize() const;
%Docstring
Retrieves the width of the stroke drawn in the grid frame.
.. seealso:: :py:func:`setFramePenSize`
.. seealso:: :py:func:`framePenColor`
%End
void setFramePenColor( const QColor &color );
%Docstring
Sets the ``color`` of the stroke drawn in the grid frame.
.. seealso:: :py:func:`framePenColor`
.. seealso:: :py:func:`setFramePenSize`
.. seealso:: :py:func:`setFrameFillColor1`
.. seealso:: :py:func:`setFrameFillColor2`
%End
QColor framePenColor() const;
%Docstring
Retrieves the color of the stroke drawn in the grid frame.
.. seealso:: :py:func:`setFramePenColor`
.. seealso:: :py:func:`framePenSize`
.. seealso:: :py:func:`frameFillColor1`
.. seealso:: :py:func:`frameFillColor2`
%End
void setFrameFillColor1( const QColor &color );
%Docstring
Sets the first fill ``color`` used for the grid frame.
.. seealso:: :py:func:`frameFillColor1`
.. seealso:: :py:func:`setFramePenColor`
.. seealso:: :py:func:`setFrameFillColor2`
%End
QColor frameFillColor1() const;
%Docstring
Retrieves the first fill color for the grid frame.
.. seealso:: :py:func:`setFrameFillColor1`
.. seealso:: :py:func:`framePenColor`
.. seealso:: :py:func:`frameFillColor2`
%End
void setFrameFillColor2( const QColor &color );
%Docstring
Sets the second fill ``color`` used for the grid frame.
.. seealso:: :py:func:`frameFillColor2`
.. seealso:: :py:func:`setFramePenColor`
.. seealso:: :py:func:`setFrameFillColor1`
%End
QColor frameFillColor2() const;
%Docstring
Retrieves the second fill color for the grid frame.
.. seealso:: :py:func:`setFrameFillColor2`
.. seealso:: :py:func:`framePenColor`
.. seealso:: :py:func:`frameFillColor1`
%End
virtual QgsExpressionContext createExpressionContext() const;
public:
};
QFlags<QgsLayoutItemMapGrid::FrameSideFlag> operator|(QgsLayoutItemMapGrid::FrameSideFlag f1, QFlags<QgsLayoutItemMapGrid::FrameSideFlag> f2);
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemmapgrid.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/