labplot  2.8.2
About: LabPlot is an application for plotting and analysis of 2D and 3D functions and data. It is a complete rewrite of LabPlot1 and lacks in the first release a lot of features available in the predecessor. On the other hand, the GUI and the usability is more superior.
  Fossies Dox: labplot-2.8.2.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

ReferenceLine Class Reference

A customizable point. More...

#include <ReferenceLine.h>

Inheritance diagram for ReferenceLine:
[legend]
Collaboration diagram for ReferenceLine:
[legend]

Public Types

typedef ReferenceLinePrivate Private
 
- Public Types inherited from WorksheetElement
enum class  Orientation { Horizontal , Vertical }
 
enum class  WorksheetElementName { NameCartesianPlot = 1 }
 
enum class  HorizontalPosition { Left , Center , Right , Custom }
 
enum class  VerticalPosition { Top , Center , Bottom , Custom }
 
enum class  HorizontalAlignment { Left , Center , Right }
 
enum class  VerticalAlignment { Top , Center , Bottom }
 
- Public Types inherited from AbstractAspect
enum class  ChildIndexFlag { IncludeHidden = 0x01 , Recursive = 0x02 , Compress = 0x04 }
 Flags which control numbering scheme of children. More...
 

Public Member Functions

 ReferenceLine (const CartesianPlot *, const QString &)
 
 ~ReferenceLine () override
 
QIcon icon () const override
 
QMenu * createContextMenu () override
 Return a new context menu. More...
 
QGraphicsItem * graphicsItem () const override
 Return the graphics item representing this element. More...
 
void save (QXmlStreamWriter *) const override
 Save as XML. More...
 
bool load (XmlStreamReader *, bool preview) override
 Load from XML. More...
 
void setVisible (bool on) override
 Show/hide the element. More...
 
bool isVisible () const override
 Return whether the element is (at least) partially visible. More...
 
void setPrinting (bool) override
 Switches the printing mode on/off. More...
 
void retransform () override
 Tell the element to newly transform its graphics item into its coordinate system. More...
 
void handleResize (double horizontalRatio, double verticalRatio, bool pageResize) override
 
void orientationChanged (Orientation)
 
void positionChanged (double)
 
void penChanged (const QPen &)
 
void opacityChanged (qreal)
 
void visibleChanged (bool)
 
- Public Member Functions inherited from WorksheetElement
 WorksheetElement (const QString &, AspectType)
 
 ~WorksheetElement () override
 
virtual void setZValue (qreal)
 
virtual bool isFullyVisible () const
 Return whether the element is fully visible (i.e., including all child elements). More...
 
QMenu * createContextMenu () override
 Return a new context menu. More...
 
virtual void loadThemeConfig (const KConfig &)
 
virtual void saveThemeConfig (const KConfig &)
 
void horizontalPaddingChanged (float)
 
void verticalPaddingChanged (float)
 
void rightPaddingChanged (double)
 
void bottomPaddingChanged (double)
 
void symmetricPaddingChanged (double)
 
void hovered ()
 
void unhovered ()
 
- Public Member Functions inherited from AbstractAspect
 AbstractAspect (const QString &name, AspectType type)
 
 ~AbstractAspect () override
 
QString name () const
 
QString comment () const
 
void setCreationTime (const QDateTime &)
 
QDateTime creationTime () const
 
virtual Projectproject ()
 Return the Project this Aspect belongs to, or 0 if it is currently not part of one. More...
 
virtual QString path () const
 Return the path that leads from the top-most Aspect (usually a Project) to me. More...
 
void setHidden (bool)
 Set "hidden" property, i.e. whether to exclude this aspect from being shown in the explorer. More...
 
bool hidden () const
 
void setIsLoading (bool)
 
bool isLoading () const
 
AspectType type () const
 
bool inherits (AspectType type) const
 
AbstractAspectparentAspect () const
 Return my parent Aspect or 0 if I currently don't have one. More...
 
AbstractAspectparent (AspectType type) const
 In the parent-child hierarchy, return the first parent of type. More...
 
void setParentAspect (AbstractAspect *)
 
Folderfolder ()
 Return the folder the Aspect is contained in or 0 if there is none. More...
 
bool isDescendantOf (AbstractAspect *other)
 Return whether the there is a path upwards to the given aspect. More...
 
void addChild (AbstractAspect *)
 Add the given Aspect to my list of children. More...
 
