GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Slots | Signals | Public Member Functions | Private Types | Private Slots | Private Member Functions | Private Attributes | List of all members
documentation Class Reference

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

#include "documentation.h"

Inheritance diagram for documentation:
Inheritance graph
[legend]
Collaboration diagram for documentation:
Collaboration graph
[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 98 of file documentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
max_history_entries 

Definition at line 191 of file documentation.h.

Constructor & Destructor Documentation

◆ documentation()

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

Definition at line 70 of file documentation.cc.

References dir_sep_str(), filter_update(), filter_update_history(), find(), find_backward(), find_forward_from_anchor(), Utils::fromStdString(), resource_manager::get_settings(), get_temp_directory(), global_search(), global_search_finished(), global_search_started(), handle_cursor_position_change(), documentation_browser::handle_index_clicked(), handle_search_result_clicked(), resource_manager::icon(), link(), oct_doc_dir(), search(), tempnam(), and warning().

◆ ~documentation()

documentation::~documentation ( void  )

Definition at line 303 of file documentation.cc.

References fi, m_collection, and recursive_rmdir().

Member Function Documentation

◆ activate_find

void documentation::activate_find ( void  )
privateslot

Definition at line 740 of file documentation.cc.

References m_doc_browser, and m_find_line_edit.

Referenced by construct_tool_bar().

◆ add_action()

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

Definition at line 325 of file documentation.cc.

References m_doc_widget, and r.

Referenced by construct_tool_bar().

◆ construct_tool_bar()

void documentation::construct_tool_bar ( void  )
private

Definition at line 348 of file documentation.cc.

References activate_find(), add_action(), base_qobject::get_resource_manager(), resource_manager::icon(), 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_next_pages_actions, m_next_pages_menu, m_octave_qobj, m_prev_pages_actions, m_prev_pages_menu, m_tool_bar, max_history_entries, open_hist_url(), and update_history_menus().

◆ copyClipboard

void documentation::copyClipboard ( void  )
slot

Definition at line 648 of file documentation.cc.

References m_doc_browser.

Referenced by documentation_dock_widget::copyClipboard().

◆ filter_update

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

Definition at line 755 of file documentation.cc.

References m_help_engine.

Referenced by documentation().

◆ filter_update_history

void documentation::filter_update_history ( void  )
privateslot

Definition at line 767 of file documentation.cc.

References m_filter.

Referenced by documentation().

◆ find

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

Definition at line 784 of file documentation.cc.

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

Referenced by find_backward().

◆ find_backward

void documentation::find_backward ( void  )
privateslot

Definition at line 779 of file documentation.cc.

References find().

Referenced by documentation().

◆ find_forward_from_anchor

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

Definition at line 808 of file documentation.cc.

References m_doc_browser, m_help_engine, and m_search_anchor_position.

Referenced by documentation().

◆ global_search

void documentation::global_search ( void  )
privateslot

Definition at line 437 of file documentation.cc.

References m_help_engine, and m_internal_search.

Referenced by documentation().

◆ global_search_finished

void documentation::global_search_finished ( int  hits)
privateslot

Definition at line 479 of file documentation.cc.

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

Referenced by documentation().

◆ global_search_started

void documentation::global_search_started ( void  )
privateslot

Definition at line 474 of file documentation.cc.

Referenced by documentation().

◆ handle_cursor_position_change

void documentation::handle_cursor_position_change ( void  )
privateslot

Definition at line 835 of file documentation.cc.

References m_doc_browser, m_help_engine, and record_anchor_position().

Referenced by documentation().

◆ handle_search_result_clicked

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

Definition at line 552 of file documentation.cc.

References 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 documentation::load_index ( void  )
slot

Definition at line 660 of file documentation.cc.

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

◆ load_ref

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

Definition at line 674 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 documentation_dock_widget::showDoc().

◆ notice_settings

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

Definition at line 606 of file documentation.cc.

References 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, 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(), shortcut_manager::set_shortcut(), and shortcut_manager::shortcut().

Referenced by documentation_dock_widget::notice_settings().

◆ open_hist_url

void documentation::open_hist_url ( QAction *  a)
privateslot

Definition at line 943 of file documentation.cc.

References m_doc_browser.

Referenced by construct_tool_bar().

◆ pasteClipboard

void documentation::pasteClipboard ( void  )
slot

Definition at line 656 of file documentation.cc.

Referenced by documentation_dock_widget::pasteClipboard().

◆ record_anchor_position

void documentation::record_anchor_position ( void  )
privateslot

Definition at line 827 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 documentation::registerDoc ( const QString &  name)
slot

Definition at line 844 of file documentation.cc.

References m_help_engine, and warning().

Referenced by documentation_dock_widget::registerDoc().

◆ save_settings

void documentation::save_settings ( void  )
slot

Definition at line 639 of file documentation.cc.

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

Referenced by documentation_dock_widget::save_settings().

◆ select_all_occurrences()

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

Select all occurrences of a string in the doc browser.

Definition at line 578 of file documentation.cc.

References format(), and m_doc_browser.

Referenced by handle_search_result_clicked().

◆ selectAll

void documentation::selectAll ( void  )
slot

Definition at line 658 of file documentation.cc.

Referenced by documentation_dock_widget::selectAll().

◆ show_single_result

void documentation::show_single_result ( const QUrl &  )
signal

Referenced by global_search_finished().

◆ title_and_anchor()

QString 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
titlecurrent title of the page as QString
urlcurrent url as QUrl
Returns
QString "title: anchor"

Definition at line 950 of file documentation.cc.

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

◆ unregisterDoc

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

Definition at line 873 of file documentation.cc.

References m_help_engine.

Referenced by documentation_dock_widget::unregisterDoc().

◆ update_history()

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

Definition at line 905 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 documentation::update_history_menus ( void  )
privateslot

Definition at line 888 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* documentation::m_action_bookmark
private

Definition at line 195 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_find

QAction* documentation::m_action_find
private

Definition at line 197 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_go_home

QAction* documentation::m_action_go_home
private

Definition at line 183 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_go_next

QAction* documentation::m_action_go_next
private

Definition at line 185 of file documentation.h.

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

◆ m_action_go_prev

QAction* documentation::m_action_go_prev
private

Definition at line 184 of file documentation.h.

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

◆ m_action_zoom_in

QAction* documentation::m_action_zoom_in
private

Definition at line 201 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_zoom_original

QAction* documentation::m_action_zoom_original
private

Definition at line 203 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_action_zoom_out

QAction* documentation::m_action_zoom_out
private

Definition at line 202 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

◆ m_bookmarks

documentation_bookmarks* documentation::m_bookmarks
private

Definition at line 170 of file documentation.h.

Referenced by save_settings().

◆ m_collection

QString documentation::m_collection
private

Definition at line 174 of file documentation.h.

Referenced by ~documentation().

◆ m_current_ref_name

QString documentation::m_current_ref_name
private

Definition at line 181 of file documentation.h.

Referenced by load_index(), and load_ref().

◆ m_doc_browser

documentation_browser* documentation::m_doc_browser
private

Definition at line 169 of file documentation.h.

Referenced by 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* documentation::m_doc_widget
private

Definition at line 176 of file documentation.h.

Referenced by add_action().

◆ m_filter

QComboBox* documentation::m_filter
private

Definition at line 173 of file documentation.h.

Referenced by filter_update_history().

◆ m_find_line_edit

QLineEdit* documentation::m_find_line_edit
private

Definition at line 171 of file documentation.h.

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

◆ m_findnext_shortcut

QShortcut* documentation::m_findnext_shortcut
private

Definition at line 198 of file documentation.h.

Referenced by notice_settings().

◆ m_findprev_shortcut

QShortcut* documentation::m_findprev_shortcut
private

Definition at line 199 of file documentation.h.

Referenced by notice_settings().

◆ m_help_engine

QHelpEngine* documentation::m_help_engine
private

Definition at line 167 of file documentation.h.

Referenced by 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 documentation::m_indexed
private

Definition at line 180 of file documentation.h.

Referenced by load_index(), and load_ref().

◆ m_internal_search

QString documentation::m_internal_search
private

Definition at line 168 of file documentation.h.

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

◆ m_next_pages_actions

QAction* documentation::m_next_pages_actions[max_history_entries]
private

Definition at line 193 of file documentation.h.

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

◆ m_next_pages_count

int documentation::m_next_pages_count
private

Definition at line 189 of file documentation.h.

Referenced by update_history_menus().

◆ m_next_pages_menu

QMenu* documentation::m_next_pages_menu
private

Definition at line 187 of file documentation.h.

Referenced by construct_tool_bar().

◆ m_octave_qobj

base_qobject& documentation::m_octave_qobj
private

Definition at line 165 of file documentation.h.

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

◆ m_prev_pages_actions

QAction* documentation::m_prev_pages_actions[max_history_entries]
private

Definition at line 192 of file documentation.h.

Referenced by construct_tool_bar(), and update_history_menus().

◆ m_prev_pages_count

int documentation::m_prev_pages_count
private

Definition at line 188 of file documentation.h.

Referenced by update_history_menus().

◆ m_prev_pages_menu

QMenu* documentation::m_prev_pages_menu
private

Definition at line 186 of file documentation.h.

Referenced by construct_tool_bar().

◆ m_query_string

QString documentation::m_query_string
private

Definition at line 178 of file documentation.h.

Referenced by global_search_finished(), and handle_search_result_clicked().

◆ m_search_anchor_position

int documentation::m_search_anchor_position
private

Definition at line 172 of file documentation.h.

Referenced by find_forward_from_anchor(), and record_anchor_position().

◆ m_tool_bar

QToolBar* documentation::m_tool_bar
private

Definition at line 177 of file documentation.h.

Referenced by construct_tool_bar(), and notice_settings().

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