octave::Canvas Class Reference

#include "Canvas.h"

Inheritance diagram for octave::Canvas:

Collaboration diagram for octave::Canvas:

Public Types
enum	EventMask { KeyPress = 0x01 , KeyRelease = 0x02 }

Signals
void	gh_callback_event (const graphics_handle &h, const std::string &name)
void	gh_callback_event (const graphics_handle &h, const std::string &name, const octave_value &data)
void	gh_set_event (const graphics_handle &h, const std::string &name, const octave_value &value)
void	gh_set_event (const graphics_handle &h, const std::string &name, const octave_value &value, bool notify_toolkit)
void	gh_set_event (const graphics_handle &h, const std::string &name, const octave_value &value, bool notify_toolkit, bool redraw_figure)
void	interpreter_event (const octave::fcn_callback &fcn)
void	interpreter_event (const octave::meth_callback &meth)

Public Member Functions
virtual	~Canvas (void)=default
void	addEventMask (int m)
void	blockRedraw (bool block=true)
void	clearEventMask (int m)
virtual uint8NDArray	getPixels (void)
void	print (const QString &file_cmd, const QString &term)
virtual QWidget *	qWidget (void)=0
void	redraw (bool sync=false)
void	setCursor (MouseMode mode, std::string fallback, QImage cdata, Matrix hotspot)
void	setEventMask (int m)

Static Public Member Functions
static Canvas *	create (octave::base_qobject &oct_qobj, octave::interpreter &interp, const graphics_handle &handle, QWidget *parent, const std::string &name)

Protected Member Functions
	Canvas (octave::base_qobject &oct_qobj, octave::interpreter &interp, const graphics_handle &handle)
void	canvasAutoAxes (const graphics_handle &handle)
bool	canvasKeyPressEvent (QKeyEvent *event)
bool	canvasKeyReleaseEvent (QKeyEvent *event)
void	canvasMouseDoubleClickEvent (QMouseEvent *event)
void	canvasMouseMoveEvent (QMouseEvent *event)
void	canvasMousePressEvent (QMouseEvent *event)
void	canvasMouseReleaseEvent (QMouseEvent *event)
void	canvasPaintEvent (void)
void	canvasToggleAxes (const graphics_handle &handle)
void	canvasToggleGrid (const graphics_handle &handle)
void	canvasWheelEvent (QWheelEvent *event)
virtual uint8NDArray	do_getPixels (const graphics_handle &handle)=0
virtual void	do_print (const QString &file_cmd, const QString &term, const graphics_handle &handle)=0
virtual void	draw (const graphics_handle &handle)=0
virtual void	drawZoomBox (const QPoint &p1, const QPoint &p2)=0
virtual void	resize (int x, int y, int width, int height)=0
void	select_object (graphics_object obj, QMouseEvent *event, graphics_object &currentObj, graphics_object &axesObj, bool axes_only=false, std::vector< std::string > omit=std::vector< std::string >())
virtual graphics_object	selectFromAxes (const graphics_object &ax, const QPoint &pt)=0
void	updateCurrentPoint (const graphics_object &fig, const graphics_object &obj)
void	updateCurrentPoint (const graphics_object &fig, const graphics_object &obj, QMouseEvent *event)

Protected Attributes
octave::interpreter &	m_interpreter
octave::base_qobject &	m_octave_qobj

Private Member Functions
QCursor	make_cursor (const QString &name, int hot_x=-1, int hot_y=-1)

Private Attributes
bool	m_clickMode
int	m_eventMask
graphics_handle	m_handle
QPoint	m_mouseAnchor
graphics_handle	m_mouseAxes
QPoint	m_mouseCurrent
MouseMode	m_mouseMode
bool	m_rectMode
bool	m_redrawBlocked

Detailed Description

Definition at line 53 of file Canvas.h.

Member Enumeration Documentation

EventMask

enum octave::Canvas::EventMask

Enumerator
KeyPress
KeyRelease

Definition at line 58 of file Canvas.h.

Constructor & Destructor Documentation