void addChildFast (AbstractAspect *)
 Add the given Aspect to my list of children without any checks and without putting this step onto the undo-stack. More...
 
virtual void finalizeAdd ()
 
QVector< AbstractAspect * > children (AspectType type, ChildIndexFlags flags={}) const
 
void insertChildBefore (AbstractAspect *child, AbstractAspect *before)
 Insert the given Aspect at a specific position in my list of children. More...
 
void insertChildBeforeFast (AbstractAspect *child, AbstractAspect *before)
 Insert the given Aspect at a specific position in my list of children.without any checks and without putting this step onto the undo-stack. More...
 
void reparent (AbstractAspect *newParent, int newIndex=-1)
 Move a child to another parent aspect and transfer ownership. More...
 
void removeChild (AbstractAspect *)
 Remove the given Aspect from my list of children. More...
 
void removeAllChildren ()
 Remove all child Aspects. More...
 
virtual QVector< AbstractAspect * > dependsOn () const
 
virtual bool isDraggable () const
 
virtual QVector< AspectTypedropableOn () const
 
virtual void processDropEvent (const QVector< quintptr > &)
 
template<class T >
T * ancestor () const
 Return the closest ancestor of class T (or NULL if none found). More...
 
template<class T >
QVector< T * > children (ChildIndexFlags flags={}) const
 
template<class T >
T * child (int index, ChildIndexFlags flags={}) const
 
template<class T >
T * child (const QString &name) const
 Get child by name and class. More...
 
template<class T >
int childCount (ChildIndexFlags flags={}) const
 Return the number of child Aspects inheriting from given class. More...
 
template<class T >
int indexOfChild (const AbstractAspect *child, ChildIndexFlags flags={}) const
 Return (0 based) index of child in the list of children inheriting from class T. More...
 
void setSelected (bool)
 
void setUndoAware (bool)
 
virtual QUndoStack * undoStack () const
 Return the undo stack of the Project, or 0 if this Aspect is not part of a Project. More...
 
void exec (QUndoCommand *)
 Execute the given command, pushing it on the undoStack() if available. More...
 
void exec (QUndoCommand *command, const char *preChangeSignal, const char *postChangeSignal, QGenericArgument val0=QGenericArgument(), QGenericArgument val1=QGenericArgument(), QGenericArgument val2=QGenericArgument(), QGenericArgument val3=QGenericArgument())
 Execute command and arrange for signals to be sent before/after it is redone or undone. More...
 
void beginMacro (const QString &text)
 Begin an undo stack macro (series of commands) More...
 
void endMacro ()
 End the current undo stack macro. More...
 

Protected Member Functions

 ReferenceLine (const QString &name, ReferenceLinePrivate *dd)
 
- Protected Member Functions inherited from AbstractAspect
void info (const QString &text)
 Implementations should call this whenever status information should be given to the user. More...
 
bool readBasicAttributes (XmlStreamReader *)
 Load name and creation time from XML. More...
 
void writeBasicAttributes (QXmlStreamWriter *) const
 Save name and creation time to XML. More...
 
void writeCommentElement (QXmlStreamWriter *) const
 Save the comment to XML. More...
 
bool readCommentElement (XmlStreamReader *)
 Load comment from an XML element. More...
 

Protected Attributes

ReferenceLinePrivate *const d_ptr
 
- Protected Attributes inherited from AbstractAspect
const AspectType m_type
 

Private Slots

void orientationChangedSlot (QAction *)
 
void lineStyleChanged (QAction *)
 
void lineColorChanged (QAction *)
 
void visibilityChangedSlot ()
 

Private Member Functions

void init ()
 
void initActions ()
 
void initMenus ()
 

Private Attributes

QAction * visibilityAction {nullptr}
 
QAction * orientationHorizontalAction {nullptr}
 
QAction * orientationVerticalAction {nullptr}
 
QActionGroup * lineStyleActionGroup {nullptr}
 
QActionGroup * lineColorActionGroup {nullptr}
 
QMenu * orientationMenu {nullptr}
 
QMenu * lineMenu {nullptr}
 
QMenu * lineStyleMenu {nullptr}
 
QMenu * lineColorMenu {nullptr}
 

Friends

class ReferenceLineSetPositionCmd
 

Additional Inherited Members

- Public Slots inherited from WorksheetElement
- Public Slots inherited from AbstractAspect
bool setName (const QString &, bool autoUnique=true)
 AbstractAspect::setName sets the name of the abstract aspect. More...
 
