#include <RScriptAction.h>

Inheritance diagram for RScriptAction:

Public Member Functions
QString	getScriptFile ()

	RScriptAction (const QString &scriptFile, RGuiAction *guiAction)
	Copyright (c) 2011-2018 by Andrew Mustun. More...

Public Member Functions inherited from RAction
virtual void	applyOperation ()=0

virtual void	beginEvent ()=0
	Called as soon as the action is created (menu chosen, toolbutton activated, etc). More...

virtual void	commandEvent (RCommandEvent &event)=0
	Called when a command is entered in the command line. More...

virtual void	commandEventPreview (RCommandEvent &event)=0
	Called when a command is being edited in the command line. More...

virtual void	coordinateEvent (RCoordinateEvent &event)=0
	Called for every coordinate event. More...

virtual void	coordinateEventPreview (RCoordinateEvent &event)=0
	Called if the action is in `PickCoordinate` mode and the mouse is moved around. More...

virtual void	enterEvent ()=0
	Called when user presses enter (e.g. More...

virtual void	entityPickEvent (REntityPickEvent &event)=0

virtual void	entityPickEventPreview (REntityPickEvent &event)=0

virtual void	escapeEvent ()=0
	Escape events are triggered if the user clicks the right mouse button or hits the Escape key. More...

virtual void	finishEvent ()=0
	Called just before the action is deleted. More...

RAction::ClickMode	getClickMode ()

RDocument *	getDocument ()

RDocumentInterface *	getDocumentInterface ()

QList< RGraphicsScene * >	getGraphicsScenes ()

virtual RGuiAction *	getGuiAction ()

RAction *	getOverrideBase ()

RStorage *	getStorage ()

QString	getUniqueGroup ()

bool	hasNoState ()

bool	isOverride ()

bool	isTerminated ()

virtual void	keyPressEvent (QKeyEvent &event)=0

virtual void	keyReleaseEvent (QKeyEvent &event)=0

virtual void	mouseDoubleClickEvent (RMouseEvent &event)=0
	Called on mouse double click events. More...

virtual void	mouseMoveEvent (RMouseEvent &event)=0
	Called on mouse move events. More...

virtual void	mousePressEvent (RMouseEvent &event)=0
	Called on mouse press events. More...

virtual void	mouseReleaseEvent (RMouseEvent &event)=0
	Called on mouse release events. More...

virtual void	panGestureEvent (QPanGesture &gesture)=0
	Called on pan gesture events. More...

virtual void	pinchGestureEvent (QPinchGesture &gesture)=0
	Called on pinch gesture events. More...

virtual void	propertyChangeEvent (RPropertyEvent &event)=0
	Called when the value of a property is modified while this action is active. More...

	RAction (RGuiAction *guiAction=NULL)
	Copyright (c) 2011-2018 by Andrew Mustun. More...

virtual void	resumeEvent ()=0
	Resumes the action (for example when another action became active and then terminated or if the mouse cursor enters the view). More...

void	setClickMode (RAction::ClickMode m)
	Sets the current click mode. More...

void	setDocumentInterface (RDocumentInterface *di)

virtual void	setGraphicsView (RGraphicsView *view)=0
	Called if this action is set as a navigation action of a graphics view. More...

void	setGuiAction (RGuiAction *guiAction)

void	setNoState (bool on=true)

void	setOverride ()

void	setOverrideBase (RAction *base)

void	setUniqueGroup (const QString &ug)

RVector	snap (RMouseEvent &event)
	Uses the currently active snap function to snap to the closest object or grid point. More...

virtual void	suspendEvent ()=0
	Called when the action is suspended, for example when another action becomes active or the mouse cursor leaves the view. More...

virtual void	swipeGestureEvent (QSwipeGesture &gesture)=0
	Called on swipe gesture events. More...

virtual void	tabletEvent (RTabletEvent &event)=0
	Called on tablet events. More...

void	terminate ()
	Terminates the action. More...

virtual void	updatePreview ()=0

virtual void	wheelEvent (RWheelEvent &event)=0
	Called on mouse wheel events. More...

virtual void	zoomChangeEvent (RGraphicsView &view)=0
	Called when the zoom factor or offset changed in the given view. More...

virtual	~RAction ()

Protected Attributes
QString	scriptFile

Protected Attributes inherited from RAction
RAction::ClickMode	clickMode

RDocumentInterface *	documentInterface

RGuiAction *	guiAction

bool	noState
	Indicates whether this action is stateless (i.e. More...

bool	override

RAction *	overrideBase

bool	terminated

QString	uniqueGroup

Additional Inherited Members
Public Types inherited from RAction
enum	ClickMode { PickCoordinate, PickCoordinateNoSnap, PickEntity, PickingDisabled }
	Current mouse click mode. More...

Detailed Description

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD. Script backed action.

Scriptable:\nThis class is available in script environments.\n: \abstract

Constructor & Destructor Documentation

◆ RScriptAction()

RScriptAction::RScriptAction	(	const QString &	scriptFile,
		RGuiAction *	guiAction
	)

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.

Member Function Documentation

◆ getScriptFile()

QString RScriptAction::getScriptFile ( )

inline

Member Data Documentation

◆ scriptFile

QString RScriptAction::scriptFile

protected

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

src/core/RScriptAction.h
src/core/RScriptAction.cpp

Public Member Functions

Protected Attributes