netsurf/desktop/textinput.h
2014-11-10 16:05:22 +00:00

104 lines
2.5 KiB
C

/*
* Copyright 2003 Phil Mellor <monkeyson@users.sourceforge.net>
* Copyright 2004 James Bursa <bursa@users.sourceforge.net>
* Copyright 2004 Andrew Timmins <atimmins@blueyonder.co.uk>
* Copyright 2004 John Tytgat <joty@netsurf-browser.org>
*
* 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/>.
*/
/** \file
* Textual input handling (interface)
*/
#ifndef _NETSURF_DESKTOP_TEXTINPUT_H_
#define _NETSURF_DESKTOP_TEXTINPUT_H_
struct browser_window;
enum input_key {
KEY_SELECT_ALL = 1,
KEY_COPY_SELECTION = 3,
KEY_DELETE_LEFT = 8,
KEY_TAB = 9,
KEY_NL = 10,
KEY_SHIFT_TAB = 11,
KEY_CR = 13,
KEY_DELETE_LINE = 21,
KEY_PASTE = 22,
KEY_CUT_SELECTION = 24,
KEY_CLEAR_SELECTION = 26,
KEY_ESCAPE = 27,
/* cursor movement keys */
KEY_LEFT = 28,
KEY_RIGHT,
KEY_UP,
KEY_DOWN,
KEY_DELETE_RIGHT = 127,
KEY_LINE_START = 128,
KEY_LINE_END,
KEY_TEXT_START,
KEY_TEXT_END,
KEY_WORD_LEFT,
KEY_WORD_RIGHT,
KEY_PAGE_UP,
KEY_PAGE_DOWN,
KEY_DELETE_LINE_END,
KEY_DELETE_LINE_START,
KEY_UNDO,
KEY_REDO
};
/**
* Position the caret and assign a callback for key presses.
*
* \param bw The browser window in which to place the caret
* \param x X coordinate of the caret
* \param y Y coordinate
* \param height Height of caret
* \param clip Clip rectangle for caret, or NULL if none
*/
void browser_window_place_caret(struct browser_window *bw, int x, int y,
int height, const struct rect *clip);
/**
* Removes the caret and callback for key process.
*
* \param bw The browser window from which to remove caret.
* \param only_hide Revove teh caret but leave teh textinput editable.
*/
void browser_window_remove_caret(struct browser_window *bw, bool only_hide);
/**
* Handle key presses in a browser window.
*
* \param bw The root browser window
* \param key The UCS4 character codepoint
* \return true if key handled, false otherwise
*/
bool browser_window_key_press(struct browser_window *bw, uint32_t key);
#endif