Skip to content

Commit

Permalink
Fix mention of compositions in dox (#34318)
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Feb 6, 2020
1 parent 224d6bc commit d2639bc
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
Expand Up @@ -153,7 +153,7 @@ Sets the ``offset`` added to the picture's rotation from a map's North.

ResizeMode resizeMode() const;
%Docstring
Returns the resize mode used for drawing the picture within the composer
Returns the resize mode used for drawing the picture within the layout
item's frame.

.. seealso:: :py:func:`setResizeMode`
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/layout/qgslayouttable.sip.in
Expand Up @@ -22,7 +22,7 @@ typedef QVector< QgsLayoutTableColumn * > QgsLayoutTableColumns;
class QgsLayoutTableStyle
{
%Docstring
Styling option for a composer table cell
Styling option for a layout table cell

.. versionadded:: 3.0
%End
Expand Down
Expand Up @@ -199,7 +199,7 @@ Sets the sort ``rank`` for the column. If the sort rank is > 0 then the column
will be sorted in the table. The sort rank specifies the priority given to the
column when the table is sorted by multiple columns, with lower sort ranks
having higher priority. This property is only used when the column
is part of a :py:class:`QgsComposerAttributeTable`.
is part of a :py:class:`QgsLayoutItemAttributeTable`.
If the sort ``rank`` is <= 0 then the column is not being sorted.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgsproject.sip.in
Expand Up @@ -575,7 +575,7 @@ an absolute path.

QgsLayoutManager *layoutManager();
%Docstring
Returns the project's layout manager, which manages compositions within
Returns the project's layout manager, which manages print layouts, atlases and reports within
the project.

.. versionadded:: 3.0
Expand Down
2 changes: 1 addition & 1 deletion src/core/layout/qgslayoutitempicture.h
Expand Up @@ -155,7 +155,7 @@ class CORE_EXPORT QgsLayoutItemPicture: public QgsLayoutItem
void setNorthOffset( double offset );

/**
* Returns the resize mode used for drawing the picture within the composer
* Returns the resize mode used for drawing the picture within the layout
* item's frame.
* \see setResizeMode()
*/
Expand Down
2 changes: 1 addition & 1 deletion src/core/layout/qgslayoutitemscalebar.h
Expand Up @@ -514,7 +514,7 @@ class CORE_EXPORT QgsLayoutItemScaleBar: public QgsLayoutItem
//! Calculates with of a segment in mm and stores it in mSegmentMillimeters
void refreshSegmentMillimeters();

//! Returns diagonal of composer map in selected units (map units / meters / feet / nautical miles)
//! Returns diagonal of layout map in selected units (map units / meters / feet / nautical miles)
double mapWidth() const;

QgsScaleBarRenderer::ScaleBarContext createScaleContext() const;
Expand Down
4 changes: 2 additions & 2 deletions src/core/layout/qgslayouttable.h
Expand Up @@ -31,7 +31,7 @@ class QgsLayoutTableColumn;
/**
* \ingroup core
* List of QVariants, representing a the contents of a single row in
* a QgsComposerTable
* a QgsLayoutTable
* \since QGIS 3.0
*/
typedef QVector< QVariant > QgsLayoutTableRow;
Expand Down Expand Up @@ -60,7 +60,7 @@ typedef QVector< QgsLayoutTableColumn * > QgsLayoutTableColumns;
/**
* \ingroup core
* \class QgsLayoutTableStyle
* \brief Styling option for a composer table cell
* \brief Styling option for a layout table cell
* \since QGIS 3.0
*/

Expand Down
2 changes: 1 addition & 1 deletion src/core/layout/qgslayouttablecolumn.h
Expand Up @@ -173,7 +173,7 @@ class CORE_EXPORT QgsLayoutTableColumn : public QObject
* will be sorted in the table. The sort rank specifies the priority given to the
* column when the table is sorted by multiple columns, with lower sort ranks
* having higher priority. This property is only used when the column
* is part of a QgsComposerAttributeTable.
* is part of a QgsLayoutItemAttributeTable.
* If the sort \a rank is <= 0 then the column is not being sorted.
*
* \note only applicable when used in a QgsLayoutItemAttributeTable
Expand Down
4 changes: 2 additions & 2 deletions src/core/qgsproject.h
Expand Up @@ -565,15 +565,15 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
QgsRelationManager *relationManager() const;

/**
* Returns the project's layout manager, which manages compositions within
* Returns the project's layout manager, which manages print layouts, atlases and reports within
* the project.
* \note not available in Python bindings
* \since QGIS 3.0
*/
const QgsLayoutManager *layoutManager() const SIP_SKIP;

/**
* Returns the project's layout manager, which manages compositions within
* Returns the project's layout manager, which manages print layouts, atlases and reports within
* the project.
* \since QGIS 3.0
*/
Expand Down

0 comments on commit d2639bc

Please sign in to comment.