The documentation main class derived from QSplitter. More...

#include "documentation.h"

Inheritance diagram for octave::documentation:

Collaboration diagram for octave::documentation:

[legend]

Public Slots
void	copyClipboard (void)

void	load_index (void)

void	load_ref (const QString &name=QString())

void	notice_settings (const gui_settings *settings)

void	pasteClipboard (void)

void	registerDoc (const QString &name)

void	save_settings (void)

void	selectAll (void)

void	unregisterDoc (const QString &name)

Signals
void	show_single_result (const QUrl &)

Public Member Functions
	documentation (QWidget *parent, base_qobject &oct_qobj)

	~documentation (void)

QString	title_and_anchor (const QString &title, const QUrl &url)

Private Types
enum	{ max_history_entries = 10 }

Private Slots
void	activate_find (void)

void	filter_update (const QString &expression)

void	filter_update_history (void)

void	find (bool backward=false)

void	find_backward (void)

void	find_forward_from_anchor (const QString &text)

void	global_search (void)

void	global_search_finished (int hits)

void	global_search_started (void)

void	handle_cursor_position_change (void)

void	handle_search_result_clicked (const QUrl &url)

void	open_hist_url (QAction *a)

void	record_anchor_position (void)

void	update_history_menus (void)

Private Member Functions
QAction *	add_action (const QIcon &icon, const QString &text, const char member, QWidget receiver=nullptr, QToolBar *tool_bar=nullptr)

void	construct_tool_bar (void)

void	select_all_occurrences (const QString &text)
	Select all occurrences of a string in the doc browser. More...

void	update_history (int new_count, QAction **actions)

Private Attributes
QAction *	m_action_bookmark

QAction *	m_action_find

QAction *	m_action_go_home

QAction *	m_action_go_next

QAction *	m_action_go_prev

QAction *	m_action_zoom_in

QAction *	m_action_zoom_original

QAction *	m_action_zoom_out

documentation_bookmarks *	m_bookmarks

QString	m_collection

QString	m_current_ref_name

documentation_browser *	m_doc_browser

QWidget *	m_doc_widget

QComboBox *	m_filter

QLineEdit *	m_find_line_edit

QShortcut *	m_findnext_shortcut

QShortcut *	m_findprev_shortcut

QHelpEngine *	m_help_engine

bool	m_indexed

QString	m_internal_search

QAction *	m_next_pages_actions [max_history_entries]

int	m_next_pages_count

QMenu *	m_next_pages_menu

base_qobject &	m_octave_qobj

QAction *	m_prev_pages_actions [max_history_entries]

int	m_prev_pages_count

QMenu *	m_prev_pages_menu

QString	m_query_string

int	m_search_anchor_position

QToolBar *	m_tool_bar

Detailed Description

The documentation main class derived from QSplitter.

Definition at line 99 of file documentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
max_history_entries

Definition at line 192 of file documentation.h.

Constructor & Destructor Documentation

◆ documentation()

octave::documentation::documentation	(	QWidget *	parent,
		base_qobject &	oct_qobj
	)

Definition at line 69 of file documentation.cc.

References octave::documentation_bookmarks::add_bookmark(), construct_tool_bar(), octave::sys::file_ops::dir_sep_str(), filter_update(), filter_update_history(), find(), find_backward(), find_forward_from_anchor(), octave::Utils::fromStdString(), octave::base_qobject::get_resource_manager(), octave::resource_manager::get_settings(), global_search(), global_search_finished(), global_search_started(), handle_cursor_position_change(), octave::documentation_browser::handle_index_clicked(), handle_search_result_clicked(), octave::resource_manager::icon(), link(), load_index(), m_action_bookmark, m_bookmarks, m_collection, m_doc_browser, m_filter, m_find_line_edit, m_findnext_shortcut, m_findprev_shortcut, m_help_engine, m_octave_qobj, m_search_anchor_position, m_tool_bar, notice_settings(), config::oct_doc_dir(), search(), octave::sys::tempnam(), and warning().

