Cad floater #59

m-kuhn · 2019-05-13T07:02:53Z

Description

Include a few sentences describing the overall goals for this PR (pull request). If applicable also add screenshots.

Checklist

Reviewing is a process done by project maintainers, mostly on a volunteer basis. We try to keep the overhead as small as possible and appreciate if you help us to do so by completing the following items. Feel free to ask in a comment if you have troubles with any of them.

Commit messages are descriptive and explain the rationale for changes
Commits which fix bugs include fixes #11111 in the commit message next to the description
Commits which add new features are tagged with [FEATURE] in the commit message
Commits which change the UI or existing user workflows are tagged with [needs-docs] in the commit message and contain sufficient information in the commit message to be documented
I have read the QGIS Coding Standards and this PR complies with them
This PR passes all existing unit tests (test results will be reported by travis-ci after opening this PR)
New unit tests have been added for core changes
I have run the scripts/prepare-commit.sh script before each commit

m-kuhn · 2019-05-13T07:06:29Z

src/ui/qgsadvanceddigitizingfloaterbase.ui

+     </property>
+     <property name="font">
+      <font>
+       <pointsize>8</pointsize>


The distance is the only lineedit with a fixed size, which results in a smaller font size here (hidpi screen) than the other floaters.

Has that been changed?

Yes in d65e63f

Isn't 8 very small (smaller than the rest of the fonts)? I'm a bit afraid for visually impaired users.

Here (non-hidpi screen) it's actually the default it seems ? I'll remove the setting so it would display at the same size than other UI elements on all setups, and adapt with font size setting (in QGIS settings).

m-kuhn · 2019-05-13T07:08:20Z

src/gui/qgsadvanceddigitizingfloater.h

+
+    /**
+    * move the widget
+      * \param pos position of the cursor


Watch out for asterisk indentation

/** * Text * \note ... */

Also, it's often nice to just specify parameters inline Move the widget to the cursor \a position..

m-kuhn · 2019-05-13T07:08:49Z

src/gui/qgsadvanceddigitizingfloater.h

+
+  private slots:
+
+    void changeX( QString text );


QString as parameter should (almost?) always be const QString &text.

Ok, I guess this also applies to updatePos( QPoint pos ) ?

m-kuhn · 2019-05-13T07:09:40Z

src/gui/qgsadvanceddigitizingfloater.h

+    *
+    * \param active
+    */
+    void setActive( bool active );


I think that's never used as a slot (only directly called). Just make it a public method

