Review Request: Proposal to add a 'lock toggle button' to filter bar to prevent clearing of filter when navigating to a different folder

Tue Dec 11 06:53:53 GMT 2012

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/107392/#review23299
-----------------------------------------------------------

Thanks for the new patch! I've added some comments on the code below.

About the icon: I don't know what kind of icon would be best, maybe the usability team can comment on that (and on my earlier general question if the button has the potential to confuse users).

dolphin/src/dolphinmainwindow.h
<http://git.reviewboard.kde.org/r/107392/#comment17923>

    I guess the main reason for doing any changes in DolphinMainWindow at all is to have a configurable keyboard shortcut? To be honest, I'm not quite sure if we really need one. The patch would be a lot less intrusive without it.

dolphin/src/dolphinmainwindow.h
<http://git.reviewboard.kde.org/r/107392/#comment17914>

    Trailing white space

dolphin/src/dolphinmainwindow.cpp
<http://git.reviewboard.kde.org/r/107392/#comment17924>

    Space behind 'if'.

dolphin/src/dolphinviewcontainer.h
<http://git.reviewboard.kde.org/r/107392/#comment17919>

    It might be debatable how much new code is required for a copyright notice in the file. I think a single line is most certainly not. I would suggest to only add a new copyright notice in filterbar.* because this is where the substantial changes are.

dolphin/src/filterbar/filterbar.h
<http://git.reviewboard.kde.org/r/107392/#comment17920>

    slotUrlChanged() would be more consistent with the naming of other slots.

dolphin/src/filterbar/filterbar.h
<http://git.reviewboard.kde.org/r/107392/#comment17922>

    toggleLockText() is sufficient IMHO. No need to repeat the class name inside the slot name.

dolphin/src/filterbar/filterbar.h
<http://git.reviewboard.kde.org/r/107392/#comment17921>

    Maybe slotToggleLockButton ?

dolphin/src/filterbar/filterbar.cpp
<http://git.reviewboard.kde.org/r/107392/#comment17915>

    I wonder if we really need a full blown tool bar here.

    No spaces after '(' and before ')'. Also in many other places, I won't point out all of them here.

dolphin/src/filterbar/filterbar.cpp
<http://git.reviewboard.kde.org/r/107392/#comment17916>

    Use QString() to create an empty string.

dolphin/src/filterbar/filterbar.cpp
<http://git.reviewboard.kde.org/r/107392/#comment17917>

    Add a space after ' '.

dolphin/src/filterbar/filterbar.cpp
<http://git.reviewboard.kde.org/r/107392/#comment17918>

    Identation is 4 spaces (here and in other places).

- Frank Reininghaus

On Dec. 7, 2012, 3:58 a.m., Stuart Citrin wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/107392/
> -----------------------------------------------------------
> 
> (Updated Dec. 7, 2012, 3:58 a.m.)
> 
> 
> Review request for Dolphin and KDE Usability.
> 
> 
> Description
> -------
> 
> I wrote a quick add-on for the Dolphin filter bar.   It is a button which prevents the filter text from clearing when navigating to a different folder. 
> 
> Why this might be needed:
> 
> This is an attempt to resolve the following usability conflict: 
> 
> If one navigates to a different folder, the filter is automatically cleared since one does not want a situation where someone forgets a filter is applied and then doesn't understand why all the files within a folder are not appearing.(current behavior) 
> versus: 
> A user might want to keep a filter while navigating an arbitrary set of folders, but is unable to, since the filter is automatically cleared upon navigation 
> 
> The implementation to try to resolve this conflict is as follows: 
> 
> 1. A lock filter toggle button is added to the right side of the filter bar. 
> 2. If the lock filter button is clicked(on), then if the user navigates away from the current folder, the filter is not cleared. If the lock filter button is released(off), then the text is cleared on navigation...which is the current behavior. 
> 3. A configurable shortcut is added to toggle the lock filter button, with the default being Ctrl-Shift-I (since the default shortcut for hiding and showing the filter bar is Ctrl-I.) 
> 4. If the user toggles the lock filter button to released (off), then the text in the filter also clears. The assumption here is that if the user no longer wants the text to be locked, he probably also wants to clear the text.
>  5. When the filter bar is hidden, then the lock filter button is released. The next time the filter bar is shown, the lock filter button will be in the released(off) position and the filter text will have been cleared. 
> 6. At application startup, the lock filter button is always off, and the filter bar text cleared. 
> 
> This also fixes a current bug in dolphin where one is unable to toggle the visibility of the filter bar using the tool bar filter button, or by using the assigned hot key.
> 
> Note... I think it is 'patch -p2' from the "dolphin" directory (above src directory ) to apply the patch
> 
> 
> Diffs
> -----
> 
>   dolphin/src/dolphinmainwindow.h 7da5801 
>   dolphin/src/dolphinmainwindow.cpp 11e03d0 
>   dolphin/src/dolphinviewcontainer.h 0300273 
>   dolphin/src/dolphinviewcontainer.cpp 6e99437 
>   dolphin/src/filterbar/filterbar.h 9546c63 
>   dolphin/src/filterbar/filterbar.cpp f3076f0 
> 
> Diff: http://git.reviewboard.kde.org/r/107392/diff/
> 
> 
> Testing
> -------
> 
> Went through all paths in dolphin.  Tested: 1. Navigate to different folder. Text should clear only when text not locked
> 2.Ctl-I shortcut to toggle visiblility of filterbar
> 3.Text clears when filterbar hidden and then shown
> 4. Lock button locks and unlocks text
> 5. Shift-Ctl-I shortcut to toggle lock status of text.  Lock button updates appropriately
> 6. Status (with non-perisistence from previous instance) of lock button when starting application..i.e. lock status is off on startup
> 7. Change keyboard shortcuts...works appropriately
> 8. F3 and split view..tabs..etc.. should still work appropriately
> 9. Monkey tested...cannot get it to crash
> etc....
> 
> 
> Screenshots
> -----------
> 
> Filter bar with new text locking button
>   http://git.reviewboard.kde.org/r/107392/s/877/
> 
> 
> Thanks,
> 
> Stuart Citrin
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.kde.org/mailman/private/kfm-devel/attachments/20121211/ba2cff2a/attachment.htm>