octave::documentation_dock_widget Class Reference

#include "documentation-dock-widget.h"

Inheritance diagram for octave::documentation_dock_widget:

Collaboration diagram for octave::documentation_dock_widget:

Public Slots
virtual void	focus (void)
void	handle_active_dock_changed (octave_dock_widget *, octave_dock_widget *)
void	handle_settings (const QSettings *)
virtual void	handle_visibility (bool visible)
QMainWindow *	main_win (void)
void	notice_settings (const QSettings *settings)
void	save_settings (void)

Signals
void	active_changed (bool active)
	Custom signal that tells whether a user has clicked away that dock widget, i.e the active dock widget has changed. More...

Public Member Functions
	documentation_dock_widget (QWidget *parent=nullptr)
	~documentation_dock_widget (void)
virtual void	connect_visibility_changed (void)
void	make_widget (bool dock=true)
void	make_window (void)
void	set_predecessor_widget (octave_dock_widget *prev_widget)
void	set_title (const QString &)

Protected Slots
void	copyClipboard (void)
virtual void	do_undo (void)
	Slot to handle undo. More...
bool	eventFilter (QObject *obj, QEvent *e)
	Event filter for double clicks into the window decoration elements. More...
virtual void	handle_visibility_changed (bool visible)
	Slot to steer changing visibility from outside. More...
void	pasteClipboard (void)
void	registerDoc (const QString &name)
void	selectAll (void)
void	showDoc (const QString &name)
void	unregisterDoc (const QString &name)

Protected Member Functions
virtual void	closeEvent (QCloseEvent *e)
QWidget *	focusWidget (void)

Protected Attributes
QAction *	m_close_action
QToolButton *	m_close_button
QAction *	m_dock_action
QToolButton *	m_dock_button
int	m_icon_size
QWidget *	m_title_widget

Private Attributes
octave::documentation *	m_docs

Detailed Description

Definition at line 31 of file documentation-dock-widget.h.

Constructor & Destructor Documentation

documentation_dock_widget()

octave::documentation_dock_widget::documentation_dock_widget

(

QWidget *

parent = nullptr

)

Definition at line 34 of file documentation-dock-widget.cc.

References m_docs, p, registerDoc(), octave::label_dock_widget::set_title(), showDoc(), and unregisterDoc().

~documentation_dock_widget()

octave::documentation_dock_widget::~documentation_dock_widget

(

void

)

Definition at line 55 of file documentation-dock-widget.cc.

References m_docs.

Member Function Documentation

active_changed

void octave::octave_dock_widget::active_changed ( bool  active )

signalinherited

Custom signal that tells whether a user has clicked away that dock widget, i.e the active dock widget has changed.

Referenced by octave::octave_dock_widget::change_visibility(), octave::workspace_view::closeEvent(), octave::octave_dock_widget::closeEvent(), octave::octave_dock_widget::connect_visibility_changed(), and octave::octave_dock_widget::handle_visibility_changed().

closeEvent()

void octave::octave_dock_widget::closeEvent ( QCloseEvent *  e )

protectedvirtualinherited

Reimplemented in octave::file_editor, and octave::workspace_view.

Definition at line 237 of file octave-dock-widget.cc.

References octave::octave_dock_widget::active_changed(), e, and octave::octave_dock_widget::set_focus_predecessor().

Referenced by octave::variable_editor::closeEvent().

connect_visibility_changed()

void octave::octave_dock_widget::connect_visibility_changed ( void  )

virtualinherited

Definition at line 141 of file octave-dock-widget.cc.

References octave::octave_dock_widget::active_changed(), and octave::octave_dock_widget::handle_visibility().

Referenced by octave::main_window::connect_visibility_changed().

copyClipboard

void octave::documentation_dock_widget::copyClipboard ( void  )

protectedslot

Definition at line 66 of file documentation-dock-widget.cc.

References octave::documentation::copyClipboard(), and m_docs.

do_undo

virtual void octave::label_dock_widget::do_undo ( void  )

inlineprotectedvirtualslotinherited

Slot to handle undo.

Definition at line 59 of file octave-dock-widget.h.

Referenced by octave::label_dock_widget::label_dock_widget().

eventFilter

bool octave::octave_dock_widget::eventFilter ( QObject *  obj, QEvent *  e  )

protectedslotinherited

Event filter for double clicks into the window decoration elements.

Definition at line 345 of file octave-dock-widget.cc.

References e.

focus

virtual void octave::octave_dock_widget::focus ( void  )

inlinevirtualslotinherited

Reimplemented in octave::terminal_dock_widget.