◆ ~documentation()

octave::documentation::~documentation ( void )

Definition at line 302 of file documentation.cc.

References octave::fi, m_collection, and octave::sys::recursive_rmdir().

Member Function Documentation

◆ activate_find

void octave::documentation::activate_find ( void )

privateslot

Definition at line 739 of file documentation.cc.

References m_doc_browser, and m_find_line_edit.

Referenced by construct_tool_bar().

◆ add_action()

QAction * octave::documentation::add_action	(	const QIcon &	icon,
		const QString &	text,
		const char *	member,
		QWidget *	receiver = `nullptr`,
		QToolBar *	tool_bar = `nullptr`
	)

private

Definition at line 324 of file documentation.cc.

References m_doc_widget.

Referenced by construct_tool_bar().

◆ construct_tool_bar()

void octave::documentation::construct_tool_bar ( void )

private

◆ copyClipboard

void octave::documentation::copyClipboard ( void )

slot

Definition at line 647 of file documentation.cc.

References m_doc_browser.

Referenced by octave::documentation_dock_widget::copyClipboard().

◆ filter_update

void octave::documentation::filter_update ( const QString & expression )

privateslot

Definition at line 754 of file documentation.cc.

References m_help_engine.

Referenced by documentation().

◆ filter_update_history

void octave::documentation::filter_update_history ( void )

privateslot

Definition at line 766 of file documentation.cc.

References m_filter.

Referenced by documentation().

◆ find

void octave::documentation::find ( bool backward = false )

privateslot

Definition at line 783 of file documentation.cc.

References m_doc_browser, m_find_line_edit, m_help_engine, and record_anchor_position().

Referenced by documentation(), and find_backward().

◆ find_backward

void octave::documentation::find_backward ( void )

privateslot

Definition at line 778 of file documentation.cc.

References find().

Referenced by documentation().

◆ find_forward_from_anchor

void octave::documentation::find_forward_from_anchor ( const QString & text )

privateslot

Definition at line 807 of file documentation.cc.

References m_doc_browser, m_help_engine, and m_search_anchor_position.

Referenced by documentation().

◆ global_search

void octave::documentation::global_search ( void )

privateslot

Definition at line 436 of file documentation.cc.

References m_help_engine, and m_internal_search.

Referenced by documentation().

◆ global_search_finished

void octave::documentation::global_search_finished ( int hits )

privateslot

Definition at line 478 of file documentation.cc.

References handle_search_result_clicked(), m_help_engine, m_internal_search, m_query_string, and show_single_result().

Referenced by documentation().

◆ global_search_started

void octave::documentation::global_search_started ( void )

privateslot

Definition at line 473 of file documentation.cc.

Referenced by documentation().

◆ handle_cursor_position_change

void octave::documentation::handle_cursor_position_change ( void )

privateslot

Definition at line 834 of file documentation.cc.

References m_doc_browser, m_help_engine, and record_anchor_position().

Referenced by documentation().

◆ handle_search_result_clicked

void octave::documentation::handle_search_result_clicked ( const QUrl & url )

privateslot

Definition at line 551 of file documentation.cc.

References octave::documentation_browser::handle_index_clicked(), m_doc_browser, m_find_line_edit, m_query_string, and select_all_occurrences().

Referenced by documentation(), and global_search_finished().

◆ load_index

void octave::documentation::load_index ( void )

slot

Definition at line 659 of file documentation.cc.

References load_ref(), m_current_ref_name, m_doc_browser, m_help_engine, and m_indexed.

Referenced by documentation().

◆ load_ref

void octave::documentation::load_ref ( const QString & name = QString () )

slot

Definition at line 673 of file documentation.cc.

References m_current_ref_name, m_doc_browser, m_help_engine, m_indexed, and m_internal_search.

Referenced by load_index(), and octave::documentation_dock_widget::showDoc().

