netsurf/desktop/selection.h

98 lines
2.8 KiB
C

/*
* This file is part of NetSurf, http://netsurf-browser.org/
* Licensed under the GNU General Public License,
* http://www.opensource.org/licenses/gpl-license
* Copyright 2005 Adrian Lees <adrianl@users.sourceforge.net>
*/
/** \file
* Text selection within browser windows, platform-independent part (interface)
*/
#ifndef _NETSURF_DESKTOP_SELECTION_H_
#define _NETSURF_DESKTOP_SELECTION_H_
#include "desktop/browser.h"
#include "render/box.h"
typedef enum {
DRAG_NONE,
DRAG_START,
DRAG_END
} seln_drag_state;
/* this structure should be treated as opaque outside selection.c
(it's defined here to accelerate selection_defined(s) for reduced
impact on redraw code) */
struct selection
{
struct browser_window *bw;
struct box *root;
unsigned max_idx; /* total bytes in text representation */
unsigned start_idx; /* offset in bytes within text representation */
unsigned end_idx;
bool defined;
bool last_was_end;
seln_drag_state drag_state;
};
typedef bool (*seln_traverse_handler)(const char *text, size_t length,
bool space, struct box *box, void *handle);
struct selection *selection_create(struct browser_window *bw);
void selection_destroy(struct selection *s);
void selection_init(struct selection *s, struct box *root);
void selection_reinit(struct selection *s, struct box *root);
/* struct box *selection_root(struct selection *s); */
#define selection_root(s) ((s)->root)
/* bool selection_defined(struct selection *s); */
#define selection_defined(s) ((s)->defined)
/* bool selection_dragging(struct selection *s); */
#define selection_dragging(s) ((s)->drag_state != DRAG_NONE)
/* bool selection_dragging_start(struct selection *s); */
#define selection_dragging_start(s) ((s)->drag_state == DRAG_START)
void selection_clear(struct selection *s, bool redraw);
void selection_select_all(struct selection *s);
void selection_set_start(struct selection *s, unsigned idx);
void selection_set_end(struct selection *s, unsigned idx);
struct box *selection_get_start(struct selection *s, int *pidx);
struct box *selection_get_end(struct selection *s, int *pidx);
bool selection_click(struct selection *s, browser_mouse_state mouse, unsigned idx);
void selection_track(struct selection *s, browser_mouse_state mouse, unsigned idx);
/** Handles completion of a drag operation */
/* void selection_drag_end(struct selection *s); */
#define selection_drag_end(s) ((s)->drag_state = DRAG_NONE)
bool selection_traverse(struct selection *s, seln_traverse_handler handler,
void *handle);
bool selection_highlighted(struct selection *s, unsigned start, unsigned end,
unsigned *start_idx, unsigned *end_idx);
bool selection_save_text(struct selection *s, const char *path);
void selection_update(struct selection *s, size_t byte_offset, int change,
bool redraw);
#endif