void setComment (const QString &)
 
void remove ()
 Remove me from my parent's list of children. More...
 
- Signals inherited from AbstractAspect
void aspectDescriptionAboutToChange (const AbstractAspect *)
 Emitted before the name, comment or caption spec is changed. More...
 
void aspectDescriptionChanged (const AbstractAspect *)
 Emitted after the name, comment or caption spec have changed. More...
 
void aspectAboutToBeAdded (const AbstractAspect *parent, const AbstractAspect *before, const AbstractAspect *child)
 Emitted before a new child is inserted. More...
 
void aspectAdded (const AbstractAspect *)
 Emitted after a new Aspect has been added to the tree. More...
 
void aspectAboutToBeRemoved (const AbstractAspect *)
 Emitted before an aspect is removed from its parent. More...
 
void aspectRemoved (const AbstractAspect *parent, const AbstractAspect *before, const AbstractAspect *child)
 Emitted from the parent after removing a child. More...
 
void aspectHiddenAboutToChange (const AbstractAspect *)
 Emitted before the hidden attribute is changed. More...
 
void aspectHiddenChanged (const AbstractAspect *)
 Emitted after the hidden attribute has changed. More...
 
void statusInfo (const QString &)
 Emitted whenever some aspect in the tree wants to give status information to the user. More...
 
void renameRequested ()
 
void selected (const AbstractAspect *)
 
void deselected (const AbstractAspect *)
 
void childAspectSelectedInView (const AbstractAspect *)
 
void childAspectDeselectedInView (const AbstractAspect *)
 
- Static Public Member Functions inherited from WorksheetElement
static QPainterPath shapeFromPath (const QPainterPath &, const QPen &)
 
- Protected Slots inherited from AbstractAspect
virtual void childSelected (const AbstractAspect *)
 
virtual void childDeselected (const AbstractAspect *)
 

Detailed Description

A customizable point.

File : ReferenceLine.cpp Project : LabPlot

Description : Custom user-defined point on the plot

Copyright : (C) 2020 Alexander Semke (alexa.nosp@m.nder.nosp@m..semk.nosp@m.e@we.nosp@m.b.de)

  • This program 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 2 of the License, or * (at your option) any later version. *
  • This program 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 this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, * Boston, MA 02110-1301 USA *

The position can be either specified by mouse events or by providing the x- and y- coordinates in parent's coordinate system

Definition at line 39 of file ReferenceLine.h.

Member Typedef Documentation

◆ Private

Definition at line 65 of file ReferenceLine.h.

Constructor & Destructor Documentation

◆ ReferenceLine() [1/2]

ReferenceLine::ReferenceLine ( const CartesianPlot plot,
const QString &  name 
)
explicit

Definition at line 54 of file ReferenceLine.cpp.

References init().

◆ ~ReferenceLine()

ReferenceLine::~ReferenceLine ( )
overridedefault

◆ ReferenceLine() [2/2]

ReferenceLine::ReferenceLine ( const QString &  name,
ReferenceLinePrivate dd 
)
protected

Definition at line 60 of file ReferenceLine.cpp.

References init().

Member Function Documentation

◆ createContextMenu()

◆ graphicsItem()

QGraphicsItem * ReferenceLine::graphicsItem ( ) const
overridevirtual

Return the graphics item representing this element.

Implements WorksheetElement.

Definition at line 171 of file ReferenceLine.cpp.

References d_ptr.

◆ handleResize()

void ReferenceLine::handleResize ( double  horizontalRatio,
double  verticalRatio,
bool  pageResize 
)
overridevirtual

Implements WorksheetElement.

Definition at line 180 of file ReferenceLine.cpp.

◆ icon()

QIcon ReferenceLine::icon ( ) const
overridevirtual

Returns an icon to be used in the project explorer.

Reimplemented from AbstractAspect.

Definition at line 89 of file ReferenceLine.cpp.

◆ init()

void ReferenceLine::init ( )
private

◆ initActions()

◆ initMenus()

◆ isVisible()

bool ReferenceLine::isVisible ( ) const
overridevirtual

Return whether the element is (at least) partially visible.

Implements WorksheetElement.

Definition at line 227 of file ReferenceLine.cpp.

References AbstractAspect::d.

Referenced by createContextMenu(), and ReferenceLineDock::load().