◆ notice_settings

void octave::documentation::notice_settings ( const gui_settings * settings )

slot

Definition at line 605 of file documentation.cc.

References octave::base_qobject::get_shortcut_manager(), global_icon_size(), global_icon_sizes, m_action_bookmark, m_action_find, m_action_go_home, m_action_go_next, m_action_go_prev, m_action_zoom_in, m_action_zoom_original, m_action_zoom_out, m_doc_browser, m_findnext_shortcut, m_findprev_shortcut, m_help_engine, m_octave_qobj, m_tool_bar, octave::documentation_browser::notice_settings(), sc_doc_bookmark(), sc_doc_go_back(), sc_doc_go_home(), sc_doc_go_next(), sc_edit_edit_find_next(), sc_edit_edit_find_previous(), sc_edit_edit_find_replace(), sc_edit_view_zoom_in(), sc_edit_view_zoom_normal(), sc_edit_view_zoom_out(), octave::shortcut_manager::set_shortcut(), and octave::shortcut_manager::shortcut().

Referenced by documentation(), and octave::documentation_dock_widget::notice_settings().

◆ open_hist_url

void octave::documentation::open_hist_url ( QAction * a )

privateslot

Definition at line 942 of file documentation.cc.

References m_doc_browser.

Referenced by construct_tool_bar().

◆ pasteClipboard

void octave::documentation::pasteClipboard ( void )

slot

Definition at line 655 of file documentation.cc.

Referenced by octave::documentation_dock_widget::pasteClipboard().

◆ record_anchor_position

void octave::documentation::record_anchor_position ( void )

privateslot

Definition at line 826 of file documentation.cc.

References m_doc_browser, m_help_engine, and m_search_anchor_position.

Referenced by find(), and handle_cursor_position_change().

◆ registerDoc

void octave::documentation::registerDoc ( const QString & name )

slot

Definition at line 843 of file documentation.cc.

References m_help_engine, and warning().

Referenced by octave::documentation_dock_widget::registerDoc().

◆ save_settings

void octave::documentation::save_settings ( void )

slot

Definition at line 638 of file documentation.cc.

References octave::base_qobject::get_resource_manager(), octave::resource_manager::get_settings(), m_bookmarks, m_doc_browser, m_octave_qobj, octave::documentation_bookmarks::save_settings(), and octave::documentation_browser::save_settings().

Referenced by octave::documentation_dock_widget::save_settings().

◆ select_all_occurrences()

void octave::documentation::select_all_occurrences ( const QString & text )

private

Select all occurrences of a string in the doc browser.

Definition at line 577 of file documentation.cc.

References format(), and m_doc_browser.

Referenced by handle_search_result_clicked().

◆ selectAll

void octave::documentation::selectAll ( void )

slot

Definition at line 657 of file documentation.cc.

Referenced by octave::documentation_dock_widget::selectAll().

◆ show_single_result

void octave::documentation::show_single_result ( const QUrl & )

signal

Referenced by global_search_finished().

◆ title_and_anchor()

QString octave::documentation::title_and_anchor	(	const QString &	title,
		const QUrl &	url
	)

Generate a string with page name title and current anchor from url for using in prev/next or bookmarks menu:

Parameters

title	current title of the page as QString
url	current url as QUrl

Returns: QString "title: anchor"

Definition at line 949 of file documentation.cc.

Referenced by octave::documentation_bookmarks::add_bookmark(), and update_history().

◆ unregisterDoc

void octave::documentation::unregisterDoc ( const QString & name )

slot

Definition at line 872 of file documentation.cc.

References m_help_engine.

Referenced by octave::documentation_dock_widget::unregisterDoc().

◆ update_history()

void octave::documentation::update_history	(	int	new_count,
		QAction **	actions
	)

private

Definition at line 904 of file documentation.cc.

References m_action_go_next, m_action_go_prev, m_doc_browser, m_next_pages_actions, max_history_entries, and title_and_anchor().

