ADD: searchable comboboxes; for editing click twice

git-svn-id: svn://tron.homeunix.org/simutrans/simutrans/trunk@11879 8aca7d54-2c30-db11-9de9-000461428c89

Author: prissi

simutrans/history.txt

@@ -56,6 +56,7 @@
 	ADD: new flag for bridges and ways in makeobj 60.9 "clip_below" Default is (1) but for slim structures (e.g. powerline) it could be set to zero for nicer display of structures below
 	CHG: (poppo) jump tool now allows also for z coordinaate
 	FIX: (poppo) last tool not show when too many tools to fit
+	ADD: searchable comboboxes; for editing click twice
 
 
 Release of 124.3.1 (r11671 on 5-Apr-2025):

src/simutrans/gui/components/gui_combobox.cc

@@ -28,19 +28,22 @@ gui_combobox_t::gui_combobox_t(gui_scrolled_list_t::item_compare_func cmp) :
 {
 	minimize = false;
 	bt_prev.set_typ(button_t::arrowleft);
-	bt_prev.set_pos( scr_coord(0,2) );
+	bt_prev.set_pos(scr_coord(0, 2));
 
 	bt_next.set_typ(button_t::arrowright);
 
-	set_focusable( true ); // needed, otherwise fails on closing when clicking elsewhere!
+	set_focusable(true); // needed, otherwise fails on closing when clicking elsewhere!
 
+	search_str[0] = 0;
 	editstr[0] = 0;
 	old_editstr[0] = 0;
 	textinp.add_listener(this);
 
 	first_call = true;
 	finish = false;
 	wrapping = true;
+	force_selection = false;
+	selection_when_open = -1;
 	droplist.set_visible(false);
 	droplist.add_listener(this);
 	closed_size = get_size();
@@ -99,17 +102,31 @@ DBG_MESSAGE("event","HOWDY!");
 	}
 
 	// goto next/previous choice