I'll refactor this a little bit (remove the toggleFloater function, and connect the action directly to floater::setActive). I think it's a bit cleaner (e.g. the settings to store the floater's visibility are now read/written in the floater class).

m-kuhn · 2019-05-13T07:10:42Z

src/gui/qgsadvanceddigitizingfloater.h

+
+    /**
+    * Whether the floater is active or not.
+    * Note that the floater may be active but not visible (e.g. if the mouse is not over the canvas).


Add \since QGIS 3.8 to all new public methods (on [GUI|CORE|ANALYSIS]_EXPORTclasses

m-kuhn · 2019-05-13T07:16:31Z

Hi @olivierdalang I opened a PR here for an off the record pre-review.

It's looking really good, I like it a lot!

There seem to be a couple of smaller issues (font-size of distance, fixed line-edit size clipping some text on long numbers)

Apart from that, there are a couple of minor code formatting issues for which I have left comments too.

m-kuhn · 2019-05-13T07:17:36Z

src/gui/qgsadvanceddigitizingdockwidget.h

+    * Could be used by widgets that must reflect the current advanced digitizing state.
+    *
+    * \param locked Whether the parameter is locked or not.
+    */


Doc strings always apply to a single method, so this needs to be copied to every of the 4 methods of the block below. (It's for the generated C++ and Python API docs).

Ok. It seems doxygen supports one docstring for multiple fcuntions (https://stackoverflow.com/a/37286334) but it doesn't seem used in QGIS... Would make the code more readable IMO.

Looks nice.
But it would need some (non trivial) update to sipify (the sip code generator) too. I'm not sure you want to start going down that hole ;)

Ok, copies the docstring to all methods

m-kuhn · 2019-05-13T07:18:17Z

src/gui/qgsadvanceddigitizingdockwidget.h

@@ -399,6 +472,9 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private
     */
    void activateCad( bool enabled );

+    //! enable/disable floater
+    void toggleFloater( bool enabled );


I'd call that setFloaterEnabled, toggle sounds like it will turn if on and off if called repeatedly without paramter.

removed this method (small refactoring mentionned above)

m-kuhn · 2019-05-13T07:19:54Z

src/gui/qgsadvanceddigitizingdockwidget.cpp

 void QgsAdvancedDigitizingDockWidget::hideEvent( QHideEvent * )
 {
  // disable CAD but do not unset map event filter
  // so it will be reactivated whenever the map tool is show again
-  setCadEnabled( false );
+  // TODO : remove this (we don't want to disable CAD events, even when the dockerwidget is hidden)


What's this TODO exactly?

Removed the whole hideEvent function, since we don't want anymore to disable cad when the dockwidget is closed

m-kuhn · 2019-05-13T07:20:33Z

src/gui/qgsadvanceddigitizingfloater.cpp

+{
+  if ( !locked )
+  {
+    mXLineEdit->setStyleSheet( "" );


Almost always: "" -> QString()

m-kuhn · 2019-05-13T07:21:02Z

src/gui/qgsadvanceddigitizingfloater.cpp

+  }
+  else
+  {
+    mXLineEdit->setStyleSheet( "font-weight: bold" );


Suggested change

mXLineEdit->setStyleSheet( "font-weight: bold" );

mXLineEdit->setStyleSheet( QStringLiteral( "font-weight: bold" ) );

Also applies to the others below.

m-kuhn · 2019-05-13T07:23:38Z

src/gui/qgsadvanceddigitizingdockwidget.h

+    *
+    * \param value The current value (as a QString, as it could be an expression).
+    */
+    void setX( QString value );


I think those are all normal public functions and not used as slots (always called from lambdas).

I thought that sometimes it may be interesting for widgets to use them as slots (e.g. to connect a QEditLine::textChanged). Is there a downside to have them as slots ? Or would it be possible to later on change them as slots without breaking backwards compatilibility ?

The only downside is, that it adds a bit of overhead, so no big deal.
But on the other hand, the advantage is tiny as well: somebody might need a different signature (e.g. double as parameter), and it's very easy to trigger them with lambdas as you did.
Upgrading it to a slot when needed in the future will be trivial. Downgrading not (because it will be stable API)

Ok, changed to normal functions

olivierdalang · 2019-05-13T08:08:40Z

Great, thanks for the detailed review !

Will go through the comments, and maybe ask some questions...

olivierdalang · 2019-05-13T10:11:11Z

Ok just pushed the changes. It includes all your comments and a little bit of additionnal refactoring. I kept all commits separated to facilitate review but would of course squash before final PR.

m-kuhn · 2019-05-13T11:01:43Z

src/gui/qgsadvanceddigitizingdockwidget.h

+    * \note The value is a QString, as it could be an expression.
+    * \since QGIS 3.8
+    */
+    void setX( QString value );


Don't forget this

Suggested change

void setX( QString value );

void setX( const QString &value );

m-kuhn · 2019-05-13T11:02:05Z

src/gui/qgsadvanceddigitizingdockwidget.h

+    * Could be used by widgets that must reflect the current advanced digitizing state.
+    * \since QGIS 3.8
+    */
+    void valueXChanged( QString value );


Here too

Suggested change

void valueXChanged( QString value );

void valueXChanged( const QString &value );

m-kuhn · 2019-05-13T11:50:02Z

src/gui/qgsadvanceddigitizingdockwidget.h

+    * Could be used by widgets to capture the focus when a field is being edited.
+    * \since QGIS 3.8
+    */
+    void focusOnY();


Just an idea: should this be called focusOnYRequested to make it unambiguously clear that it's a signal (currently the name itself could be interpreted as an imperative method).

Yes that's better, will do the change

m-kuhn · 2019-05-13T11:53:14Z

Looking good (just one additional comment I left as consideration)
I would say let's squash and pull request.
Thanks!

olivierdalang · 2019-05-13T11:56:55Z

Great, I'll open the PR then. I forgot to ask for last PR : is there any place where I should mark these contributions as sponsored by the client and/or in partnership with OpenGIS ? And should I mark you as co-author of the commit ?

m-kuhn · 2019-05-13T11:58:27Z

Good question.
Something like "Sponsored by Kanton Schaffhausen in collaboration with OPENGIS.ch" would be nice indeed.

olivierdalang · 2019-05-13T12:33:28Z

PR here : qgis#9988 (I created another branch for the squash)

olivierdalang added 9 commits May 8, 2019 14:03

[cad] floater initial implementation

e8e7f5a

hide unused labels

6dd0b78

implementation with signals/slots

dc5d51a

docstrings & cleanup

90a89d8

astyle

ae3972e

show delta in floater

b53bb91

fix toggle floater button not disabled

889ffc6

icon

b027ef7

prepare-commit

551eb6b

m-kuhn commented May 13, 2019

View reviewed changes

fix display on hidpi

d65e63f

olivierdalang added 7 commits May 13, 2019 10:29

fix comment

ca87869

pass arguments by reference

af4de6e

connect directly mToggleFloaterAction to floater

7a88cdc

docstring for each function

c9ee061

add \since QGIS 3.8

7fc0787

remove now useless hideEvent

7e328f6

"" -> QString() and "x" -> QStringLiteral("x")

96ac754

olivierdalang added 4 commits May 13, 2019 11:44

added a cad enabled changed signal and cleanup hide logic

dda866e

typo

f4996ec

QgsAdvancedDigitizingDockWidget slots as normal functions

e61f20c

prepare-commit.sh

853d98b

m-kuhn commented May 13, 2019

View reviewed changes

olivierdalang added 5 commits May 13, 2019 13:17

more pass arguments by reference

211de64

fix spelling

5db4f15

fix saving of floater settings

7801580

prepare-commit.sh

f924295

use default font size

dbcc9fb

m-kuhn commented May 13, 2019

View reviewed changes

focusOnX(); -> focusOnXRequested();

199bd4d

	mXLineEdit->setStyleSheet( "font-weight: bold" );
	mXLineEdit->setStyleSheet( QStringLiteral( "font-weight: bold" ) );

	void setX( QString value );
	void setX( const QString &value );

	void valueXChanged( QString value );
	void valueXChanged( const QString &value );

Cad floater #59

Are you sure you want to change the base?

Cad floater #59

Conversation

m-kuhn commented May 13, 2019

Description

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olivierdalang May 13, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-kuhn commented May 13, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olivierdalang commented May 13, 2019

olivierdalang commented May 13, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-kuhn commented May 13, 2019

olivierdalang commented May 13, 2019

m-kuhn commented May 13, 2019

olivierdalang commented May 13, 2019

olivierdalang May 13, 2019 •

edited

Loading