~Canvas()

virtual octave::Canvas::~Canvas ( void  )

virtualdefault

Canvas()

octave::Canvas::Canvas ( octave::base_qobject &  oct_qobj, octave::interpreter &  interp, const graphics_handle &  handle  )

inlineprotected

Definition at line 121 of file Canvas.h.

Member Function Documentation

addEventMask()

void octave::Canvas::addEventMask ( int  m )

inline

Definition at line 75 of file Canvas.h.

References m_eventMask.

Referenced by octave::Panel::Panel(), and octave::Figure::update().

blockRedraw()

void octave::Canvas::blockRedraw

(

bool

block = true

)

Definition at line 72 of file Canvas.cc.

References m_redrawBlocked.

Referenced by octave::Figure::beingDeleted().

canvasAutoAxes()

void octave::Canvas::canvasAutoAxes ( const graphics_handle &  handle )

protected

canvasKeyPressEvent()

bool octave::Canvas::canvasKeyPressEvent ( QKeyEvent *  event )

protected

Definition at line 1034 of file Canvas.cc.

References octave_scalar_map::getfield(), gh_callback_event(), gh_set_event(), KeyPress, m_eventMask, m_handle, m_interpreter, octave::Utils::makeKeyEventStruct(), and updateCurrentPoint().

Referenced by octave::GLCanvas::keyPressEvent().

canvasKeyReleaseEvent()

bool octave::Canvas::canvasKeyReleaseEvent ( QKeyEvent *  event )

protected

Definition at line 1065 of file Canvas.cc.

References gh_callback_event(), KeyRelease, m_eventMask, m_handle, m_interpreter, and octave::Utils::makeKeyEventStruct().

Referenced by octave::GLCanvas::keyReleaseEvent().

canvasMouseDoubleClickEvent()

void octave::Canvas::canvasMouseDoubleClickEvent ( QMouseEvent *  event )

protected

Definition at line 542 of file Canvas.cc.

References canvasMousePressEvent().

Referenced by octave::GLCanvas::mouseDoubleClickEvent().

canvasMouseMoveEvent()

void octave::Canvas::canvasMouseMoveEvent ( QMouseEvent *  event )

protected

Definition at line 440 of file Canvas.cc.

References gh_callback_event(), m_handle, m_interpreter, m_mouseAxes, m_mouseCurrent, m_mouseMode, octave::NoMode, octave::pan_mode(), octave::PanMode, octave::Utils::properties(), redraw(), octave::RotateMode, select_object(), octave::TextMode, octave::qt_graphics_toolkit::toolkitObject(), updateCurrentPoint(), octave::Figure::updateStatusBar(), octave::ZoomInMode, and octave::ZoomOutMode.

Referenced by octave::GLCanvas::mouseMoveEvent().

canvasMousePressEvent()

void octave::Canvas::canvasMousePressEvent ( QMouseEvent *  event )

protected

Definition at line 575 of file Canvas.cc.

References octave::autoscale_axes(), octave::button_number(), octave::ContextMenu::executeAt(), octave::Utils::figureSelectionType(), gh_callback_event(), gh_set_event(), m_clickMode, m_handle, m_interpreter, m_mouseAnchor, m_mouseAxes, m_mouseCurrent, m_mouseMode, m_rectMode, octave::Figure::mouseMode(), octave::NoMode, octave::PanMode, octave::Utils::properties(), redraw(), octave::RotateMode, select_object(), octave::TextMode, octave::qt_graphics_toolkit::toolkitObject(), updateCurrentPoint(), octave::ZoomInMode, and octave::ZoomOutMode.

Referenced by canvasMouseDoubleClickEvent(), and octave::GLCanvas::mousePressEvent().

canvasMouseReleaseEvent()

void octave::Canvas::canvasMouseReleaseEvent ( QMouseEvent *  event )

protected

Definition at line 788 of file Canvas.cc.