Referenced by update_history_menus().

◆ update_history_menus

void octave::documentation::update_history_menus ( void )

privateslot

Definition at line 887 of file documentation.cc.

References m_doc_browser, m_next_pages_actions, m_next_pages_count, m_prev_pages_actions, m_prev_pages_count, and update_history().

Referenced by construct_tool_bar().

Member Data Documentation

◆ m_action_bookmark

QAction* octave::documentation::m_action_bookmark

private

Definition at line 196 of file documentation.h.

Referenced by documentation(), construct_tool_bar(), and notice_settings().

◆ m_action_find

QAction* octave::documentation::m_action_find

private

Definition at line 198 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_go_home

QAction* octave::documentation::m_action_go_home

private

Definition at line 184 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_go_next

QAction* octave::documentation::m_action_go_next

private

Definition at line 186 of file documentation.h.

Referenced by construct_tool_bar(), notice_settings(), and update_history().

◆ m_action_go_prev

QAction* octave::documentation::m_action_go_prev

private

Definition at line 185 of file documentation.h.

Referenced by construct_tool_bar(), notice_settings(), and update_history().

◆ m_action_zoom_in

QAction* octave::documentation::m_action_zoom_in

private

Definition at line 202 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_zoom_original

QAction* octave::documentation::m_action_zoom_original

private

Definition at line 204 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_zoom_out

QAction* octave::documentation::m_action_zoom_out

private

Definition at line 203 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_bookmarks

documentation_bookmarks* octave::documentation::m_bookmarks

private

Definition at line 171 of file documentation.h.

Referenced by documentation(), and save_settings().

◆ m_collection

QString octave::documentation::m_collection

private

Definition at line 175 of file documentation.h.

Referenced by documentation(), and ~documentation().

◆ m_current_ref_name

QString octave::documentation::m_current_ref_name

private

Definition at line 182 of file documentation.h.

Referenced by load_index(), and load_ref().

◆ m_doc_browser

documentation_browser* octave::documentation::m_doc_browser

private

Definition at line 170 of file documentation.h.

Referenced by documentation(), activate_find(), construct_tool_bar(), copyClipboard(), find(), find_forward_from_anchor(), handle_cursor_position_change(), handle_search_result_clicked(), load_index(), load_ref(), notice_settings(), open_hist_url(), record_anchor_position(), save_settings(), select_all_occurrences(), update_history(), and update_history_menus().

◆ m_doc_widget

QWidget* octave::documentation::m_doc_widget

private

Definition at line 177 of file documentation.h.

Referenced by add_action().

◆ m_filter

QComboBox* octave::documentation::m_filter

private

Definition at line 174 of file documentation.h.

Referenced by documentation(), and filter_update_history().

◆ m_find_line_edit

QLineEdit* octave::documentation::m_find_line_edit

private

Definition at line 172 of file documentation.h.

Referenced by documentation(), activate_find(), find(), and handle_search_result_clicked().

◆ m_findnext_shortcut

QShortcut* octave::documentation::m_findnext_shortcut

private

Definition at line 199 of file documentation.h.

Referenced by documentation(), and notice_settings().

◆ m_findprev_shortcut

QShortcut* octave::documentation::m_findprev_shortcut

private

Definition at line 200 of file documentation.h.

Referenced by documentation(), and notice_settings().

◆ m_help_engine

QHelpEngine* octave::documentation::m_help_engine

private

Definition at line 168 of file documentation.h.

Referenced by documentation(), filter_update(), find(), find_forward_from_anchor(), global_search(), global_search_finished(), handle_cursor_position_change(), load_index(), load_ref(), notice_settings(), record_anchor_position(), registerDoc(), and unregisterDoc().

◆ m_indexed

bool octave::documentation::m_indexed

private

Definition at line 181 of file documentation.h.

Referenced by load_index(), and load_ref().

◆ m_internal_search