◆ lineColorChanged

void ReferenceLine::lineColorChanged ( QAction *  action)
privateslot

◆ lineStyleChanged

void ReferenceLine::lineStyleChanged ( QAction *  action)
privateslot

◆ load()

◆ opacityChanged()

void ReferenceLine::opacityChanged ( qreal  )

◆ orientationChanged()

void ReferenceLine::orientationChanged ( Orientation  )

◆ orientationChangedSlot

void ReferenceLine::orientationChangedSlot ( QAction *  action)
privateslot

◆ penChanged()

void ReferenceLine::penChanged ( const QPen &  )

◆ positionChanged()

void ReferenceLine::positionChanged ( double  )

◆ retransform()

void ReferenceLine::retransform ( )
overridevirtual

Tell the element to newly transform its graphics item into its coordinate system.

This method must not change the undo-aware data of the element, only the graphics item which represents the item is to be updated.

Implements WorksheetElement.

Definition at line 175 of file ReferenceLine.cpp.

References AbstractAspect::d.

Referenced by load().

◆ save()

void ReferenceLine::save ( QXmlStreamWriter *  writer) const
overridevirtual

◆ setPrinting()

void ReferenceLine::setPrinting ( bool  on)
overridevirtual

Switches the printing mode on/off.

Implements WorksheetElement.

Definition at line 232 of file ReferenceLine.cpp.

References AbstractAspect::d.

◆ setVisible()

void ReferenceLine::setVisible ( bool  on)
overridevirtual

Show/hide the element.

Implements WorksheetElement.

Definition at line 222 of file ReferenceLine.cpp.

References AbstractAspect::d, and AbstractAspect::exec().

Referenced by visibilityChangedSlot().

◆ visibilityChangedSlot

void ReferenceLine::visibilityChangedSlot ( )
privateslot

Definition at line 261 of file ReferenceLine.cpp.

References AbstractAspect::d, and setVisible().

Referenced by initActions().

◆ visibleChanged()

void ReferenceLine::visibleChanged ( bool  )

Friends And Related Function Documentation

◆ ReferenceLineSetPositionCmd

friend class ReferenceLineSetPositionCmd
friend

Definition at line 97 of file ReferenceLine.h.

Member Data Documentation

◆ d_ptr

ReferenceLinePrivate* const ReferenceLine::d_ptr
protected

Definition at line 68 of file ReferenceLine.h.

Referenced by graphicsItem().

◆ lineColorActionGroup

QActionGroup* ReferenceLine::lineColorActionGroup {nullptr}
private

Definition at line 82 of file ReferenceLine.h.

Referenced by createContextMenu(), initActions(), initMenus(), and lineColorChanged().

◆ lineColorMenu

QMenu* ReferenceLine::lineColorMenu {nullptr}
private

Definition at line 87 of file ReferenceLine.h.

Referenced by initMenus().

◆ lineMenu

QMenu* ReferenceLine::lineMenu {nullptr}
private

Definition at line 85 of file ReferenceLine.h.

Referenced by createContextMenu(), and initMenus().

◆ lineStyleActionGroup

QActionGroup* ReferenceLine::lineStyleActionGroup {nullptr}
private

Definition at line 81 of file ReferenceLine.h.

Referenced by createContextMenu(), initActions(), and lineStyleChanged().

◆ lineStyleMenu

QMenu* ReferenceLine::lineStyleMenu {nullptr}
private

Definition at line 86 of file ReferenceLine.h.

Referenced by createContextMenu(), and initMenus().

◆ orientationHorizontalAction

QAction* ReferenceLine::orientationHorizontalAction {nullptr}
private

Definition at line 78 of file ReferenceLine.h.

Referenced by createContextMenu(), initActions(), initMenus(), and orientationChangedSlot().

◆ orientationMenu

QMenu* ReferenceLine::orientationMenu {nullptr}
private

Definition at line 84 of file ReferenceLine.h.

Referenced by createContextMenu(), and initMenus().

◆ orientationVerticalAction

QAction* ReferenceLine::orientationVerticalAction {nullptr}
private

Definition at line 79 of file ReferenceLine.h.

Referenced by createContextMenu(), initActions(), and initMenus().

◆ visibilityAction

QAction* ReferenceLine::visibilityAction {nullptr}
private

Definition at line 77 of file ReferenceLine.h.

Referenced by createContextMenu(), and initActions().


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