mirrors
/
fltk
mirror of https://github.com/fltk/fltk
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Various Fl_Tree enhancements: 

o Added keyboard navigation table
    o Added Shift-Click to extend selection, Ctrl-Space to toggle selection, Enter key toggle
    o Added protected extend_selection(from_item,to_item)
    o Cleanup of Fl_Tree::handle()
    o Limit ^A to multi-select mode only
    o Disable focus box in SELECT_NONE mode
    o test/tree: changed default mode to 'multiselect' (most often needs testing)



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@9385 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Greg Ercolano 2012-04-23 16:31:51 +00:00
parent fd9f4e6132
commit d07ef80207
4 changed files with 190 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
FL/Fl_Tree.H
View File

@ -179,6 +179,78 @@
/// \image html tree-elements.png
/// \image latex tree-elements.png "Fl_Tree dimensions" width=6cm
///
/// The following table lists keyboard bindings for navigating the tree:
///
/// <TABLE BORDER="1" SUMMARY="Fl_Tree keyboard bindings.">
/// <CAPTION ALIGN=TOP>Fl_Tree keyboard bindings.</CAPTION>
/// <TR>
/// <TD WIDTH=25% ALIGN=CENTER><B>Keyboard</B></TD>
/// <TD WIDTH=25% ALIGN=CENTER><B>FL_TREE_SELECT_MULTI</B></TD>
/// <TD WIDTH=25% ALIGN=CENTER><B>FL_TREE_SELECT_SINGLE</B></TD>
/// <TD WIDTH=25% ALIGN=CENTER><B>FL_TREE_SELECT_NONE</B></TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Ctrl-A</B> (Linux/Windows)<BR><B>Command-A</B> (Mac)</TD>
/// <TD ALIGN=CENTER>Select all items.</TD>
/// <TD ALIGN=CENTER>N/A</TD>
/// <TD ALIGN=CENTER>N/A</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Space </B></TD>
/// <TD ALIGN=CENTER>Selects item.</TD>
/// <TD ALIGN=CENTER>Selects item.</TD>
/// <TD ALIGN=CENTER>N/A</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Ctrl-Space </B></TD>
/// <TD ALIGN=CENTER>Toggle item.</TD>
/// <TD ALIGN=CENTER>Toggle item.</TD>
/// <TD ALIGN=CENTER>N/A</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Shift-Space </B></TD>
/// <TD ALIGN=CENTER>Extends selection<BR>from last item.</TD>
/// <TD ALIGN=CENTER>Selects item.</TD>
/// <TD ALIGN=CENTER>N/A</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Enter,<BR>Ctrl-Enter,<BR>Shift-Enter </B></TD>
/// <TD ALIGN=CENTER>Toggles open/close</TD>
/// <TD ALIGN=CENTER>Toggles open/close</TD>
/// <TD ALIGN=CENTER>Toggles open/close</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Right / Left</B></TD>
/// <TD ALIGN=CENTER>Open/Close item.</TD>
/// <TD ALIGN=CENTER>Open/Close item.</TD>
/// <TD ALIGN=CENTER>Open/Close item.</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Up / Down</B></TD>
/// <TD ALIGN=CENTER>Move focus box up/down.</TD>
/// <TD ALIGN=CENTER>Move focus box up/down.</TD>
/// <TD ALIGN=CENTER>N/A</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Shift-Up / Shift-Down</B></TD>
/// <TD ALIGN=CENTER>Extend selection up/down.</TD>
/// <TD ALIGN=CENTER>Move focus up/down.</TD>
/// <TD ALIGN=CENTER>N/A</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>Home / End</B></TD>
/// <TD ALIGN=CENTER>Move to top/bottom of tree.</TD>
/// <TD ALIGN=CENTER>Move to top/bottom of tree.</TD>
/// <TD ALIGN=CENTER>Move to top/bottom of tree.</TD>
///
/// </TR><TR>
/// <TD ALIGN=CENTER><B>PageUp / PageDown</B></TD>
/// <TD ALIGN=CENTER>Page up/down.</TD>
/// <TD ALIGN=CENTER>Page up/down.</TD>
/// <TD ALIGN=CENTER>Page up/down.</TD>
///
/// </TD></TR></TABLE>
///
/// \enum Fl_Tree_Reason
/// The reason the callback was invoked.
@ -216,6 +288,7 @@ protected:
void item_clicked(Fl_Tree_Item* val);
void do_callback_for_item(Fl_Tree_Item* item, Fl_Tree_Reason reason);
Fl_Tree_Item *next_visible_item(Fl_Tree_Item *start, int dir);
void extend_selection(Fl_Tree_Item *from, Fl_Tree_Item *to);
public:
Fl_Tree(int X, int Y, int W, int H, const char *L=0);