Definition at line 102 of file octave-dock-widget.h.

Referenced by octave::octave_dock_widget::change_floating(), octave::terminal_dock_widget::focus(), octave::file_editor::focus(), octave::octave_dock_widget::handle_visibility(), octave::octave_dock_widget::make_widget(), octave::file_editor::set_focus(), and octave::octave_dock_widget::set_focus_predecessor().

focusWidget()

QWidget * octave::octave_dock_widget::focusWidget ( void  )

protectedinherited

Definition at line 246 of file octave-dock-widget.cc.

References Faddeeva::w().

Referenced by octave::file_editor::editor_tab_has_focus().

handle_active_dock_changed

void octave::octave_dock_widget::handle_active_dock_changed ( octave_dock_widget *  w_old, octave_dock_widget *  w_new  )

slotinherited

Definition at line 304 of file octave-dock-widget.cc.

References octave::octave_dock_widget::m_custom_style, and octave::octave_dock_widget::set_style().

Referenced by octave::octave_dock_widget::octave_dock_widget().

handle_settings

void octave::octave_dock_widget::handle_settings ( const QSettings *  settings )

slotinherited

Definition at line 254 of file octave-dock-widget.cc.

References b, octave::octave_dock_widget::m_bg_color, octave::octave_dock_widget::m_bg_color_active, octave::octave_dock_widget::m_custom_style, octave::octave_dock_widget::m_fg_color, octave::octave_dock_widget::m_fg_color_active, octave::octave_dock_widget::m_icon_color, octave::octave_dock_widget::m_icon_color_active, octave::octave_dock_widget::m_title_3d, octave::label_dock_widget::m_title_widget, octave::octave_dock_widget::notice_settings(), and octave::octave_dock_widget::set_style().

Referenced by octave::octave_dock_widget::octave_dock_widget().

handle_visibility

virtual void octave::octave_dock_widget::handle_visibility ( bool  visible )

inlinevirtualslotinherited

Definition at line 112 of file octave-dock-widget.h.

References octave::octave_dock_widget::focus().

Referenced by octave::octave_dock_widget::connect_visibility_changed(), and octave::history_dock_widget::handle_visibility().

handle_visibility_changed

virtual void octave::octave_dock_widget::handle_visibility_changed ( bool  visible )

inlineprotectedvirtualslotinherited

Slot to steer changing visibility from outside.

Definition at line 132 of file octave-dock-widget.h.

References octave::octave_dock_widget::active_changed().

Referenced by octave::octave_dock_widget::octave_dock_widget(), and octave::terminal_dock_widget::terminal_dock_widget().

main_win

QMainWindow* octave::octave_dock_widget::main_win ( void  )

inlineslotinherited

Definition at line 124 of file octave-dock-widget.h.

References octave::octave_dock_widget::m_parent.

Referenced by octave::file_editor::add_file_editor_tab(), octave::file_editor::construct(), octave::file_editor::empty_script(), octave::files_dock_widget::files_dock_widget(), octave::file_editor::is_editor_console_tabbed(), and octave::variable_editor::tab_to_front().

make_widget()

void octave::octave_dock_widget::make_widget ( bool  dock = true )

inherited

Definition at line 191 of file octave-dock-widget.cc.

References octave::octave_dock_widget::focus(), octave::resource_manager::get_settings(), octave::label_dock_widget::m_dock_action, octave::octave_dock_widget::m_floating, octave::octave_dock_widget::m_icon_color, octave::octave_dock_widget::m_parent, and octave::label_dock_widget::m_title_widget.

Referenced by octave::octave_dock_widget::change_floating(), and octave::main_window::set_window_layout().

make_window()

void octave::octave_dock_widget::make_window ( void  )

inherited

Definition at line 150 of file octave-dock-widget.cc.

References octave::resource_manager::get_settings(), octave::label_dock_widget::m_dock_action, octave::octave_dock_widget::m_floating, octave::octave_dock_widget::m_icon_color, octave::octave_dock_widget::m_parent, octave::label_dock_widget::m_title_widget, and octave::octave_dock_widget::set_focus_predecessor().

Referenced by octave::octave_dock_widget::change_floating(), and octave::main_window::set_window_layout().

notice_settings

void octave::documentation_dock_widget::notice_settings ( const QSettings *  settings )

slot

Definition at line 61 of file documentation-dock-widget.cc.

References m_docs, and octave::documentation::notice_settings().

pasteClipboard

void octave::documentation_dock_widget::pasteClipboard ( void  )

protectedslot

Definition at line 71 of file documentation-dock-widget.cc.

