/usr/include/cwidget/widgets/pager.h is in libcwidget-dev 0.5.16-3.1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | // pager.h -*-c++-*-
//
// Copyright 2000-2004 Daniel Burrows
//
// A widget which acts as a text pager.
#ifndef PAGER_H
#define PAGER_H
#include "widget.h"
#include <string>
#include <vector>
class keybindings;
namespace cwidget
{
namespace widgets
{
/** \brief A widget that displays text.
*
* The text is displayed as-is, without wrapping or formatting.
* Tab stops are placed at 8-character intervals. The user can
* scroll up, down, left and right using the standard
* keybindings.
*/
class pager : public widget
{
public:
typedef std::vector<std::wstring>::size_type line_count;
typedef int col_count;
private:
/** The lines of text being displayed: */
std::vector<std::wstring> lines;
/** The first visible line. */
line_count first_line;
/** How much the widget is scrolled to the right. */
col_count first_column;
/** The bounds of the text contained in the pager. */
col_count text_width;
/** The last string the user searched for (so we can repeat searches) */
std::wstring last_search;
/** Handles resizing the widget. */
void layout_me();
/** The workhorse search routine. */
void search_omnidirectional_for(const std::wstring &s, bool forward);
protected:
pager(const char *text, int len, const char *encoding = NULL);
pager(const std::string &s, const char *encoding = NULL);
pager(const std::wstring &s);
public:
/** Create a pager from the given memory region.
*
* \param text the text to display
* \param len the length of the buffer
* \param encoding the encoding of text, or \b NULL to use LC_CTYPE
*/
static util::ref_ptr<pager>
create(const char *text, int len, const char *encoding = NULL)
{
util::ref_ptr<pager> rval(new pager(text, len, encoding));
rval->decref();
return rval;
}
/** Create a pager from a string.
*
* \param s the text to display
* \param encoding the encoding of s, or \b NULL to use LC_CTYPE
*/
static util::ref_ptr<pager>
create(const std::string &s, const char *encoding = NULL)
{
util::ref_ptr<pager> rval(new pager(s, encoding));
rval->decref();
return rval;
}
/** Create a pager from a wide character string.
*
* \param s the text to display
*/
static util::ref_ptr<pager>
create (const std::wstring &s)
{
util::ref_ptr<pager> rval(new pager(s));
rval->decref();
return rval;
}
/** Destroy this pager. */
virtual ~pager();
/** Set the text to the given memory region.
*
* \param text the text to display
* \param len the length of the buffer
* \param encoding the encoding of text, or \b NULL to use LC_CTYPE
*/
virtual void set_text(const char *text,
std::string::size_type len,
const char *encoding=NULL);
/** Change the displayed text.
*
* \param s the text to display
* \param encoding the encoding of s, or \b NULL to use LC_CTYPE
*/
virtual void set_text(const std::string &s, const char *encoding=NULL);
/** Change the displayed text.
*
* \param s the text to display
*/
virtual void set_text(const std::wstring &s);
/** Scroll the screen up by the given number of lines. */
void scroll_up(line_count nlines);
/** Scroll the screen down by the given number of lines. */
void scroll_down(line_count nlines);
/** Scroll the screen right by the given number of columns. */
void scroll_right(col_count ncols);
/** Scroll the screen left by the given number of columns. */
void scroll_left(col_count ncols);
/** Scroll to the top of the screen. */
void scroll_top();
/** Scroll to the bottom of the screen. */
void scroll_bottom();
/** Scroll by a page in the given direction.
*
* \param dir if \b true, scroll a page up; otherwise, scroll a
* page down.
*/
void scroll_page(bool dir);
/** Find the next line containing the given string.
*
* \param s the string to search for
*/
void search_for(const std::wstring &s)
{
search_omnidirectional_for(s, true);
}
/** Find the previous line containing the given string.
*
* \param s the string to search for
*/
void search_back_for(const std::wstring &s)
{
search_omnidirectional_for(s, false);
}
/** Return the last string which the user searched for. */
std::wstring get_last_search() {return last_search;}
line_count get_first_line() {return first_line;}
line_count get_num_lines() {return lines.size();}
col_count get_first_column() {return first_column;}
col_count get_num_columns() {return text_width;}
/** Emits a signal describing the verical location of the display
* within the text.
*/
void do_line_signal();
/** Emits a signal describing the horizontal location of the display
* within the text.
*/
void do_column_signal();
virtual bool handle_key(const config::key &k);
virtual void dispatch_mouse(short id, int x, int y, int z, mmask_t bstate);
virtual bool focus_me() {return true;}
virtual void paint(const style &st);
int width_request();
int height_request(int w);
bool get_cursorvisible() {return true;}
point get_cursorloc() {return point(0,0);}
/** Announces that the user has scrolled vertically. */
sigc::signal2<void, int, int> line_changed;
/** Announces that the user has scrolled horizontally. */
sigc::signal2<void, int, int> column_changed;
static config::keybindings *bindings;
static void init_bindings();
};
/** Load a file from disk; it's assumed to be ASCII for now. */
class file_pager:public pager
{
protected:
file_pager();
file_pager(const std::string &filename, const char *encoding = NULL);
file_pager(const std::wstring &filename, const char *encoding = NULL);
file_pager(const char *text, int len, const char *encoding = NULL);
public:
static util::ref_ptr<file_pager> create()
{
return new file_pager;
}
static util::ref_ptr<file_pager> create(const std::string &filename, const char *encoding=NULL)
{
return new file_pager(filename, encoding);
}
/** Attempts to convert the string to a multibyte representation and
* then load it; a nonconvertible string is treated as any other
* load failure would be.
*/
static util::ref_ptr<file_pager>
create(const std::wstring &filename, const char *encoding=NULL)
{
return new file_pager(filename, encoding);
}
static util::ref_ptr<file_pager>
create(const char *text, int len, const char *encoding=NULL)
{
return new file_pager(text, len, encoding);
}
/** Loads the given file into the pager.
*
* \param filename the name of the file to load
* \param encoding the encoding of the file's contents; if \b NULL, LC_CTYPE
* is used.
*/
void load_file(const std::string &filename, const char *encoding=NULL);
/** Attempts to convert the string to a multibyte representation and
* then load it; a nonconvertible string is treated as any other
* load failure would be.
*
* \param filename the name of the file to load
* \param encoding the encoding of the file's contents; if \b NULL, LC_CTYPE is used.
*/
void load_file(const std::wstring &filename, const char *encoding);
/** Attempts to convert the string to a multibyte representation and
* then load it; a nonconvertible string is treated as any other
* load failure would be. The file is assumed to contain text in
* the encoding specified by LC_CTYPE.
*
* \param filename the name of the file to load
*/
void load_file(const std::wstring &filename);
};
typedef util::ref_ptr<pager> pager_ref;
typedef util::ref_ptr<file_pager> file_pager_ref;
}
}
#endif
|