References annotation_dialog::get_properties(), gh_callback_event(), interpreter_event(), m_clickMode, m_handle, m_interpreter, m_mouseAnchor, m_mouseAxes, m_mouseMode, m_octave_qobj, m_rectMode, max(), min(), octave::NoMode, octave_handle::ok(), ovl(), octave_value_list::prepend(), octave::Utils::properties(), qWidget(), redraw(), octave::TextMode, updateCurrentPoint(), Faddeeva::w(), octave::zoom_mode(), octave::ZoomInMode, and octave::ZoomOutMode.

Referenced by octave::GLCanvas::mouseReleaseEvent().

canvasPaintEvent()

void octave::Canvas::canvasPaintEvent ( void  )

protected

Definition at line 276 of file Canvas.cc.

References draw(), drawZoomBox(), m_handle, m_interpreter, m_mouseAnchor, m_mouseAxes, m_mouseCurrent, m_mouseMode, m_rectMode, m_redrawBlocked, octave_handle::ok(), and octave::ZoomInMode.

Referenced by octave::GLCanvas::paintGL().

canvasToggleAxes()

void octave::Canvas::canvasToggleAxes ( const graphics_handle &  handle )

protected

canvasToggleGrid()

void octave::Canvas::canvasToggleGrid ( const graphics_handle &  handle )

protected

canvasWheelEvent()

void octave::Canvas::canvasWheelEvent ( QWheelEvent *  event )

protected

Definition at line 898 of file Canvas.cc.

References gh_callback_event(), m_handle, m_interpreter, octave::Utils::makeScrollEventStruct(), octave::Figure::mouseMode(), octave::NoMode, Array< T, Alloc >::numel(), octave::pan_enabled(), octave::pan_mode(), octave::PanMode, octave::Utils::properties(), redraw(), selectFromAxes(), octave::qt_graphics_toolkit::toolkitObject(), octave::zoom_enabled(), octave::zoom_mode(), octave::ZoomInMode, and octave::ZoomOutMode.

Referenced by octave::GLCanvas::wheelEvent().

clearEventMask()

void octave::Canvas::clearEventMask ( int  m )

inline

Definition at line 76 of file Canvas.h.

References m_eventMask.

Referenced by octave::Figure::update().

create()

Canvas * octave::Canvas::create ( octave::base_qobject &  oct_qobj, octave::interpreter &  interp, const graphics_handle &  handle, QWidget *  parent, const std::string &  name  )

static

Definition at line 1089 of file Canvas.cc.

Referenced by octave::Container::canvas().

do_getPixels()

virtual uint8NDArray octave::Canvas::do_getPixels ( const graphics_handle &  handle )

protectedpure virtual

Implemented in octave::GLCanvas.

Referenced by getPixels().

do_print()

virtual void octave::Canvas::do_print ( const QString &  file_cmd, const QString &  term, const graphics_handle &  handle  )

protectedpure virtual

Implemented in octave::GLCanvas.

Referenced by print().

draw()

virtual void octave::Canvas::draw ( const graphics_handle &  handle )

protectedpure virtual

Implemented in octave::GLCanvas.

Referenced by canvasPaintEvent().

drawZoomBox()

virtual void octave::Canvas::drawZoomBox ( const QPoint &  p1, const QPoint &  p2  )

protectedpure virtual

Implemented in octave::GLCanvas.

Referenced by canvasPaintEvent().

getPixels()

virtual uint8NDArray octave::Canvas::getPixels ( void  )

inlinevirtual

Definition at line 89 of file Canvas.h.

References do_getPixels(), and m_handle.

Referenced by octave::Figure::slotGetPixels().

gh_callback_event [1/2]

void octave::Canvas::gh_callback_event ( const graphics_handle &  h, const std::string &  name  )

signal

Referenced by canvasKeyPressEvent(), canvasKeyReleaseEvent(), canvasMouseMoveEvent(), canvasMousePressEvent(), canvasMouseReleaseEvent(), and canvasWheelEvent().

gh_callback_event [2/2]

void octave::Canvas::gh_callback_event ( const graphics_handle &  h, const std::string &  name, const octave_value &  data  )

