Skip to content

Commit

Permalink
Update some documentation formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
DelazJ authored and nyalldawson committed Sep 6, 2018
1 parent a84df1c commit f5bf15b
Showing 1 changed file with 26 additions and 22 deletions.
48 changes: 26 additions & 22 deletions python/gui/auto_generated/qgisinterface.sip.in
Expand Up @@ -1066,7 +1066,7 @@ Open feature form


virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0; virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0;
%Docstring %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 l: The layer for which the dialog will be created
:param f: The feature for which the dialog will be created :param f: The feature for which the dialog will be created
Expand All @@ -1077,13 +1077,13 @@ Returns a feature form for a given feature
virtual void preloadForm( const QString &uifile ) = 0; virtual void preloadForm( const QString &uifile ) = 0;
%Docstring %Docstring
This method is only needed when using a UI form with a custom widget plugin and calling 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 Python will crash bringing QGIS with it
if the custom form is not loaded from a C++ method call. 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++ 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 You only need to call this once. After that you can call openFeatureForm/getFeatureForm
like normal like usual.


More information here: http://qt-project.org/forums/viewthread/27098 More information here: http://qt-project.org/forums/viewthread/27098
%End %End
Expand Down Expand Up @@ -1140,7 +1140,7 @@ is chosen. Dialog is shown only if global option is set accordingly.
void currentLayerChanged( QgsMapLayer *layer ); void currentLayerChanged( QgsMapLayer *layer );
%Docstring %Docstring
Emitted whenever current (selected) layer changes. 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 %End


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


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


void projectRead(); void projectRead();
%Docstring %Docstring
Emitted when a project file is successfully read Emitted when a project file is successfully read.
\note
This is useful for plug-ins that store properties with project files. A .. note::
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. 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 %End


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


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


}; };
Expand Down

0 comments on commit f5bf15b

Please sign in to comment.