QString octave::documentation::m_internal_search

private

Definition at line 169 of file documentation.h.

Referenced by global_search(), global_search_finished(), and load_ref().

◆ m_next_pages_actions

QAction* octave::documentation::m_next_pages_actions[max_history_entries]

private

Definition at line 194 of file documentation.h.

Referenced by construct_tool_bar(), update_history(), and update_history_menus().

◆ m_next_pages_count

int octave::documentation::m_next_pages_count

private

Definition at line 190 of file documentation.h.

Referenced by update_history_menus().

◆ m_next_pages_menu

QMenu* octave::documentation::m_next_pages_menu

private

Definition at line 188 of file documentation.h.

Referenced by construct_tool_bar().

◆ m_octave_qobj

base_qobject& octave::documentation::m_octave_qobj

private

Definition at line 166 of file documentation.h.

Referenced by documentation(), construct_tool_bar(), notice_settings(), and save_settings().

◆ m_prev_pages_actions

QAction* octave::documentation::m_prev_pages_actions[max_history_entries]

private

Definition at line 193 of file documentation.h.

Referenced by construct_tool_bar(), and update_history_menus().

◆ m_prev_pages_count

int octave::documentation::m_prev_pages_count

private

Definition at line 189 of file documentation.h.

Referenced by update_history_menus().

◆ m_prev_pages_menu

QMenu* octave::documentation::m_prev_pages_menu

private

Definition at line 187 of file documentation.h.

Referenced by construct_tool_bar().

◆ m_query_string

QString octave::documentation::m_query_string

private

Definition at line 179 of file documentation.h.

Referenced by global_search_finished(), and handle_search_result_clicked().

◆ m_search_anchor_position

int octave::documentation::m_search_anchor_position

private

Definition at line 173 of file documentation.h.

Referenced by documentation(), find_forward_from_anchor(), and record_anchor_position().

◆ m_tool_bar

QToolBar* octave::documentation::m_tool_bar

private

Definition at line 178 of file documentation.h.

Referenced by documentation(), construct_tool_bar(), and notice_settings().

The documentation for this class was generated from the following files:

libgui/src/documentation.h
libgui/src/documentation.cc

Public Slots

Signals

Public Member Functions

Private Types

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ documentation()

◆ ~documentation()

Member Function Documentation

◆ activate_find

◆ add_action()

◆ construct_tool_bar()

◆ copyClipboard

◆ filter_update

◆ filter_update_history

◆ find

◆ find_backward

◆ find_forward_from_anchor

◆ global_search

◆ global_search_finished

◆ global_search_started

◆ handle_cursor_position_change

◆ handle_search_result_clicked

◆ load_index

◆ load_ref

◆ notice_settings

◆ open_hist_url

◆ pasteClipboard

◆ record_anchor_position

◆ registerDoc

◆ save_settings

◆ select_all_occurrences()

◆ selectAll

◆ show_single_result

◆ title_and_anchor()

◆ unregisterDoc

◆ update_history()

◆ update_history_menus

Member Data Documentation

◆ m_action_bookmark

◆ m_action_find

◆ m_action_go_home

◆ m_action_go_next

◆ m_action_go_prev

◆ m_action_zoom_in

◆ m_action_zoom_original

◆ m_action_zoom_out

◆ m_bookmarks

◆ m_collection

◆ m_current_ref_name

◆ m_doc_browser

◆ m_doc_widget

◆ m_filter

◆ m_find_line_edit

◆ m_findnext_shortcut

◆ m_findprev_shortcut

◆ m_help_engine

◆ m_indexed

◆ m_internal_search

◆ m_next_pages_actions

◆ m_next_pages_count

◆ m_next_pages_menu

◆ m_octave_qobj

◆ m_prev_pages_actions

◆ m_prev_pages_count

◆ m_prev_pages_menu

◆ m_query_string

◆ m_search_anchor_position

◆ m_tool_bar