netsurf/desktop/search.h
Michael Drake 63c07ee28d Core part of search improvement:
+ Split up browser window and content related elements of html & text search.
+ Associate search contexts with contents, rather than browser windows.
+ Remove highlighting of search terms dependency on current_redraw_browser.
+ Fixes issues with search contexts being applied to the wrong content.


svn path=/trunk/netsurf/; revision=12646
2011-08-24 12:29:30 +00:00

89 lines
2.9 KiB
C

/*
* Copyright 2009 Mark Benjamin <netsurf-browser.org.MarkBenjamin@dfgh.net>
*
* This file is part of NetSurf, http://www.netsurf-browser.org/
*
* NetSurf is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* NetSurf is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _NETSURF_DESKTOP_SEARCH_H_
#define _NETSURF_DESKTOP_SEARCH_H_
#include <ctype.h>
#include <string.h>
struct search_context;
typedef enum {
SEARCH_FLAG_CASE_SENSITIVE = (1 << 0),
SEARCH_FLAG_FORWARDS = (1 << 1),
SEARCH_FLAG_SHOWALL = (1 << 2)
} search_flags_t;
/**
* Change the displayed search status.
* \param found search pattern matched in text
* \param p the pointer sent to search_step() / search_create_context()
*/
typedef void (*search_status_callback)(bool found, void *p);
/**
* display hourglass while searching
* \param active start/stop indicator
* \param p the pointer sent to search_step() / search_create_context()
*/
typedef void (*search_hourglass_callback)(bool active, void *p);
/**
* add search string to recent searches list
* front has full liberty how to implement the bare notification;
* core gives no guarantee of the integrity of the const char *
* \param string search pattern
* \param p the pointer sent to search_step() / search_create_context()
*/
typedef void (*search_add_recent_callback)(const char *string, void *p);
/**
* activate search forwards button in gui
* \param active activate/inactivate
* \param p the pointer sent to search_step() / search_create_context()
*/
typedef void (*search_forward_state_callback)(bool active, void *p);
/**
* activate search back button in gui
* \param active activate/inactivate
* \param p the pointer sent to search_step() / search_create_context()
*/
typedef void (*search_back_state_callback)(bool active, void *p);
struct search_callbacks {
search_forward_state_callback forward_state;
search_back_state_callback back_state;
search_status_callback status;
search_hourglass_callback hourglass;
search_add_recent_callback add_recent;
};
bool browser_window_search_create_context(struct browser_window *bw,
struct search_callbacks *callbacks, void *p);
void browser_window_search_destroy_context(struct browser_window *bw);
bool browser_window_search_verify_new(struct browser_window *bw,
struct search_callbacks *callbacks, void *p);
void browser_window_search_step(struct browser_window *bw,
search_flags_t flags, const char *string);
void browser_window_search_show_all(bool all, struct browser_window *bw);
#endif