References m_docs, and octave::documentation::pasteClipboard().

registerDoc

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

protectedslot

Definition at line 92 of file documentation-dock-widget.cc.

References m_docs, name, and octave::documentation::registerDoc().

Referenced by documentation_dock_widget().

save_settings

void octave::octave_dock_widget::save_settings ( void  )

slotinherited

Definition at line 321 of file octave-dock-widget.cc.

References octave::resource_manager::get_settings(), octave::octave_dock_widget::m_floating, and name.

Referenced by octave::history_dock_widget::save_settings(), octave::workspace_view::save_settings(), octave::files_dock_widget::save_settings(), and octave::workspace_view::toggle_header().

selectAll

void octave::documentation_dock_widget::selectAll ( void  )

protectedslot

Definition at line 76 of file documentation-dock-widget.cc.

References m_docs, and octave::documentation::selectAll().

set_predecessor_widget()

void octave::octave_dock_widget::set_predecessor_widget ( octave_dock_widget *  prev_widget )

inherited

Definition at line 230 of file octave-dock-widget.cc.

References octave::octave_dock_widget::m_predecessor_widget.

Referenced by octave::main_window::focus_changed().

set_title()

void octave::label_dock_widget::set_title ( const QString &  title )

inherited

Definition at line 93 of file octave-dock-widget.cc.

Referenced by octave::history_dock_widget::construct(), octave::file_editor::construct(), documentation_dock_widget(), octave::files_dock_widget::files_dock_widget(), octave::terminal_dock_widget::terminal_dock_widget(), octave::variable_editor::variable_editor(), and octave::workspace_view::workspace_view().

showDoc

void octave::documentation_dock_widget::showDoc ( const QString &  name )

protectedslot

Definition at line 81 of file documentation-dock-widget.cc.

References octave::documentation::load_ref(), m_docs, and name.

Referenced by documentation_dock_widget().

unregisterDoc

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

protectedslot

Definition at line 97 of file documentation-dock-widget.cc.

References m_docs, name, and octave::documentation::unregisterDoc().

Referenced by documentation_dock_widget().

Member Data Documentation

m_close_action

QAction* octave::label_dock_widget::m_close_action

protectedinherited

Definition at line 68 of file octave-dock-widget.h.

Referenced by octave::label_dock_widget::label_dock_widget(), octave::octave_dock_widget::octave_dock_widget(), octave::octave_dock_widget::set_style(), and octave::variable_dock_widget::variable_dock_widget().

m_close_button

QToolButton* octave::label_dock_widget::m_close_button

protectedinherited

Definition at line 66 of file octave-dock-widget.h.

Referenced by octave::label_dock_widget::label_dock_widget(), and octave::octave_dock_widget::set_style().

m_dock_action

QAction* octave::label_dock_widget::m_dock_action

protectedinherited

Definition at line 67 of file octave-dock-widget.h.

Referenced by octave::label_dock_widget::label_dock_widget(), octave::octave_dock_widget::make_widget(), octave::octave_dock_widget::make_window(), octave::octave_dock_widget::octave_dock_widget(), octave::octave_dock_widget::set_style(), octave::variable_dock_widget::toplevel_change(), and octave::variable_dock_widget::variable_dock_widget().

m_dock_button

QToolButton* octave::label_dock_widget::m_dock_button

protectedinherited

Definition at line 65 of file octave-dock-widget.h.

Referenced by octave::label_dock_widget::label_dock_widget(), and octave::octave_dock_widget::set_style().

m_docs

octave::documentation* octave::documentation_dock_widget::m_docs

private

Definition at line 56 of file documentation-dock-widget.h.

Referenced by copyClipboard(), documentation_dock_widget(), notice_settings(), pasteClipboard(), registerDoc(), selectAll(), showDoc(), unregisterDoc(), and ~documentation_dock_widget().

m_icon_size

int octave::label_dock_widget::m_icon_size

protectedinherited

Definition at line 63 of file octave-dock-widget.h.

Referenced by octave::label_dock_widget::label_dock_widget(), and octave::variable_dock_widget::variable_dock_widget().

m_title_widget

QWidget* octave::label_dock_widget::m_title_widget

protectedinherited

Definition at line 64 of file octave-dock-widget.h.

Referenced by octave::octave_dock_widget::handle_settings(), octave::label_dock_widget::label_dock_widget(), octave::octave_dock_widget::make_widget(), octave::octave_dock_widget::make_window(), and octave::octave_dock_widget::set_style().

---

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

• libgui/src/documentation-dock-widget.h
• libgui/src/documentation-dock-widget.cc