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

[Stuart Citrin]

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

(Updated Dec. 7, 2012, 3:54 a.m.)


Review request for Dolphin.


Changes
-------

1. New patch file has been uploaded. (This is new total patch, not a patch to a patch).  It contains the following modifications:
    a. Requested coding style changes have been done
    b. The changes which reverted the 'show filter' button behavior have been ripped out, so that behavior is now back to the current...the show filter button is again not a toggle,  but a button to show the filter bar if hidden,  and to place the focus on the filterbar... (and the same for the (if defaulted) ctrl-i hot key). Therefore, the patch only does one thing.. it adds a button and hot key to lock the filter text when navigating to another folder.

2. To address the 'what does that button do' issue I recreated some new icons, packaged in provided file PinPngOxygenIcons.tar. These are just thumbtack icons and were generated by using a public domain image of a thumbtack and Sync interpolating the original image down to the provided sizes using GIMP,( and adjusting color somewhat).  If for some reason they are unacceptable, and this goes,  then whoever does Oxygen icons will need to draw something along the lines. (I can change color, contrast etc...but I (honestly) cannot free hand draw). The modified app needs the icon to render properly (or otherwise, I believe, you will get an 'X' icon drawn for the button.....I didn't try it without the icons loaded ).

3. Screen shot of the filterbar with the new button and the tool tip text is provided. 


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 (updated)
-----

  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 (updated)
-----------

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/20121207/b41edc56/attachment.htm>