signal

gh_set_event [1/3]

void octave::Canvas::gh_set_event ( const graphics_handle &  h, const std::string &  name, const octave_value &  value  )

signal

Referenced by canvasKeyPressEvent(), canvasMousePressEvent(), and updateCurrentPoint().

gh_set_event [2/3]

void octave::Canvas::gh_set_event ( const graphics_handle &  h, const std::string &  name, const octave_value &  value, bool  notify_toolkit  )

signal

gh_set_event [3/3]

void octave::Canvas::gh_set_event ( const graphics_handle &  h, const std::string &  name, const octave_value &  value, bool  notify_toolkit, bool  redraw_figure  )

signal

interpreter_event [1/2]

void octave::Canvas::interpreter_event ( const octave::fcn_callback &  fcn )

signal

Referenced by octave::Container::canvas(), canvasMouseReleaseEvent(), and octave::GLCanvas::do_print().

interpreter_event [2/2]

void octave::Canvas::interpreter_event ( const octave::meth_callback &  meth )

signal

make_cursor()

QCursor octave::Canvas::make_cursor ( const QString &  name, int  hot_x = -1, int  hot_y = -1  )

private

Definition at line 78 of file Canvas.cc.

References octave::base_qobject::get_resource_manager(), octave::resource_manager::icon(), m_octave_qobj, and name.

Referenced by setCursor().

print()

void octave::Canvas::print ( const QString &  file_cmd, const QString &  term  )

inline

Definition at line 70 of file Canvas.h.

References do_print(), and m_handle.

Referenced by octave::Figure::print().

qWidget()

virtual QWidget * octave::Canvas::qWidget ( void  )

pure virtual

Implemented in octave::GLCanvas.

Referenced by octave::Container::canvas(), canvasMouseReleaseEvent(), octave::Figure::enableMouseTracking(), redraw(), octave::Container::resizeEvent(), setCursor(), and updateCurrentPoint().

redraw()

void octave::Canvas::redraw

(

bool

sync = false

)

Definition at line 58 of file Canvas.cc.

References qWidget(), and Faddeeva::w().

Referenced by canvasMouseMoveEvent(), canvasMousePressEvent(), canvasMouseReleaseEvent(), canvasWheelEvent(), octave::ButtonGroup::redraw(), octave::Figure::redraw(), and octave::Panel::redraw().

resize()

virtual void octave::Canvas::resize ( int  x, int  y, int  width, int  height  )

protectedpure virtual

Implemented in octave::GLCanvas.

select_object()

void octave::Canvas::select_object ( graphics_object  obj, QMouseEvent *  event, graphics_object &  currentObj, graphics_object &  axesObj, bool  axes_only = false, std::vector< std::string >  omit = std::vector<std::string> ()  )

protected

Definition at line 340 of file Canvas.cc.

References m_interpreter, Array< T, Alloc >::numel(), octave::Utils::properties(), and selectFromAxes().

Referenced by canvasMouseMoveEvent(), and canvasMousePressEvent().

selectFromAxes()

virtual graphics_object octave::Canvas::selectFromAxes ( const graphics_object &  ax, const QPoint &  pt  )

protectedpure virtual

Implemented in octave::GLCanvas.

Referenced by canvasWheelEvent(), and select_object().

setCursor()

void octave::Canvas::setCursor	(	MouseMode	mode,
		std::string	fallback,
		QImage	cdata,
		Matrix	hotspot
	)

Definition at line 88 of file Canvas.cc.

References make_cursor(), Matrix, octave::NoMode, octave::PanMode, qWidget(), octave::RotateMode, octave::SelectMode, octave::TextMode, Faddeeva::w(), octave::ZoomInMode, and octave::ZoomOutMode.

Referenced by octave::Figure::update().

setEventMask()

void octave::Canvas::setEventMask ( int  m )

inline

Definition at line 77 of file Canvas.h.

References m_eventMask.

Referenced by octave::Figure::Figure().

updateCurrentPoint() [1/2]

