ELinks 0.18.0
hierbox_browser Struct Reference

BFU hierbox browser. More...

#include <hierbox.h>

Collaboration diagram for hierbox_browser:

Data Fields

char * title
 The title of the browser Note, it is automatically localized.
 
void(* expansion_callback )(void)
 Callback for (un)expansion of the listboxes Can be used by subsystems to install a handler to be called when listboxes are expanded and unexpanded.
 
const struct hierbox_browser_buttonbuttons
 Array of browser buttons.
 
size_t buttons_size
 The number of browser buttons.
 
struct listbox_data list boxes
 List of active listbox containers.
 
struct hierbox_dialog_list_item list dialogs
 List of active dialogs.
 
struct listbox_item root
 The root listbox The ancestor of all listboxes in this listbox browser.
 
const struct listbox_opsops
 Browser specific listbox operations The operations for managing the underlying data structures of the listboxes.
 
struct listbox_data box_data
 State saved between invocations Each time the browser is closed, its current state is saved in this member so it can be restored when the browser is opened again.
 
unsigned int do_not_save_state:1
 Option for not saving the state Some browsers with highly dynamic content should not have their state restored.
 

Detailed Description

BFU hierbox browser.

Hierarchic listbox browsers are used for the various (subsystem) managers. They basically consist of some state data maintained throughout the life of the dialog (i.e. the listbox widget), manager specific operations (for modifying the underlying data structures), and some buttons.

Field Documentation

◆ box_data

struct listbox_data hierbox_browser::box_data

State saved between invocations Each time the browser is closed, its current state is saved in this member so it can be restored when the browser is opened again.

This way the currently selected item can be preserved across several interactions with the browser.

◆ boxes

struct listbox_data list hierbox_browser::boxes

List of active listbox containers.

Several instantiations of a manager can exist at the same time, if the user has more than one terminal open. This list contains all the listbox contains for this particular manager that are currently open.

◆ buttons

const struct hierbox_browser_button* hierbox_browser::buttons

Array of browser buttons.

Each button represents an action for modifying or interacting with the items in the manager.

A close button will be installed by default.

◆ buttons_size

size_t hierbox_browser::buttons_size

The number of browser buttons.

◆ dialogs

struct hierbox_dialog_list_item list hierbox_browser::dialogs

List of active dialogs.

Several instantiations of a manager can exist at the same time, if the user has more than one terminal open. This list contains all the manager dialogs for this particular manager that are currently open.

◆ do_not_save_state

unsigned int hierbox_browser::do_not_save_state

Option for not saving the state Some browsers with highly dynamic content should not have their state restored.

This member can be used to mark such browsers.

◆ expansion_callback

void(* hierbox_browser::expansion_callback) (void)

Callback for (un)expansion of the listboxes Can be used by subsystems to install a handler to be called when listboxes are expanded and unexpanded.

◆ ops

const struct listbox_ops* hierbox_browser::ops

Browser specific listbox operations The operations for managing the underlying data structures of the listboxes.

◆ root

struct listbox_item hierbox_browser::root

The root listbox The ancestor of all listboxes in this listbox browser.

◆ title

char* hierbox_browser::title

The title of the browser Note, it is automatically localized.


The documentation for this struct was generated from the following file: