octave::documentation_browser Class Reference

Documentation browser derived from Textbrowser. More...

#include "documentation.h"

Inheritance diagram for octave::documentation_browser:

Collaboration diagram for octave::documentation_browser:

Public Slots
void	handle_index_clicked (const QUrl &url, const QString &keyword=QString())
void	notice_settings (const gui_settings *settings)
void	zoom_in (void)
	Zooming in and out while taking care of the zoom level. More...
void	zoom_out (void)
	Zooming in and out while taking care of the zoom level. More...
void	zoom_original (void)
	Zooming in and out while taking care of the zoom level. More...

Public Member Functions
	documentation_browser (QHelpEngine *help_engine, QWidget *parent=nullptr)
	~documentation_browser (void)
virtual QVariant	loadResource (int type, const QUrl &url)

Protected Member Functions
void	wheelEvent (QWheelEvent *we)

Private Types
enum	{ min_zoom_level = -5 , max_zoom_level = 10 }
	Minimal and maximal zoom level avoiding calling zoom_in and zoom_out without actually zooming but with changing the stored zoom level. More...

Private Attributes
QHelpEngine *	m_help_engine
int	m_zoom_level
	Store the current zoom level. More...

Detailed Description

Documentation browser derived from Textbrowser.

Definition at line 47 of file documentation.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Minimal and maximal zoom level avoiding calling zoom_in and zoom_out without actually zooming but with changing the stored zoom level.

Enumerator
min_zoom_level
max_zoom_level

Definition at line 85 of file documentation.h.

Constructor & Destructor Documentation

documentation_browser()

octave::documentation_browser::documentation_browser	(	QHelpEngine *	help_engine,
		QWidget *	parent = nullptr
	)

Definition at line 929 of file documentation.cc.

References handle_index_clicked().

~documentation_browser()

octave::documentation_browser::~documentation_browser

(

void

)

Definition at line 937 of file documentation.cc.

Member Function Documentation

handle_index_clicked

void octave::documentation_browser::handle_index_clicked ( const QUrl &  url, const QString &  keyword = QString ()  )

slot

Definition at line 940 of file documentation.cc.

Referenced by documentation_browser(), and octave::documentation::handle_search_result_clicked().

loadResource()

QVariant octave::documentation_browser::loadResource ( int  type, const QUrl &  url  )

virtual

Definition at line 952 of file documentation.cc.

References m_help_engine.

notice_settings

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

slot

Definition at line 949 of file documentation.cc.

wheelEvent()

void octave::documentation_browser::wheelEvent ( QWheelEvent *  we )

protected

Definition at line 984 of file documentation.cc.

References octave::we, zoom_in(), and zoom_out().

zoom_in

void octave::documentation_browser::zoom_in ( void  )

slot

Zooming in and out while taking care of the zoom level.

Definition at line 960 of file documentation.cc.

References m_zoom_level, and max_zoom_level.

Referenced by wheelEvent().

zoom_original

void octave::documentation_browser::zoom_original ( void  )

slot

Zooming in and out while taking care of the zoom level.

Definition at line 978 of file documentation.cc.

References m_zoom_level.

zoom_out

void octave::documentation_browser::zoom_out ( void  )

slot

Zooming in and out while taking care of the zoom level.

Definition at line 969 of file documentation.cc.

References m_zoom_level, and min_zoom_level.

Referenced by wheelEvent().

Member Data Documentation

m_help_engine

QHelpEngine* octave::documentation_browser::m_help_engine

private

Definition at line 77 of file documentation.h.

Referenced by loadResource().

m_zoom_level

int octave::documentation_browser::m_zoom_level

private

Store the current zoom level.

Definition at line 80 of file documentation.h.

Referenced by zoom_in(), zoom_original(), and zoom_out().

---

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

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