Open Source 2D CAD
Trim Class Reference

Trims an entity to another entity or trims both entities if this.trimBoth is true. More...

Inheritance diagram for Trim:
Modify EAction RActionAdapter RAction TrimBoth

Public Member Functions

void beginEvent ()
 Called when the user starts this action by clicking a button, choosing a menu, entering a command, etc. More...
void escapeEvent ()
 Called when the user presses Escape or clicks the right mouse button. More...
void getHighlightedEntities ()
void getOperation (void preview)
void isSupportedLimitingShape (void shape)
void isSupportedTrimEntity (void entity)
void pickEntity (void event, void preview)
void setState (void state)
void Trim (void guiAction)
void warnUnsupportedEntity ()
- Public Member Functions inherited from Modify
void deleteSelectedEntities (void msgEntitiesDeleted, void msgNothingDeleted)
void getTitle ()
void Modify (void guiAction)
void slotAutoRefreshChanged (void checked)
void slotClose ()
void slotRefresh ()
- Public Member Functions inherited from EAction
void applyCommand (void event, void preview)
 High level event triggered when a command line command should be applied or previewed. More...
void applyOperation ()
 Applies the operation returned by this.getOperation(). More...
void commandEvent (void event)
 Default implementation. More...
void commandEventPreview (void event)
 Default implementation. More...
void complementOperation (void op)
 Can be reimplemented to complement the operation of an action. More...
void coordinateEvent (void event)
 Default implementation. More...
void coordinateEventPreview (void event)
 Default implementation. More...
void createDialog (void uiFile, void parent)
 Creates a new dialog based on the given UI file with the given parent. More...
void createWidget (void uiFile, void parent)
 Creates a new widget based on the given UI file with the given parent. More...
void EAction (void guiAction)
void enterEvent ()
 Called when user presses enter. More...
void entityPickEvent (void event)
 Default implementation. More...
void entityPickEventPreview (void event)
 Default implementation. More...
void finishEvent ()
 Called when this action is terminated. More...
void getAuxPreview ()
 Called by updatePreview. More...
void getDocumentInterface ()
void getEntityId (void event, void preview, void selectable)
void getGraphicsView ()
void getGraphicsViews ()
void getHighlightedEntities ()
 Called by updatePreview. More...
void getOperation (void preview)
 Called by updatePreview. More...
void getScales ()
void getToolTitle ()
void handlePreviewError ()
 Called by updatePreview. More...
void hideOptionsToolBarWidgets (void widgets, void noSyncWidgets)
 Hides all widgets in the options tool bar which are shown in the tool dialog instead. More...
void hideUiOptions (void saveToSettings)
 Hides the UI options of this action. More...
void initDialog (void dialog)
 Called before dialog is shown. More...
void initState ()
 Called to initialize a new state of this action. More...
void initUiOptions (void resume, void optionsToolBar)
 Overwrite to initialize combo boxes and other UI elements of the options tool bar. More...
void keyPressEvent (void event)
 Called when the user presses a key. More...
void keyReleaseEvent (void event)
 Called when the user releases a key. More...
void mouseDoubleClickEvent (void event)
void mousePressEvent (void event)
 Does nothing. More...
void mouseReleaseEvent (void event)
void pickCoordinate (void event, void preview)
 High level event triggered when a coordinate was specified by the user of a coordinate specification should be previewed. More...
void pickEntity (void event, void preview)
 High level event triggered when an entity was picked by the user or to preview picking an entity. More...
void propertyChangeEvent (void event)
 Allows all actions to handle property change events. More...
void resumeEvent ()
 Called whenver the action resumes its operation, for example after it was temporary suspended for another action. More...
void setArrowCursor ()
 Sets the current cursor of the current document interface (all views attached to it) to the normal arrow cursor. More...
void setCommandPrompt (void prompt)
void setCrosshairCursor ()
 Sets the current cursor of the current document interface (all views attached to it) to crosshair cursor. More...
void setCursor (void cursor, void name)
void setLeftMouseTip (void tip)
void setRightMouseTip (void tip)
void setState (void state)
 Set the state of this action. More...
void setUiOptions (void uiFile, void split)
 Sets the UI options toolbar content for this tool. More...
void showDialog ()
 Show dialog to enter some or all of the options. More...
void showUiOptions (void resume, void restoreFromSettings)
 Shows the UI options of this action if this.uiFile is set. More...
void simulateMouseMoveEvent ()
void slotReset ()
 Called if the user clicks the reset button of an action. More...
void suspendEvent ()
 Called whenver the action is suspended, for example if another action is started while this action is active. More...
void updatePreview (void clear)
 Updates the preview based on the operation returned by getOperation and the auxiliary construction returned be getAuxPreview. More...
- Public Member Functions inherited from RActionAdapter
virtual void commandEvent (RCommandEvent &)
 Called when a command is entered in the command line. More...
