sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-15 00:04:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

SIP, indentation and documentation updates

Browse Source
This commit is contained in:
Nyall Dawson 2017-09-05 09:53:48 +10:00
parent 44a8a514fa
commit a77950cbf6
9 changed files with 100 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
python/console/console_settings.py
View File

@ -30,6 +30,7 @@ from qgis.core import QgsSettings
class optionsDialog(QDialog, Ui_SettingsDialogPythonConsole):
def __init__(self, parent):
QDialog.__init__(self, parent)
self.setWindowTitle(QCoreApplication.translate(

1
python/core/core_auto.sip
View File

@ -156,7 +156,6 @@
%Include composer/qgspaperitem.sip
%Include layout/qgslayoutcontext.sip
%Include layout/qgslayoutgridsettings.sip
%Include layout/qgslayoutitemundocommand.sip
%Include layout/qgslayoutmeasurement.sip
%Include layout/qgslayoutmeasurementconverter.sip
%Include layout/qgspagesizeregistry.sip

2
python/core/layout/qgslayout.sip
View File

@ -39,8 +39,6 @@ class QgsLayout : QGraphicsScene, QgsExpressionContextGenerator, QgsLayoutUndoOb
called on the new layout.
%End
~QgsLayout();
void initializeDefaults();
%Docstring
Initializes an empty layout, e.g. by adding a default page to the layout. This should be called after creating

83
python/core/layout/qgslayoutitemundocommand.sip
View File

@ -1,83 +0,0 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemundocommand.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutItemUndoCommand: QgsAbstractLayoutUndoCommand
{
%Docstring
*************************************************************************
*
This program is free software; you can redistribute it and/or modify *
it under the terms of the GNU General Public License as published by *
the Free Software Foundation; either version 2 of the License, or *
(at your option) any later version. *
*
**************************************************************************
%End
%TypeHeaderCode
#include "qgslayoutitemundocommand.h"
%End
public:
QgsLayoutItemUndoCommand( QgsLayoutItem *item, const QString &text, int id = 0, QUndoCommand *parent /TransferThis/ = 0 );
virtual bool mergeWith( const QUndoCommand *command );
QgsLayout *layout() const;
%Docstring
:rtype: QgsLayout
%End
QString itemUuid() const;
%Docstring
:rtype: str
%End
protected:
virtual void saveState( QDomDocument &stateDoc ) const;
virtual void restoreState( QDomDocument &stateDoc );
virtual QgsLayoutItem *recreateItem( int itemType, QgsLayout *layout ) /Factory/;
%Docstring
:rtype: QgsLayoutItem
%End
};
class QgsLayoutItemDeleteUndoCommand: QgsLayoutItemUndoCommand
{
%TypeHeaderCode
#include "qgslayoutitemundocommand.h"
%End
public:
QgsLayoutItemDeleteUndoCommand( QgsLayoutItem *item, const QString &text, int id = 0, QUndoCommand *parent /TransferThis/ = 0 );
virtual bool mergeWith( const QUndoCommand *command );
virtual void redo();
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemundocommand.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/

7
python/core/layout/qgslayoutpagecollection.sip
View File

@ -231,6 +231,13 @@ class QgsLayoutPageCollection : QObject, QgsLayoutSerializableObject
:rtype: bool
%End
QgsLayoutGuideCollection &guides();
%Docstring
Returns a reference to the collection's guide collection, which manages page snap guides.
:rtype: QgsLayoutGuideCollection
%End
public slots:
void redraw();

21
python/core/layout/qgslayoutundostack.sip
View File

@ -28,8 +28,29 @@ class QgsLayoutUndoStack
%End
void beginMacro( const QString &commandText );
%Docstring
Starts a macro command, with the given descriptive ``commandText``.
Any commands added to the stack (either via direct manipulation of
stack() or via beginCommand()/endCommand() calls) between a
beginMacro() and endMacro() block are collapsed into a single
undo command, which will be applied or rolled back in a single step.
.. seealso:: endMacro()
%End
void endMacro();
%Docstring
Ends a macro command. This must be called after beginMacro(), when
all child undo commands which form part of the macro have been completed.
Any commands added to the stack (either via direct manipulation of
stack() or via beginCommand()/endCommand() calls) between a
beginMacro() and endMacro() block are collapsed into a single
undo command, which will be applied or rolled back in a single step.
.. seealso:: beginMacro()
%End
void beginCommand( QgsLayoutUndoObjectInterface *object, const QString &commandText, int id = 0 );
%Docstring

3
src/core/layout/qgslayoutitemundocommand.cpp
View File

@ -21,6 +21,7 @@
#include "qgslayout.h"
#include "qgsproject.h"
///@cond PRIVATE
QgsLayoutItemUndoCommand::QgsLayoutItemUndoCommand( QgsLayoutItem *item, const QString &text, int id, QUndoCommand *parent )
: QgsAbstractLayoutUndoCommand( text, id, parent )
, mItemUuid( item->uuid() )
@ -118,3 +119,5 @@ void QgsLayoutItemDeleteUndoCommand::redo()
layout()->removeItem( item );
item->deleteLater();
}
///@endcond

47
src/core/layout/qgslayoutitemundocommand.h
View File

@ -24,16 +24,45 @@
class QgsLayout;
class QgsLayoutItem;
SIP_NO_FILE
///@cond PRIVATE
/**
* \ingroup core
* An undo command subclass for layout item undo commands.
*
* QgsLayoutItemUndoCommand is a specific layout undo command which is
* designed for use with QgsLayoutItems. It automatically handles
* recreating a deleted item when the undo stack rolls back past
* the item deletion command.
*
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemUndoCommand: public QgsAbstractLayoutUndoCommand
{
public:
/**
* Constructor for QgsLayoutItemUndoCommand.
* \param item associated layout item
* \param text undo command descriptive text
* \param id optional undo command id, used for automatic command merging
* \param parent command
*/
QgsLayoutItemUndoCommand( QgsLayoutItem *item, const QString &text, int id = 0, QUndoCommand *parent SIP_TRANSFERTHIS = nullptr );
bool mergeWith( const QUndoCommand *command ) override;
/**
* Returns the layout associated with this command.
*/
QgsLayout *layout() const;
/**
* Returns the associated item's UUID, which uniquely identifies the item
* within the layout.
*/
QString itemUuid() const;
protected:
@ -51,15 +80,33 @@ class CORE_EXPORT QgsLayoutItemUndoCommand: public QgsAbstractLayoutUndoCommand
};
/**
* \ingroup core
* An undo command subclass for layout item deletion undo commands.
*
* QgsLayoutItemDeleteUndoCommand is a specific layout undo command which handles
* layout item deletion. When applied (e.g. as a result of a 'redo' action),
* the associated layout item is deleted and removed from the layout.
*
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemDeleteUndoCommand: public QgsLayoutItemUndoCommand
{
public:
/**
* Constructor for QgsLayoutItemDeleteUndoCommand.
* \param item associated layout item
* \param text undo command descriptive text
* \param id optional undo command id, used for automatic command merging
* \param parent command
*/
QgsLayoutItemDeleteUndoCommand( QgsLayoutItem *item, const QString &text, int id = 0, QUndoCommand *parent SIP_TRANSFERTHIS = nullptr );
bool mergeWith( const QUndoCommand *command ) override;
void redo() override;
};
///@endcond
#endif

21
src/core/layout/qgslayoutundostack.h
View File

@ -40,8 +40,29 @@ class CORE_EXPORT QgsLayoutUndoStack
*/
QgsLayoutUndoStack( QgsLayout *layout );
/**
* Starts a macro command, with the given descriptive \a commandText.
*
* Any commands added to the stack (either via direct manipulation of
* stack() or via beginCommand()/endCommand() calls) between a
* beginMacro() and endMacro() block are collapsed into a single
* undo command, which will be applied or rolled back in a single step.
*
* \see endMacro()
*/
void beginMacro( const QString &commandText );
/**
* Ends a macro command. This must be called after beginMacro(), when
* all child undo commands which form part of the macro have been completed.
*
* Any commands added to the stack (either via direct manipulation of
* stack() or via beginCommand()/endCommand() calls) between a
* beginMacro() and endMacro() block are collapsed into a single
* undo command, which will be applied or rolled back in a single step.
*
* \see beginMacro()
*/
void endMacro();
/**