NetSurf
Data Structures | Typedefs | Enumerations
window.h File Reference

Interface to platform-specific graphical user interface window operations. More...

#include "netsurf/console.h"
Include dependency graph for window.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  gui_window_table
 Graphical user interface window function table. More...
 

Typedefs

typedef enum gui_save_type gui_save_type
 

Enumerations

enum  gui_save_type {
  GUI_SAVE_SOURCE , GUI_SAVE_DRAW , GUI_SAVE_PDF , GUI_SAVE_TEXT ,
  GUI_SAVE_COMPLETE , GUI_SAVE_OBJECT_ORIG , GUI_SAVE_OBJECT_NATIVE , GUI_SAVE_LINK_URI ,
  GUI_SAVE_LINK_URL , GUI_SAVE_LINK_TEXT , GUI_SAVE_HOTLIST_EXPORT_HTML , GUI_SAVE_HISTORY_EXPORT_HTML ,
  GUI_SAVE_TEXT_SELECTION , GUI_SAVE_CLIPBOARD_CONTENTS
}
 
enum  gui_drag_type { GDRAGGING_NONE , GDRAGGING_SCROLLBAR , GDRAGGING_SELECTION , GDRAGGING_OTHER }
 
enum  gui_window_create_flags {
  GW_CREATE_NONE = 0 , GW_CREATE_CLONE = (1 << 0) , GW_CREATE_TAB = (1 << 1) , GW_CREATE_FOREGROUND = (1 << 2) ,
  GW_CREATE_FOCUS_LOCATION = (1 << 3)
}
 Window creation control flags. More...
 
enum  gui_window_event {
  GW_EVENT_NONE = 0 , GW_EVENT_UPDATE_EXTENT , GW_EVENT_REMOVE_CARET , GW_EVENT_START_THROBBER ,
  GW_EVENT_STOP_THROBBER , GW_EVENT_SCROLL_START , GW_EVENT_NEW_CONTENT , GW_EVENT_START_SELECTION ,
  GW_EVENT_PAGE_INFO_CHANGE
}
 Window events. More...
 

Detailed Description

Interface to platform-specific graphical user interface window operations.

Definition in file window.h.

Typedef Documentation

◆ gui_save_type

Enumeration Type Documentation

◆ gui_drag_type

Enumerator
GDRAGGING_NONE 
GDRAGGING_SCROLLBAR 
GDRAGGING_SELECTION 
GDRAGGING_OTHER 

Definition at line 56 of file window.h.

◆ gui_save_type

Enumerator
GUI_SAVE_SOURCE 
GUI_SAVE_DRAW 
GUI_SAVE_PDF 
GUI_SAVE_TEXT 
GUI_SAVE_COMPLETE 
GUI_SAVE_OBJECT_ORIG 
GUI_SAVE_OBJECT_NATIVE 
GUI_SAVE_LINK_URI 
GUI_SAVE_LINK_URL 
GUI_SAVE_LINK_TEXT 
GUI_SAVE_HOTLIST_EXPORT_HTML 
GUI_SAVE_HISTORY_EXPORT_HTML 
GUI_SAVE_TEXT_SELECTION 
GUI_SAVE_CLIPBOARD_CONTENTS 

Definition at line 39 of file window.h.

◆ gui_window_create_flags

Window creation control flags.

Enumerator
GW_CREATE_NONE 

New window.

GW_CREATE_CLONE 

Clone existing window.

GW_CREATE_TAB 

Create tab in same window as existing.

GW_CREATE_FOREGROUND 

Request this window/tab is foregrounded.

GW_CREATE_FOCUS_LOCATION 

Definition at line 66 of file window.h.

◆ gui_window_event

Window events.

these are events delivered to a gui window which have no additional parameters and hence do not require separate callbacks.

Enumerator
GW_EVENT_NONE 

An empty event should never occur.

GW_EVENT_UPDATE_EXTENT 

Update the extent of the inside of a browser window to that of the current content.

Todo:
this is used to update scroll bars does it need renaming? some frontends (windows) do not even implement it.
GW_EVENT_REMOVE_CARET 

Remove the caret, if present.

GW_EVENT_START_THROBBER 

start the navigation throbber.

GW_EVENT_STOP_THROBBER 

stop the navigation throbber.

GW_EVENT_SCROLL_START 

Starts drag scrolling of a browser window.

GW_EVENT_NEW_CONTENT 

Called when the gui_window has new content.

GW_EVENT_START_SELECTION 

selection started

GW_EVENT_PAGE_INFO_CHANGE 

Page status has changed and so the padlock should be updated.

Definition at line 80 of file window.h.