virtual void commandEventPreview (RCommandEvent &)
 Called when a command is being edited in the command line. More...
virtual void coordinateEvent (RCoordinateEvent &)
 Called for every coordinate event. More...
virtual void coordinateEventPreview (RCoordinateEvent &)
 Called if the action is in PickCoordinate mode and the mouse is moved around. More...
virtual void entityPickEvent (REntityPickEvent &)
virtual void entityPickEventPreview (REntityPickEvent &)
virtual void keyPressEvent (QKeyEvent &)
virtual void keyReleaseEvent (QKeyEvent &)
virtual void mouseDoubleClickEvent (RMouseEvent &)
 Called on mouse double click events. More...
virtual void mouseMoveEvent (RMouseEvent &)
 Called on mouse move events. More...
virtual void mousePressEvent (RMouseEvent &)
 Called on mouse press events. More...
virtual void mouseReleaseEvent (RMouseEvent &)
 Called on mouse release events. More...
virtual void panGestureEvent (QPanGesture &)
 Called on pan gesture events. More...
virtual void pinchGestureEvent (QPinchGesture &)
 Called on pinch gesture events. More...
virtual void propertyChangeEvent (RPropertyEvent &)
 Called when the value of a property is modified while this action is active. More...
 RActionAdapter (RGuiAction *guiAction=NULL)
virtual void setGraphicsView (RGraphicsView *)
 Called if this action is set as a navigation action of a graphics view. More...
virtual void swipeGestureEvent (QSwipeGesture &)
 Called on swipe gesture events. More...
virtual void tabletEvent (RTabletEvent &)
 Called on tablet events. More...
virtual void wheelEvent (RWheelEvent &)
 Called on mouse wheel events. More...
virtual void zoomChangeEvent (RGraphicsView &)
 Called when the zoom factor or offset changed in the given view. More...
virtual ~RActionAdapter ()
- Public Member Functions inherited from RAction
RAction::ClickMode getClickMode ()
RDocumentgetDocument ()
RDocumentInterfacegetDocumentInterface ()
QList< RGraphicsScene * > getGraphicsScenes ()
virtual RGuiActiongetGuiAction ()
RActiongetOverrideBase ()
RStoragegetStorage ()
QString getUniqueGroup ()
bool hasNoState ()
bool isOverride ()
bool isTerminated ()
 RAction (RGuiAction *guiAction=NULL)
 Copyright (c) 2011-2018 by Andrew Mustun. More...
void setClickMode (RAction::ClickMode m)
 Sets the current click mode. More...
void setDocumentInterface (RDocumentInterface *di)
void setGuiAction (RGuiAction *guiAction)
void setNoState ()
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...
void terminate ()
 Terminates the action. More...
virtual ~RAction ()

Public Attributes

int chooseTrimEntityFirst
int limitingClickPos
int limitingEntity
int trimBoth
int trimClickPos
int trimEntity
- Public Attributes inherited from Modify
int autoRefresh
int copies
- Public Attributes inherited from EAction
int additionalOptionsToolBars
int delegate
int dialogUiFile
int guiAction
int includeBasePath
int optionsToolBarEnabled
int relativeZeroPos
int settingsGroup
int splitUiOptions
int state
int uiFile
int useDialog

Additional Inherited Members

- Public Types inherited from RAction
enum  ClickMode { PickCoordinate, PickCoordinateNoSnap, PickEntity, PickingDisabled }
 Current mouse click mode. More...
- Protected Attributes inherited from RAction
RAction::ClickMode clickMode
bool noState
 Indicates whether this action is stateless (i.e. More...
bool override
bool terminated
QString uniqueGroup

Detailed Description

Trims an entity to another entity or trims both entities if this.trimBoth is true.

Constructor & Destructor Documentation

void Trim::Trim ( void  guiAction)

Member Function Documentation

void Trim::beginEvent ( )

Called when the user starts this action by clicking a button, choosing a menu, entering a command, etc.

Shows the GUI elements that refer to this action as checked. Displays GUI options if this.uiFile is set to a valid UI file. Displays tool help in Help Viewer if available.

Reimplemented from Modify.

Reimplemented in TrimBoth.

void Trim::escapeEvent ( void  )

Called when the user presses Escape or clicks the right mouse button.

Reimplemented from EAction.

void Trim::getHighlightedEntities ( )
void Trim::getOperation ( void  preview)
void Trim::isSupportedLimitingShape ( void  shape)
void Trim::isSupportedTrimEntity ( void  entity)
void Trim::pickEntity ( void  event,
void  preview 
void Trim::setState ( void  state)
void Trim::warnUnsupportedEntity ( )

Member Data Documentation

int Trim::chooseTrimEntityFirst
int Trim::limitingClickPos
int Trim::limitingEntity
int Trim::trimBoth
int Trim::trimClickPos
int Trim::trimEntity

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