Skip to content
Permalink
Browse files

Update some documentation formatting

  • Loading branch information
DelazJ authored and nyalldawson committed Sep 6, 2018
1 parent a84df1c commit f5bf15bed9dc0070d568a0fb1045ee3b4ce63166
Showing with 26 additions and 22 deletions.
  1. +26 −22 python/gui/auto_generated/qgisinterface.sip.in
@@ -1066,7 +1066,7 @@ Open feature form

virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0;
%Docstring
Returns a feature form for a given feature
Returns a feature form for a given feature.

:param l: The layer for which the dialog will be created
:param f: The feature for which the dialog will be created
@@ -1077,13 +1077,13 @@ Returns a feature form for a given feature
virtual void preloadForm( const QString &uifile ) = 0;
%Docstring
This method is only needed when using a UI form with a custom widget plugin and calling
openFeatureForm or getFeatureForm from Python (PyQt4) and you haven't used the info tool first.
openFeatureForm or getFeatureForm from Python (PyQt) and you haven't used the info tool first.
Python will crash bringing QGIS with it
if the custom form is not loaded from a C++ method call.

This method uses a QTimer to call QUiLoader in order to load the form via C++
you only need to call this once after that you can call openFeatureForm/getFeatureForm
like normal
This method uses a QTimer to call QUiLoader in order to load the form via C++.
You only need to call this once. After that you can call openFeatureForm/getFeatureForm
like usual.

More information here: http://qt-project.org/forums/viewthread/27098
%End
@@ -1140,7 +1140,7 @@ is chosen. Dialog is shown only if global option is set accordingly.
void currentLayerChanged( QgsMapLayer *layer );
%Docstring
Emitted whenever current (selected) layer changes.
The pointer to layer can be null if no layer is selected
The pointer to layer can be null if no layer is selected.
%End

void currentThemeChanged( const QString &theme );
@@ -1185,34 +1185,38 @@ This signal is emitted after a layout designer window is closed.

void initializationCompleted();
%Docstring
This signal is emitted when the initialization is complete
This signal is emitted when the initialization is complete.
%End

void projectRead();
%Docstring
Emitted when a project file is successfully read
\note
This is useful for plug-ins that store properties with project files. A
plug-in can connect to this signal. When it is emitted, the plug-in
knows to then check the project properties for any relevant state.
Emitted when a project file is successfully read.

.. note::

This is useful for plugins that store properties with project files.
A plugin can connect to this signal. When it is emitted, the plugin
knows to then check the project properties for any relevant state.
%End

void newProjectCreated();
%Docstring
Emitted when starting an entirely new project
\note
This is similar to projectRead(); plug-ins might want to be notified
that they're in a new project. Yes, projectRead() could have been
overloaded to be used in the case of new projects instead. However,
it's probably more semantically correct to have an entirely separate
signal for when this happens.
Emitted when starting an entirely new project.

.. note::

This is similar to projectRead(); plugins might want to be notified
that they're in a new project. Yes, projectRead() could have been
overloaded to be used in the case of new projects instead. However,
it's probably more semantically correct to have an entirely separate
signal for when this happens.
%End

void layerSavedAs( QgsMapLayer *l, const QString &path );
%Docstring
This signal is emitted when a layer has been saved using save as
\note
added in version 2.7
This signal is emitted when a layer has been saved using save as.

.. versionadded:: 2.7
%End

};

0 comments on commit f5bf15b

Please sign in to comment.
You can’t perform that action at this time.