-	if(  IS_KEYDOWN(ev)  &&  (ev->ev_code == SIM_KEYCODE_UP  ||  ev->ev_code == SIM_KEYCODE_DOWN)  ) {
+	if(  IS_KEYDOWN(ev)  &&  (ev->ev_code == SIM_KEYCODE_UP  ||  ev->ev_code == SIM_KEYCODE_DOWN)  &&  droplist.get_count()>0) {
+		int delta = ev->ev_code == SIM_KEYCODE_UP ? -1 : 1;
 		int sel = droplist.get_selection();
-		if(  ev->ev_code == SIM_KEYCODE_UP  ) {
-			set_selection(  sel > 0 ? sel-1 : (wrapping ? droplist.get_count()-1 : 0) );
+		if (delta < 0 && sel < 0) {
+			// start at last
+			sel = 0;
 		}
-		else {
-			set_selection( sel < (sint32)droplist.get_count()-1 ? sel+1 : (wrapping ? 0 : droplist.get_count()-1) );
+		const int cnt = droplist.get_count();
+		bool found = false;
+		for (int i = 0; i < droplist.get_count(); i++) {
+			sel = (sel + delta + cnt) % cnt;
+			if (droplist.get_element(sel)->is_visible()) {
+				found = true;
+				break;
+			}
+		}
+		if (sel != droplist.get_selection()) {
+			droplist.set_selection(sel);
+			if (!droplist.is_visible()) {
+				// update if we are not in the open list scrolling
+				value_t p;
+				p.i = droplist.get_selection();
+				call_listeners(p);
+			}
 		}
-		value_t p;
-		p.i = droplist.get_selection();
-		call_listeners( p );
 		return true;
 	}
 
@@ -138,6 +155,7 @@ DBG_MESSAGE("event","HOWDY!");
 
 			// else prepare for selection (after a left mbutton release event!)
 			droplist.set_visible(true);
+			selection_when_open = droplist.get_selection();
 
 			// determine possible size of droplist and whether open below/above input field
 			scr_coord_val win_height = win_get_top()->get_windowsize().h - D_TITLEBAR_HEIGHT;
@@ -160,6 +178,9 @@ DBG_MESSAGE("event","HOWDY!");
 				sel = 0;
 			}
 			droplist.show_selection(sel);
+			search_str[0] = 0;
+			textinp.set_text(NULL, 0);
+			textinp.set_text(search_str, lengthof(search_str));
 		}
 		else if (droplist.is_visible()) {
 
@@ -169,16 +190,8 @@ DBG_MESSAGE("event","HOWDY!");
 				event_t ev2 = *ev;
 				ev2.move_origin(droplist.get_pos());
 				if(  droplist.infowin_event(&ev2)  ) {
-					if(  droplist.get_selection() !=  old_selection  ) {
-						// close box will anyway call
-						if( !IS_LEFTRELEASE( ev ) ) {
-							// in case of LEFTRELEASE, close_box will call it again
-							call_listeners( droplist.get_selection() );
-						}
-						finish = true;
-					}
-					// we selected something?
-					if(finish  &&  IS_LEFTRELEASE(ev)) {
+					finish = droplist.get_selection() != old_selection;
+					if(IS_LEFTRELEASE(ev)) {
 						close_box();
 					}
 				}
@@ -200,7 +213,27 @@ DBG_MESSAGE("gui_combobox_t::infowin_event()","close");
 	else {
 		// finally handle textinput
 		gui_scrolled_list_t::scrollitem_t *item = droplist.get_selected_item();
-		if(  item==NULL  ||  item->is_editable()  ) {
+		if (droplist.is_visible()) {
+			// we are searching, not renaming
+			int first_match = -1;
+			event_t ev2 = *ev;
+			ev2.move_origin(textinp.get_pos());
+			char same = search_str[0];
+			if (textinp.infowin_event(&ev2)) {
+				if (search_str[0]!=same) {
+					for (int i = 0; i < droplist.get_count(); i++) {
+						droplist.get_element(i)->set_visible(strstr(droplist.get_element(i)->get_text(), search_str));
+						if (droplist.get_element(i)->is_visible() && first_match <= droplist.get_selection()) {
+							first_match = i;
+						}
+					}
+					droplist.show_selection(first_match);
+					droplist.set_selection(first_match);
+				}
+				return true;
+			}
+		}
+		else if(  item==NULL  ||  item->is_editable()  ) {
 			event_t ev2 = *ev;
 			ev2.move_origin(textinp.get_pos());
 			return textinp.infowin_event(&ev2);
@@ -234,8 +267,11 @@ void gui_combobox_t::draw(scr_coord offset)
 	last_draw_offset = offset;
 	// text changed? Then update it
 	gui_scrolled_list_t::scrollitem_t *item = droplist.get_selected_item();
-	if(  item  &&  item->is_valid()  &&  item->is_editable()  &&  strncmp( item->get_text(), old_editstr, 127 )  ) {
-		reset_selected_item_name();
+	if (!droplist.is_visible()) {
+		// maybe rename item unless we are searching reight now
+		if (item && item->is_valid() && item->is_editable() && strncmp(item->get_text(), old_editstr, lengthof(old_editstr))) {
+			reset_selected_item_name();
+		}
 	}
 
 	offset += pos;
@@ -274,18 +310,22 @@ void gui_combobox_t::disable()
  */
 void gui_combobox_t::set_selection(int s)
 {
+	search_str[0] = 0;
+
 	// try to finish renaming first
 	rename_selected_item();
 
+	// just set it
+	if (force_selection  &&  s < 0  &&  droplist.get_count() > 0) {
+		// force always a valid selection unless empty
+		s = 0;
+	}
+	droplist.set_selection(s);
 	if (droplist.is_visible()  &&  !finish) {
 		// visible and not closing
 		// change also offset of scrollbar
 		droplist.show_selection( s );
 	}
-	else {
-		// just set it
-		droplist.set_selection(s);
-	}
 	// edit the text
 	reset_selected_item_name();
 }
@@ -300,7 +340,7 @@ void gui_combobox_t::rename_selected_item()
 	// if name was not changed in the meantime, we can rename it
 	if(  item  &&  item->is_valid()  &&  item->is_editable()  ) {
 		const char *current_str = ((gui_scrolled_list_t::const_text_scrollitem_t *)item)->get_text();
-		if(  strncmp( current_str, old_editstr, 127 )==0  &&  strncmp( current_str, editstr, 127 )!=0  ) {
+		if(  strncmp( current_str, old_editstr, lengthof(old_editstr)-1) == 0  &&  strncmp( current_str, editstr, lengthof(old_editstr)-1) != 0  ) {
 			item->set_text(editstr);
 		}
 	}
@@ -312,14 +352,18 @@ void gui_combobox_t::reset_selected_item_name()
 	gui_scrolled_list_t::scrollitem_t *item = droplist.get_selected_item();
 	if(  item==NULL  ) {
 		editstr[0] = 0;
-		textinp.set_text( editstr, 0  );
+		if(!droplist.is_visible()) {
+			textinp.set_text( editstr, 0  );
+		}
 		droplist.set_selection(-1);
 	}
 	else if(  item->is_valid()  ) {
 		const char *current_str = ((gui_scrolled_list_t::const_text_scrollitem_t *)item)->get_text();
-		if(  strncmp( current_str, old_editstr, 127 )!=0  ) {
+		if(  strncmp( current_str, old_editstr, lengthof(old_editstr)-1 )!=0  ) {
 			tstrncpy( editstr, current_str, lengthof(editstr) );
-			textinp.set_text( editstr, lengthof(editstr) );
+			if (!droplist.is_visible()) {
+				textinp.set_text(editstr, lengthof(editstr));
+			}
 		}
 	}
 	tstrncpy( old_editstr, editstr, lengthof(old_editstr) );
@@ -331,12 +375,27 @@ void gui_combobox_t::reset_selected_item_name()
 */
 void gui_combobox_t::close_box()
 {
-	if(finish) {
+	bool selection_changed = selection_when_open != droplist.get_selection();
+	reset_selected_item_name();
+	if(finish  &&  selection_changed) {
 		value_t p;
 		p.i = droplist.get_selection();
 		call_listeners(p);
 		finish = false;
 	}
+	if (search_str[0] || selection_changed) {
+		// reset filter: set all visible again
+		search_str[0] = 0;
+		for (int i = 0; i < droplist.get_count(); i++) {
+			droplist.get_element(i)->set_visible(true);
+		}
+		textinp.set_text(NULL, 0);  // also to reset cursor position
+	}
+	textinp.set_text(editstr, lengthof(editstr) );
+	if (!selection_changed) {
+		sint32 len = strlen(editstr);
+		textinp.set_cursor(len, len);
+	}
 	droplist.set_visible(false);
 	first_call = true;
 }
@@ -411,6 +470,7 @@ scr_size gui_combobox_t::get_max_size() const
 
 void gui_combobox_t::rdwr( loadsave_t *file )
 {
+	// todo: all pending edits and searches are lost/executed
 	sint32 i = get_selection();
 	file->rdwr_long(i);
 	set_selection(i);

src/simutrans/gui/components/gui_combobox.h

@@ -25,14 +25,15 @@ class gui_combobox_t :
 	public action_listener_t
 {
 private:
-	char editstr[128],old_editstr[128];
+	char editstr[256],old_editstr[256],search_str[256];
 
 	// buttons for setting selection manually
 	gui_textinput_t textinp;
 	button_t bt_prev;
 	button_t bt_next;
 
 	scr_size closed_size;
+	sint32   selection_when_open;
 
 	/**
 	 * the drop box list
@@ -52,6 +53,9 @@ class gui_combobox_t :
 	// try to shrink to minimum size even if there is more space
 	bool minimize:1;
 
+	// force always a vlid selection; if nothing is selected, select element 0
+	bool force_selection : 1;
+
 	// offset of last draw call, needed to decide, where to open droplist
 	scr_coord last_draw_offset;
 
@@ -143,6 +147,7 @@ class gui_combobox_t :
 	void close_box();
 
 	void set_wrapping(const bool wrap) { wrapping = wrap; }
+	void set_force_selection(const bool force) { force_selection = force; }
 
 	bool is_dropped() const { return droplist.is_visible(); }
 

src/simutrans/gui/components/gui_textinput.h

@@ -129,6 +129,12 @@ class gui_textinput_t :
 	// x position of the current cursor (for IME purposes)
 	scr_coord_val get_current_cursor_x() { return calc_cursor_pos(head_cursor_pos); }
 
+	// set currsen selection (not checks!)
+	void set_cursor(sint32 h, sint32 t) {
+		head_cursor_pos = h;
+		tail_cursor_pos = t;
+	}
+
 	/**
 	 * Detect change of focus state and determine whether cursor should be displayed,
 	 * and call the function that performs the actual display

src/simutrans/gui/depot_frame.cc

@@ -330,6 +330,7 @@ void depot_frame_t::init(depot_t *dep)
 		cont_4cols->new_component<gui_label_t>("Filter:", SYSCOL_TEXT, gui_label_t::right);
 
 		vehicle_filter.add_listener(this);
+		vehicle_filter.set_force_selection(true);
 		cont_4cols->add_component(&vehicle_filter);
 
 		cont_4cols->new_component<gui_label_t>("Search:", SYSCOL_TEXT, gui_label_t::right);

src/simutrans/gui/schedule_list.cc

@@ -81,6 +81,7 @@ schedule_list_gui_t::schedule_list_gui_t(player_t *player_) :
 
 		// freight type filter
 		new_component<gui_empty_t>();
+		freight_type_c.set_force_selection(true);
 		viewable_freight_types.append(NULL);
 		freight_type_c.new_component<gui_scrolled_list_t::const_text_scrollitem_t>(translator::translate("All"), SYSCOL_TEXT);
 		viewable_freight_types.append(goods_manager_t::passengers);
@@ -115,6 +116,7 @@ schedule_list_gui_t::schedule_list_gui_t(player_t *player_) :
 
 		// sort by what
 		new_component<gui_label_t>("hl_txt_sort");
+		sort_type_c.set_force_selection(true);
 		for( int i=0; i<MAX_SORT_IDX;  i++ ) {
 			sort_type_c.new_component<gui_scrolled_list_t::const_text_scrollitem_t>( translator::translate(idx_to_sort_text[i]), SYSCOL_TEXT) ;
 		}
@@ -380,7 +382,7 @@ void schedule_list_gui_t::rdwr( loadsave_t *file )
 // borrowed code from minimap
 bool schedule_list_gui_t::is_matching_freight_catg(const minivec_tpl<uint8> &goods_catg_index)
 {
-	const goods_desc_t *line_freight_type_group_index = viewable_freight_types[ freight_type_c.get_selection() ];
+	const goods_desc_t *line_freight_type_group_index = viewable_freight_types[freight_type_c.get_selection()];
 	// does this line/convoi has a matching freight
 	if(  line_freight_type_group_index == goods_manager_t::passengers  ) {
 		return goods_catg_index.is_contained(goods_manager_t::INDEX_PAS);