void octave::Canvas::updateCurrentPoint ( const graphics_object &  fig, const graphics_object &  obj  )

protected

Definition at line 221 of file Canvas.cc.

References octave::Utils::figureCurrentPoint(), gh_set_event(), m_interpreter, Array< T, Alloc >::numel(), octave::Utils::properties(), qWidget(), and Faddeeva::w().

updateCurrentPoint() [2/2]

void octave::Canvas::updateCurrentPoint ( const graphics_object &  fig, const graphics_object &  obj, QMouseEvent *  event  )

protected

Definition at line 181 of file Canvas.cc.

References octave::Utils::figureCurrentPoint(), gh_set_event(), m_interpreter, Array< T, Alloc >::numel(), and octave::Utils::properties().

Referenced by canvasKeyPressEvent(), canvasMouseMoveEvent(), canvasMousePressEvent(), and canvasMouseReleaseEvent().

Member Data Documentation

m_clickMode

bool octave::Canvas::m_clickMode

private

Definition at line 166 of file Canvas.h.

Referenced by canvasMousePressEvent(), and canvasMouseReleaseEvent().

m_eventMask

int octave::Canvas::m_eventMask

private

Definition at line 170 of file Canvas.h.

Referenced by addEventMask(), canvasKeyPressEvent(), canvasKeyReleaseEvent(), clearEventMask(), and setEventMask().

m_handle

graphics_handle octave::Canvas::m_handle

private

Definition at line 163 of file Canvas.h.

Referenced by canvasKeyPressEvent(), canvasKeyReleaseEvent(), canvasMouseMoveEvent(), canvasMousePressEvent(), canvasMouseReleaseEvent(), canvasPaintEvent(), canvasWheelEvent(), getPixels(), and print().

m_interpreter

octave::interpreter& octave::Canvas::m_interpreter

protected

Definition at line 157 of file Canvas.h.

Referenced by canvasKeyPressEvent(), canvasKeyReleaseEvent(), canvasMouseMoveEvent(), canvasMousePressEvent(), canvasMouseReleaseEvent(), canvasPaintEvent(), canvasWheelEvent(), octave::GLCanvas::do_getPixels(), octave::GLCanvas::do_print(), octave::GLCanvas::draw(), select_object(), and updateCurrentPoint().

m_mouseAnchor

QPoint octave::Canvas::m_mouseAnchor

private

Definition at line 167 of file Canvas.h.

Referenced by canvasMousePressEvent(), canvasMouseReleaseEvent(), and canvasPaintEvent().

m_mouseAxes

graphics_handle octave::Canvas::m_mouseAxes

private

Definition at line 169 of file Canvas.h.

Referenced by canvasMouseMoveEvent(), canvasMousePressEvent(), canvasMouseReleaseEvent(), and canvasPaintEvent().

m_mouseCurrent

QPoint octave::Canvas::m_mouseCurrent

private

Definition at line 168 of file Canvas.h.

Referenced by canvasMouseMoveEvent(), canvasMousePressEvent(), and canvasPaintEvent().

m_mouseMode

MouseMode octave::Canvas::m_mouseMode

private

Definition at line 165 of file Canvas.h.

Referenced by canvasMouseMoveEvent(), canvasMousePressEvent(), canvasMouseReleaseEvent(), and canvasPaintEvent().

m_octave_qobj

octave::base_qobject& octave::Canvas::m_octave_qobj

protected

Definition at line 156 of file Canvas.h.

Referenced by canvasMouseReleaseEvent(), and make_cursor().

m_rectMode

bool octave::Canvas::m_rectMode

private

Definition at line 171 of file Canvas.h.

Referenced by canvasMousePressEvent(), canvasMouseReleaseEvent(), and canvasPaintEvent().

m_redrawBlocked

bool octave::Canvas::m_redrawBlocked

private

Definition at line 164 of file Canvas.h.

Referenced by blockRedraw(), and canvasPaintEvent().

---

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

• libgui/graphics/Canvas.h
• libgui/graphics/Canvas.cc