171
src/Fl_Tree.cxx
View File

@ -122,10 +122,38 @@ Fl_Tree::~Fl_Tree() {
if ( _root ) { delete _root; _root = 0; }
}
/// Extend a selection between 'from' and 'to'.
/// Used by SHIFT-click to extend a selection between two items inclusive.
///
void Fl_Tree::extend_selection(Fl_Tree_Item *from, Fl_Tree_Item *to) {
char on = 0;
if ( from == to ) {
from->select();
return;
}
for ( Fl_Tree_Item *item = first(); item; item = next(item) ) {
if ( (item == from) || (item == to) ) {
item->select(); // inclusive
on ^= 1;
} else if ( on ) {
item->select();
}
}
}
/// Standard FLTK event handler for this widget.
int Fl_Tree::handle(int e) {
if (e == FL_NO_EVENT) return(0); // XXX: optimize to prevent slow resizes on large trees!
int ret = 0;
char is_shift = Fl::event_state() & FL_SHIFT ? 1 : 0;
char is_ctrl = Fl::event_state() & FL_CTRL ? 1 : 0;
char is_command = Fl::event_state() & FL_COMMAND ? 1 : 0; // ctrl on win/lin, 'Command' on mac
#if FLTK_ABI_VERSION >= 10302
// NEW: data inside Fl_Tree
#else
// OLD:
static Fl_Tree_Item *_lastselect = 0;
#endif
// Developer note: Fl_Browser_::handle() used for reference here..
// #include <FL/names.h> // for event debugging
// fprintf(stderr, "DEBUG: %s (%d)\n", fl_eventnames[e], e);
@ -139,11 +167,8 @@ int Fl_Tree::handle(int e) {
if ( ! _item_focus ) { // no focus established yet?
switch (Fl::event_key()) { // determine if focus was navigated..
case FL_Tab: { // received focus via TAB?
if ( Fl::event_state(FL_SHIFT) ) { // SHIFT-TAB similar to FL_Up
set_item_focus(next_visible_item(0, FL_Up));
} else { // TAB similar to FL_Down
set_item_focus(next_visible_item(0, FL_Down));
}
int updown = is_shift ? FL_Up : FL_Down; // SHIFT-TAB similar to Up, TAB similar to Down
set_item_focus(next_visible_item(0, updown));
break;
}
case FL_Left: // received focus via LEFT or UP?
@ -175,31 +200,39 @@ int Fl_Tree::handle(int e) {
if ( _item_focus ) {
int ekey = Fl::event_key();
switch (ekey) {
case FL_Enter: // ENTER: selects current item only
case FL_KP_Enter:
if ( when() & ~FL_WHEN_ENTER_KEY) {
select_only(_item_focus, when());
show_item(_item_focus); // STR #2426
return(1);
}
case FL_Enter: // ENTER: toggle open/close
case FL_KP_Enter: {
open_toggle(_item_focus, when());
break;
case ' ': // toggle selection state
}
case ' ': // SPACE: change selection state
switch ( _prefs.selectmode() ) {
case FL_TREE_SELECT_NONE:
break;
case FL_TREE_SELECT_SINGLE:
if ( ! _item_focus->is_selected() ) // not selected?
select_only(_item_focus, when()); // select only this
else
deselect_all(0, when()); // select nothing
break;
if ( is_ctrl ) { // CTRL-SPACE: (single mode) toggle
if ( ! _item_focus->is_selected() ) {
select_only(_item_focus, when());
} else {
deselect_all(0, when());
}
} else {
select_only(_item_focus, when()); // SPACE: (single mode) select only
}
_lastselect = _item_focus;
return(1);
case FL_TREE_SELECT_MULTI:
select_toggle(_item_focus, when());
break;
if ( is_ctrl ) {
select_toggle(_item_focus, when()); // CTRL-SPACE: (multi mode) toggle selection
} else {
select(_item_focus, when()); // SPACE: (multi-mode) select
}
_lastselect = _item_focus;
return(1);
}
break;
case FL_Right: // open children (if any)
case FL_Left: { // close children (if any)
case FL_Right: // RIGHT: open children (if any)
case FL_Left: { // LEFT: close children (if any)
if ( _item_focus ) {
if ( ekey == FL_Right && _item_focus->is_close() ) {
// Open closed item
@ -216,8 +249,8 @@ int Fl_Tree::handle(int e) {
}
break;
}
case FL_Up: // next item up
case FL_Down: { // next item down
case FL_Up: // UP: next item up, or extend selection up
case FL_Down: { // DOWN: next item down, or extend selection down
set_item_focus(next_visible_item(_item_focus, ekey)); // next item up|dn
if ( _item_focus ) { // item in focus?
// Autoscroll
@ -227,9 +260,10 @@ int Fl_Tree::handle(int e) {
if ( itembot > y()+h() ) { show_item_bottom(_item_focus); }
// Extend selection
if ( _prefs.selectmode() == FL_TREE_SELECT_MULTI && // multiselect on?
(Fl::event_state() & FL_SHIFT) && // shift key?
is_shift && // shift key?
! _item_focus->is_selected() ) { // not already selected?
select(_item_focus, when()); // extend selection..
_lastselect = _item_focus;
}
return(1);
}
@ -237,10 +271,18 @@ int Fl_Tree::handle(int e) {
}
case 'a':
case 'A': {
if ( Fl::event_state() & FL_CTRL ) {
select_all();
take_focus();
return(1);
if ( is_command ) { // ^A (win/linux), Meta-A (mac)
switch ( _prefs.selectmode() ) {
case FL_TREE_SELECT_NONE:
case FL_TREE_SELECT_SINGLE:
break;
case FL_TREE_SELECT_MULTI:
// Do a 'select all'
select_all();
_lastselect = first();
take_focus();
return(1);
}
}
break;
}
@ -258,22 +300,16 @@ int Fl_Tree::handle(int e) {
// Handle events the child FLTK widgets didn't need
#if FLTK_ABI_VERSION >= 10302
// NEW: data inside Fl_Tree
#else
// OLD:
static Fl_Tree_Item *_lastselect = 0;
#endif
// fprintf(stderr, "ERCODEBUG: Fl_Tree::handle(): Event was %s (%d)\n", fl_eventnames[e], e); // DEBUGGING
// fprintf(stderr, "Fl_Tree::handle(): Event was %s (%d)\n", fl_eventnames[e], e); // DEBUGGING
if ( ! _root ) return(ret);
switch ( e ) {
case FL_PUSH: { // clicked on tree
if (Fl::visible_focus() && handle(FL_FOCUS)) {
Fl::focus(this);
}
_lastselect = 0;
Fl_Tree_Item *o = _root->find_clicked(_prefs);
if ( !o ) { // clicked, but not on an item?
// Not extending a selection? zero lastselect
Fl_Tree_Item *item = _root->find_clicked(_prefs);
if ( !item ) { // clicked, but not on an item?
switch ( _prefs.selectmode() ) {
case FL_TREE_SELECT_NONE:
break;
@ -284,31 +320,35 @@ int Fl_Tree::handle(int e) {
}
break;
}
set_item_focus(o); // becomes new focus widget
set_item_focus(item); // becomes new focus widget
redraw();
ret |= 1; // handled
if ( Fl::event_button() == FL_LEFT_MOUSE ) {
if ( o->event_on_collapse_icon(_prefs) ) { // collapse icon clicked?
open_toggle(o);
} else if ( o->event_on_label(_prefs) && // label clicked?
(!o->widget() || !Fl::event_inside(o->widget())) && // not inside widget
if ( item->event_on_collapse_icon(_prefs) ) { // collapse icon clicked?
open_toggle(item);
} else if ( item->event_on_label(_prefs) && // label clicked?
(!item->widget() || !Fl::event_inside(item->widget())) && // not inside widget
(!_vscroll->visible() || !Fl::event_inside(_vscroll)) ) { // not on scroller
switch ( _prefs.selectmode() ) {
case FL_TREE_SELECT_NONE:
break;
case FL_TREE_SELECT_SINGLE:
select_only(o, when());
select_only(item, when());
_lastselect = item;
break;
case FL_TREE_SELECT_MULTI: {
if ( Fl::event_state() & FL_SHIFT ) { // SHIFT+PUSH?
select(o); // add to selection
} else if ( Fl::event_state() & FL_CTRL ) { // CTRL+PUSH?
select_toggle(o, when()); // toggle selection state
_lastselect = o; // save toggled item (prevent oscillation)
if ( is_shift ) { // SHIFT+PUSH?
if ( _lastselect ) {
extend_selection(_lastselect, item);
} else {
select(item); // add to selection
}
} else if ( is_ctrl ) { // CTRL+PUSH?
select_toggle(item, when()); // toggle selection state
} else {
select_only(o, when());
select_only(item, when());
}
_lastselect = item;
break;
}
}
@ -329,29 +369,32 @@ int Fl_Tree::handle(int e) {
vposition(p);
}
if ( Fl::event_button() != FL_LEFT_MOUSE ) break;
Fl_Tree_Item *o = _root->find_clicked(_prefs);
if ( ! o ) break;
set_item_focus(o); // becomes new focus widget
Fl_Tree_Item *item = _root->find_clicked(_prefs);
if ( ! item ) break;
set_item_focus(item); // becomes new focus widget
redraw();
ret |= 1;
// Item's label clicked?
if ( o->event_on_label(_prefs) &&
(!o->widget() || !Fl::event_inside(o->widget())) &&
if ( item->event_on_label(_prefs) &&
(!item->widget() || !Fl::event_inside(item->widget())) &&
(!_vscroll->visible() || !Fl::event_inside(_vscroll)) ) {
// Handle selection behavior
switch ( _prefs.selectmode() ) {
case FL_TREE_SELECT_NONE: break; // no selection changes
case FL_TREE_SELECT_NONE:
break; // no selection changes
case FL_TREE_SELECT_SINGLE:
select_only(o, when());
select_only(item, when());
_lastselect = item;
break;
case FL_TREE_SELECT_MULTI:
if ( Fl::event_state() & FL_CTRL && // CTRL-DRAG: toggle?
_lastselect != o ) { // not already toggled from last microdrag?
select_toggle(o, when()); // toggle selection
_lastselect = o; // save we toggled it (prevents oscillation)
if ( is_ctrl ) { // CTRL-DRAG: toggle?
if ( _lastselect != item ) { // not already toggled from last microdrag?
select_toggle(item, when()); // toggle selection
}
} else {
select(o); // select this
select(item); // select this
}
_lastselect = item;
break;
}
}

5
src/Fl_Tree_Item.cxx
View File

@ -733,7 +733,10 @@ void Fl_Tree_Item::draw(int X, int &Y, int W, Fl_Widget *tree,
widget()->draw();
}
// Draw focus box around item's bg last
if ( this == itemfocus && Fl::visible_focus() && Fl::focus() == tree) {
if ( this == itemfocus &&
Fl::visible_focus() &&
Fl::focus() == tree &&
prefs.selectmode() != FL_TREE_SELECT_NONE ) {
draw_item_focus(FL_NO_BOX,bg,bg_x+1,bg_y+1,bg_w-1,bg_h-1);
}
} // end drawthis

12
test/tree.fl
View File

@ -473,7 +473,7 @@ switch ( collapseicons_chooser->value() ) {
case 2:
tree->showcollapse(0);
break;
}} selected
}}
tooltip {Tests Fl_Tree::openicon() and Fl_Tree::closeicon()} xywh {485 201 140 21} down_box BORDER_BOX labelsize 12 textsize 11
} {
MenuItem {} {
@ -496,7 +496,7 @@ switch ( connectorstyle_chooser->value() ) {
case 0: tree->connectorstyle(FL_TREE_CONNECTOR_NONE); break;
case 1: tree->connectorstyle(FL_TREE_CONNECTOR_DOTTED); break;
case 2: tree->connectorstyle(FL_TREE_CONNECTOR_SOLID); break;
}} selected
}}
tooltip {Tests connectorstyle() bit flags} xywh {485 225 140 21} down_box BORDER_BOX labelsize 12 textsize 11
code0 {switch (tree->connectorstyle()) { case FL_TREE_CONNECTOR_NONE: connectorstyle_chooser->value(0); break; case FL_TREE_CONNECTOR_DOTTED: connectorstyle_chooser->value(1); break; case FL_TREE_CONNECTOR_SOLID: connectorstyle_chooser->value(2); break; }}
} {
@ -523,7 +523,7 @@ switch ( selectmode_chooser->value() ) {
default: tree->selectmode(FL_TREE_SELECT_SINGLE); break; // Single
}} selected
tooltip {Sets how Fl_Tree handles mouse selection of tree items} xywh {485 249 140 21} down_box BORDER_BOX labelsize 12 textsize 11
code0 {selectmode_chooser->value(1);}
code0 {selectmode_chooser->value(2);}
code1 {cb_selectmode_chooser(selectmode_chooser, (void*)0);}
} {
MenuItem {} {
@ -555,7 +555,7 @@ reselectmode_chooser->tooltip("DISABLED.\\n"
"Set FLTK_ABI_VERSION to 10302 (or higher)\\n"
"to get this feature");
window->redraw(); // deactivated
\#endif} selected
\#endif}
tooltip {Enable 'reselect' events
These happen when mouse drags or multi-clicks an item} xywh {485 273 140 21} down_box BORDER_BOX labelsize 12 textsize 11
code0 {reselectmode_chooser->value(1);}
@ -586,7 +586,7 @@ itemdrawmode_chooser->tooltip("DISABLED.\\n"
"Set FLTK_ABI_VERSION to 10302 (or higher)\\n"
"to get this feature");
window->redraw(); // deactivated
\#endif} selected
\#endif}
tooltip {Sets how Fl_Tree draws item label and widget()} xywh {485 297 140 21} down_box BORDER_BOX labelsize 12 textsize 11
code0 {itemdrawmode_chooser->value(0);}
code1 {itemdrawmode_chooser->do_callback();}
@ -608,7 +608,7 @@ switch ( whenmode_chooser->value() ) {
case 1: tree->when(FL_WHEN_CHANGED); break;
case 2: tree->when(FL_WHEN_NEVER); break;
default: tree->when(FL_WHEN_RELEASE); break;
}} selected
}}
tooltip {Sets when() the tree's callback is invoked} xywh {485 321 140 21} down_box BORDER_BOX labelsize 12 textsize 11
code0 {whenmode_chooser->value(1);}
code1 {cb_whenmode_chooser(whenmode_chooser, (void*)0);}