ELinks 0.18.0
view.h File Reference
#include "config/kbdbind.h"
#include "viewer/action.h"
Include dependency graph for view.h:
This graph shows which files directly or indirectly include this file:

Macros

#define move_link_next(ses, doc_view)
#define move_link_prev(ses, doc_view)
#define move_link_up(ses, doc_view)
#define move_link_down(ses, doc_view)
#define move_link_left(ses, doc_view)
#define move_link_right(ses, doc_view)

Functions

void detach_formatted (struct document_view *doc_view)
 Releases the document view's resources.
enum frame_event_status move_current_top (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_half_page_down (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_half_page_up (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_page_down (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_page_up (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_link (struct session *ses, struct document_view *doc_view, int direction, int wraparound_bound, int wraparound_link)
enum frame_event_status move_link_dir (struct session *ses, struct document_view *doc_view, int dir_x, int dir_y)
enum frame_event_status move_link_prev_line (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_link_next_line (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_link_up_line (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_link_down_line (struct session *ses, struct document_view *doc_view)
enum frame_event_status scroll_up (struct session *ses, struct document_view *doc_view)
enum frame_event_status scroll_down (struct session *ses, struct document_view *doc_view)
enum frame_event_status scroll_left (struct session *ses, struct document_view *doc_view)
enum frame_event_status scroll_right (struct session *ses, struct document_view *doc_view)
enum frame_event_status horizontal_scroll_extended (struct session *ses, struct document_view *doc_view, int steps, int extended)
enum frame_event_status vertical_scroll (struct session *ses, struct document_view *doc_view, int steps)
enum frame_event_status move_document_start (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_document_end (struct session *ses, struct document_view *doc_view)
enum frame_event_status set_frame (struct session *ses, struct document_view *doc_view, int xxxx)
struct document_viewcurrent_frame (struct session *)
void toggle_plain_html (struct session *ses, struct document_view *doc_view, int xxxx)
 Used for changing between formatted and source (plain) view.
enum frame_event_status move_cursor_left (struct session *ses, struct document_view *view)
enum frame_event_status move_cursor_right (struct session *ses, struct document_view *view)
enum frame_event_status move_cursor_up (struct session *ses, struct document_view *view)
enum frame_event_status move_cursor_down (struct session *ses, struct document_view *view)
enum frame_event_status move_cursor_line_start (struct session *ses, struct document_view *doc_view)
enum frame_event_status move_cursor (struct session *ses, struct document_view *doc_view, int x, int y)
 Move the cursor to the document view co-ordinates provided as x and y, scroll the document if necessary, put us in cursor-routing navigation mode if that is not the current mode, and select any link under the cursor.
void toggle_wrap_text (struct session *ses, struct document_view *doc_view, int xxxx)
 Used for changing wrapping of text.
enum frame_event_status copy_current_link_to_clipboard (struct session *ses, struct document_view *doc_view, int xxx)
enum frame_event_status copy_to_clipboard (struct session *ses, struct document_view *doc_view)
enum frame_event_status mark_clipboard (struct session *ses, struct document_view *doc_view)
int try_jump_to_link_number (struct session *ses, struct document_view *doc_view)
 If the user has provided a numeric prefix, jump to the link with that number as its index.
File menu handlers.
enum frame_event_status save_as (struct session *ses, struct document_view *doc_view, int magic)
Various event emitters and link menu handlers.
void send_event (struct session *, struct term_event *)
enum frame_event_status save_formatted_dlg (struct session *ses, struct document_view *doc_view, int xxxx)
enum frame_event_status view_image (struct session *ses, struct document_view *doc_view, int xxxx)
enum frame_event_status download_link (struct session *ses, struct document_view *doc_view, action_id_T action_id)
void open_link_dialog (struct session *ses)

Macro Definition Documentation

◆ move_link_down

#define move_link_down ( ses,
doc_view )
Value:
move_link_dir(ses, doc_view, 0, 1)
enum frame_event_status move_link_dir(struct session *ses, struct document_view *doc_view, int dir_x, int dir_y)
Definition view.c:295

◆ move_link_left

#define move_link_left ( ses,
doc_view )
Value:
move_link_dir(ses, doc_view, -1, 0)

◆ move_link_next

#define move_link_next ( ses,
doc_view )
Value:
move_link(ses, doc_view, 1, (doc_view)->document->nlinks - 1, 0)
Definition document.h:213
int nlinks
Definition document.h:293
enum frame_event_status move_link(struct session *ses, struct document_view *doc_view, int direction, int wraparound_bound, int wraparound_link)
Definition view.c:217

◆ move_link_prev

#define move_link_prev ( ses,
doc_view )
Value:
move_link(ses, doc_view, -1, 0, (doc_view)->document->nlinks - 1)

◆ move_link_right

#define move_link_right ( ses,
doc_view )
Value:
move_link_dir(ses, doc_view, 1, 0)

◆ move_link_up

#define move_link_up ( ses,
doc_view )
Value:
move_link_dir(ses, doc_view, 0, -1)

Function Documentation

◆ copy_current_link_to_clipboard()

enum frame_event_status copy_current_link_to_clipboard ( struct session * ses,
struct document_view * doc_view,
int xxx )

◆ copy_to_clipboard()

enum frame_event_status copy_to_clipboard ( struct session * ses,
struct document_view * doc_view )

◆ current_frame()

struct document_view * current_frame ( struct session * ses)

◆ detach_formatted()

void detach_formatted ( struct document_view * doc_view)

Releases the document view's resources.

But doesn't free() the doc_view.

◆ download_link()

enum frame_event_status download_link ( struct session * ses,
struct document_view * doc_view,
action_id_T action_id )

◆ horizontal_scroll_extended()

enum frame_event_status horizontal_scroll_extended ( struct session * ses,
struct document_view * doc_view,
int steps,
int extended )

steps > 0 -> right

◆ mark_clipboard()

enum frame_event_status mark_clipboard ( struct session * ses,
struct document_view * doc_view )

◆ move_current_top()

enum frame_event_status move_current_top ( struct session * ses,
struct document_view * doc_view )

◆ move_cursor()

enum frame_event_status move_cursor ( struct session * ses,
struct document_view * doc_view,
int x,
int y )

Move the cursor to the document view co-ordinates provided as x and y, scroll the document if necessary, put us in cursor-routing navigation mode if that is not the current mode, and select any link under the cursor.

◆ move_cursor_down()

enum frame_event_status move_cursor_down ( struct session * ses,
struct document_view * view )

◆ move_cursor_left()

enum frame_event_status move_cursor_left ( struct session * ses,
struct document_view * view )

◆ move_cursor_line_start()

enum frame_event_status move_cursor_line_start ( struct session * ses,
struct document_view * doc_view )

◆ move_cursor_right()

enum frame_event_status move_cursor_right ( struct session * ses,
struct document_view * view )

◆ move_cursor_up()

enum frame_event_status move_cursor_up ( struct session * ses,
struct document_view * view )

◆ move_document_end()

enum frame_event_status move_document_end ( struct session * ses,
struct document_view * doc_view )

◆ move_document_start()

enum frame_event_status move_document_start ( struct session * ses,
struct document_view * doc_view )

◆ move_half_page_down()

enum frame_event_status move_half_page_down ( struct session * ses,
struct document_view * doc_view )

◆ move_half_page_up()

enum frame_event_status move_half_page_up ( struct session * ses,
struct document_view * doc_view )

◆ move_link()

enum frame_event_status move_link ( struct session * ses,
struct document_view * doc_view,
int direction,
int wraparound_bound,
int wraparound_link )

◆ move_link_dir()

enum frame_event_status move_link_dir ( struct session * ses,
struct document_view * doc_view,
int dir_x,
int dir_y )

◆ move_link_down_line()

enum frame_event_status move_link_down_line ( struct session * ses,
struct document_view * doc_view )

◆ move_link_next_line()

enum frame_event_status move_link_next_line ( struct session * ses,
struct document_view * doc_view )

◆ move_link_prev_line()

enum frame_event_status move_link_prev_line ( struct session * ses,
struct document_view * doc_view )

◆ move_link_up_line()

enum frame_event_status move_link_up_line ( struct session * ses,
struct document_view * doc_view )

◆ move_page_down()

enum frame_event_status move_page_down ( struct session * ses,
struct document_view * doc_view )

◆ move_page_up()

enum frame_event_status move_page_up ( struct session * ses,
struct document_view * doc_view )

◆ open_link_dialog()

void open_link_dialog ( struct session * ses)

◆ save_as()

enum frame_event_status save_as ( struct session * ses,
struct document_view * doc_view,
int magic )

◆ save_formatted_dlg()

enum frame_event_status save_formatted_dlg ( struct session * ses,
struct document_view * doc_view,
int xxxx )

◆ scroll_down()

enum frame_event_status scroll_down ( struct session * ses,
struct document_view * doc_view )

◆ scroll_left()

enum frame_event_status scroll_left ( struct session * ses,
struct document_view * doc_view )

◆ scroll_right()

enum frame_event_status scroll_right ( struct session * ses,
struct document_view * doc_view )

◆ scroll_up()

enum frame_event_status scroll_up ( struct session * ses,
struct document_view * doc_view )

◆ send_event()

void send_event ( struct session * ses,
struct term_event * ev )

◆ set_frame()

enum frame_event_status set_frame ( struct session * ses,
struct document_view * doc_view,
int xxxx )

◆ toggle_plain_html()

void toggle_plain_html ( struct session * ses,
struct document_view * doc_view,
int xxxx )

Used for changing between formatted and source (plain) view.

◆ toggle_wrap_text()

void toggle_wrap_text ( struct session * ses,
struct document_view * doc_view,
int xxxx )

Used for changing wrapping of text.

◆ try_jump_to_link_number()

int try_jump_to_link_number ( struct session * ses,
struct document_view * doc_view )

If the user has provided a numeric prefix, jump to the link with that number as its index.

◆ vertical_scroll()

enum frame_event_status vertical_scroll ( struct session * ses,
struct document_view * doc_view,
int steps )

steps > 0 -> down

◆ view_image()

enum frame_event_status view_image ( struct session * ses,
struct document_view * doc_view,
int xxxx )