[Qgis-developer] Request for API change [will merge if ni claim before Aug. 26th]

[Tim Sutton]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Denis

On 19/08/2014 15:19, Denis Rouzaud wrote:
> Hi all,
> 
> With Matthias' work on the new edit widgets, we have some wrappers
> that allow using some Qt widgets as edit widgets but also some
> custom widgets (relation reference, color button, etc.).
> 
> At first, the wrapper classes were named as widgets (e.g. 
> QgsColorWidget). But these are not really the widgets. This brings
> some confusion and some naming conflicts:
> 
> 1. QgsColorWidget inherits from QgsEditorWidgetWrapper. It should
> be named according to its functionnality.
> 
> 2. We have a naming conflict: if we create a class for the widget,
> we can't name it properly as the name Widget is already taken.
> 
> Hence, I proposed [0] to rename the widgets to wrappers.
> 
> This breaks C++ API but not Python since widgets/wrappers are not 
> available yet. This code was brought in 2.4.
> 
> I am quite sure nobody used this part of the API. I know API should
> not be changed, and if we start making exception if can be a mess.
> But considering that: * it's a very narrow part of the code * that
> it's not available in python * it improves the readability * it
> will avoid naming problems in the future
> 
> I am asking for this change. If nobody claims something before
> August 26th, the pull request [0] will be merged.

Your changes seem fine to me, but no doubt someone will complain when
we break API....could you at least add a changelog entry notifying of
what the API incompatibilities are?

Regards

Tim

> 
> 
> Greetings,
> 
> Denis
> 
> [0] https://github.com/qgis/QGIS/pull/1545 
> _______________________________________________ Qgis-developer
> mailing list Qgis-developer at lists.osgeo.org 
> http://lists.osgeo.org/mailman/listinfo/qgis-developer

- -- 
-
------------------------------------------------------------------------------------------
Tim Sutton
Visit http://kartoza.com <http://kartoza.com/>to find out about open
source:
* Desktop GIS programming services
* Geospatial web development
* GIS Training
* Consulting Services
Skype: timlinux
-
-------------------------------------------------------------------------------------------
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iEYEARECAAYFAlP6V2UACgkQqk07qZdiYjfpTACbB0SjaWIba9d2+uHC+Gb5mwkj
iZIAn0dGuX3qGohfhzdXCovkk1o53Ic0
=EftE
-----END PGP SIGNATURE-----