release v0.29

[ncmpc.git] / src / screen_find.h

diff --git a/src/screen_find.h b/src/screen_find.h
index 1d46a9f8d4cfc01979100f66291fedb511e2e703..788fdce4717f86bc0d7c82fdb64136144fd57c95 100644 (file)
--- a/src/screen_find.h
+++ b/src/screen_find.h
@@ -1,5 +1,5 @@
 /* ncmpc (Ncurses MPD Client)
- * (c) 2004-2010 The Music Player Daemon Project
+ * (c) 2004-2017 The Music Player Daemon Project
  * Project homepage: http://musicpd.org
  *
  * This program is free software; you can redistribute it and/or modify
@@ -23,17 +23,26 @@
 #include "command.h"
 #include "list_window.h"
 
-/* query user for a string and find it in a list window */
-int screen_find(struct list_window *lw,
-               command_t findcmd,
-               list_window_callback_fn_t callback_fn,
-               void *callback_data);
+/**
+ * query user for a string and find it in a list window
+ *
+ * @param lw the list window to search
+ * @param findcmd the search command/mode
+ * @param callback_fn a function returning the text of a given line
+ * @param callback_data a pointer passed to callback_fn
+ * @return true if the command has been handled, false if not
+ */
+bool
+screen_find(struct list_window *lw,
+           command_t findcmd,
+           list_window_callback_fn_t callback_fn,
+           void *callback_data);
 
 /* query user for a string and jump to the entry
  * which begins with this string while the users types */
-void screen_jump(struct list_window *lw,
-               list_window_callback_fn_t callback_fn,
-                list_window_paint_callback_t paint_callback,
-               void *callback_data);
+void
+screen_jump(struct list_window *lw,
+           list_window_callback_fn_t callback_fn, void *callback_data,
+           list_window_paint_callback_t paint_callback, void *paint_data);
 
 #endif