GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
octave::documentation Class Reference

#include "documentation.h"

Inheritance diagram for octave::documentation:
Collaboration diagram for octave::documentation:

Public Slots

void copyClipboard (void)
 
void load_ref (const QString &name)
 
void notice_settings (const QSettings *settings)
 
void pasteClipboard (void)
 
void registerDoc (const QString &name)
 
void selectAll (void)
 
void unregisterDoc (const QString &name)
 

Public Member Functions

 documentation (QWidget *parent=nullptr)
 
 ~documentation (void)
 

Private Slots

void filter_update (const QString &expression)
 
void filter_update_history (void)
 
void find_backward (void)
 
void find_forward (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 record_anchor_position (void)
 

Private Attributes

QString m_collection
 
documentation_browserm_doc_browser
 
QComboBox * m_filter
 
QLineEditm_find_line_edit
 
QHelpEngine * m_help_engine
 
int m_search_anchor_position
 

Detailed Description

Definition at line 61 of file documentation.h.

Constructor & Destructor Documentation

◆ documentation()

◆ ~documentation()

octave::documentation::~documentation ( void  )

Definition at line 250 of file documentation.cc.

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

Member Function Documentation

◆ copyClipboard

void octave::documentation::copyClipboard ( void  )
slot

Definition at line 300 of file documentation.cc.

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

◆ filter_update

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

Definition at line 317 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 329 of file documentation.cc.

References m_filter.

Referenced by documentation().

◆ find_backward

void octave::documentation::find_backward ( void  )
privateslot

Definition at line 350 of file documentation.cc.

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

Referenced by documentation().

◆ find_forward

void octave::documentation::find_forward ( void  )
privateslot

Definition at line 341 of file documentation.cc.

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

Referenced by documentation().

◆ find_forward_from_anchor

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

Definition at line 359 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 275 of file documentation.cc.

References m_help_engine.

Referenced by documentation().

◆ global_search_finished

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

Definition at line 293 of file documentation.cc.

Referenced by documentation().

◆ global_search_started

void octave::documentation::global_search_started ( void  )
privateslot

Definition at line 288 of file documentation.cc.

Referenced by documentation().

◆ handle_cursor_position_change

void octave::documentation::handle_cursor_position_change ( void  )
privateslot

Definition at line 378 of file documentation.cc.

References m_doc_browser, m_help_engine, and record_anchor_position().

Referenced by documentation().

◆ load_ref

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

Definition at line 306 of file documentation.cc.

References m_doc_browser, and m_help_engine.

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

◆ notice_settings

void octave::documentation::notice_settings ( const QSettings *  settings)
slot

◆ pasteClipboard

void octave::documentation::pasteClipboard ( void  )
slot

Definition at line 302 of file documentation.cc.

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

◆ record_anchor_position

void octave::documentation::record_anchor_position ( void  )
privateslot

◆ registerDoc

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

Definition at line 387 of file documentation.cc.

References arg, m_help_engine, and warning().

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

◆ selectAll

void octave::documentation::selectAll ( void  )
slot

◆ unregisterDoc

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

Definition at line 417 of file documentation.cc.

References m_help_engine.

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

Member Data Documentation

◆ m_collection

QString octave::documentation::m_collection
private

Definition at line 102 of file documentation.h.

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

◆ m_doc_browser

◆ m_filter

QComboBox* octave::documentation::m_filter
private

Definition at line 101 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 99 of file documentation.h.

Referenced by documentation(), find_backward(), and find_forward().

◆ m_help_engine

◆ m_search_anchor_position

int octave::documentation::m_search_anchor_position
private

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