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)  

CartesianPlotLegend Class Reference

Legend for the cartesian plot. More...

#include <CartesianPlotLegend.h>

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

Public Types

typedef CartesianPlotLegendPrivate 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...
 

Signals

void labelFontChanged (QFont &)
 
void labelColorChanged (QColor &)
 
void labelColumnMajorChanged (bool)
 
void lineSymbolWidthChanged (float)
 
void positionChanged (const CartesianPlotLegend::PositionWrapper &)
 
void rotationAngleChanged (qreal)
 
void backgroundTypeChanged (PlotArea::BackgroundType)
 
void backgroundColorStyleChanged (PlotArea::BackgroundColorStyle)
 
void backgroundImageStyleChanged (PlotArea::BackgroundImageStyle)
 
void backgroundBrushStyleChanged (Qt::BrushStyle)
 
void backgroundFirstColorChanged (QColor &)
 
void backgroundSecondColorChanged (QColor &)
 
void backgroundFileNameChanged (QString &)
 
void backgroundOpacityChanged (float)
 
void borderPenChanged (QPen &)
 
void borderCornerRadiusChanged (float)
 
void borderOpacityChanged (float)
 
void layoutTopMarginChanged (float)
 
void layoutBottomMarginChanged (float)
 
void layoutLeftMarginChanged (float)
 
void layoutRightMarginChanged (float)
 
void layoutVerticalSpacingChanged (float)
 
void layoutHorizontalSpacingChanged (float)
 
void layoutColumnCountChanged (int)
 
void positionChanged (QPointF &)
 
void visibilityChanged (bool)
 
- 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 *)
 

Public Member Functions

 CartesianPlotLegend (CartesianPlot *parentPlot, const QString &name)
 
 ~CartesianPlotLegend () 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 loadThemeConfig (const KConfig &config) override
 
void setVisible (bool) 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...
 
TextLabeltitle ()
 
void retransform () override
 Tell the element to newly transform its graphics item into its coordinate system. More...
 
void setZValue (qreal) override
 
void handleResize (double horizontalRatio, double verticalRatio, bool pageResize) override
 
- Public Member Functions inherited from WorksheetElement
 WorksheetElement (const QString &, AspectType)
 
 ~WorksheetElement () override
 
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 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

 CartesianPlotLegend (CartesianPlot *, const QString &name, CartesianPlotLegendPrivate *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

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

Private Slots

void visibilityChangedSlot ()
 

Private Member Functions

void init ()
 
void initActions ()
 

Private Attributes

CartesianPlotm_plot {nullptr}
 
QAction * visibilityAction {nullptr}
 

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...
 
- 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

Legend for the cartesian plot.

File : CartesianPlotLegend.cpp Project : LabPlot

Description : Legend for the cartesian plot

Copyright : (C) 2013-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 *

Definition at line 39 of file CartesianPlotLegend.h.

Member Typedef Documentation

◆ Private

Constructor & Destructor Documentation

◆ CartesianPlotLegend() [1/2]

CartesianPlotLegend::CartesianPlotLegend ( CartesianPlot parentPlot,
const QString &  name 
)

Definition at line 54 of file CartesianPlotLegend.cpp.

References init().

◆ ~CartesianPlotLegend()

CartesianPlotLegend::~CartesianPlotLegend ( )
overridedefault

◆ CartesianPlotLegend() [2/2]

CartesianPlotLegend::CartesianPlotLegend ( CartesianPlot plot,
const QString &  name,
CartesianPlotLegendPrivate dd 
)
protected

Definition at line 60 of file CartesianPlotLegend.cpp.

References init().

Member Function Documentation

◆ backgroundBrushStyleChanged

void CartesianPlotLegend::backgroundBrushStyleChanged ( Qt::BrushStyle  )
signal

◆ backgroundColorStyleChanged

void CartesianPlotLegend::backgroundColorStyleChanged ( PlotArea::BackgroundColorStyle  )
signal

◆ backgroundFileNameChanged

void CartesianPlotLegend::backgroundFileNameChanged ( QString &  )
signal

◆ backgroundFirstColorChanged

void CartesianPlotLegend::backgroundFirstColorChanged ( QColor &  )
signal

◆ backgroundImageStyleChanged

void CartesianPlotLegend::backgroundImageStyleChanged ( PlotArea::BackgroundImageStyle  )
signal

◆ backgroundOpacityChanged

void CartesianPlotLegend::backgroundOpacityChanged ( float  )
signal

◆ backgroundSecondColorChanged

void CartesianPlotLegend::backgroundSecondColorChanged ( QColor &  )
signal

◆ backgroundTypeChanged

void CartesianPlotLegend::backgroundTypeChanged ( PlotArea::BackgroundType  )
signal

◆ borderCornerRadiusChanged

void CartesianPlotLegend::borderCornerRadiusChanged ( float  )
signal

◆ borderOpacityChanged

void CartesianPlotLegend::borderOpacityChanged ( float  )
signal

◆ borderPenChanged

void CartesianPlotLegend::borderPenChanged ( QPen &  )
signal

◆ createContextMenu()

QMenu * CartesianPlotLegend::createContextMenu ( )
overridevirtual

Return a new context menu.

The caller takes ownership of the menu.

Reimplemented from AbstractAspect.

Definition at line 134 of file CartesianPlotLegend.cpp.

References WorksheetElement::createContextMenu(), isVisible(), and visibilityAction.

Referenced by CartesianPlotLegendPrivate::contextMenuEvent().

◆ graphicsItem()

QGraphicsItem * CartesianPlotLegend::graphicsItem ( ) const
overridevirtual

Return the graphics item representing this element.

Implements WorksheetElement.

Definition at line 167 of file CartesianPlotLegend.cpp.

References d_ptr.

◆ handleResize()

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

Implements WorksheetElement.

Definition at line 184 of file CartesianPlotLegend.cpp.

◆ icon()

QIcon CartesianPlotLegend::icon ( ) const
overridevirtual

Returns an icon to be used in the project explorer.

Reimplemented from AbstractAspect.

Definition at line 147 of file CartesianPlotLegend.cpp.

◆ init()

◆ initActions()

void CartesianPlotLegend::initActions ( )
private

Definition at line 128 of file CartesianPlotLegend.cpp.

References i18n, visibilityAction, and visibilityChangedSlot().

Referenced by init().

◆ isVisible()

bool CartesianPlotLegend::isVisible ( ) const
overridevirtual

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

Implements WorksheetElement.

Definition at line 157 of file CartesianPlotLegend.cpp.

References AbstractAspect::d.

Referenced by createContextMenu(), CartesianPlotLegendDock::load(), and CartesianPlotLegendDock::loadConfig().

◆ labelColorChanged

void CartesianPlotLegend::labelColorChanged ( QColor &  )
signal

◆ labelColumnMajorChanged

void CartesianPlotLegend::labelColumnMajorChanged ( bool  )
signal

◆ labelFontChanged

void CartesianPlotLegend::labelFontChanged ( QFont &  )
signal

◆ layoutBottomMarginChanged

void CartesianPlotLegend::layoutBottomMarginChanged ( float  )
signal

◆ layoutColumnCountChanged

void CartesianPlotLegend::layoutColumnCountChanged ( int  )
signal

◆ layoutHorizontalSpacingChanged

void CartesianPlotLegend::layoutHorizontalSpacingChanged ( float  )
signal

◆ layoutLeftMarginChanged

void CartesianPlotLegend::layoutLeftMarginChanged ( float  )
signal

◆ layoutRightMarginChanged

void CartesianPlotLegend::layoutRightMarginChanged ( float  )
signal

◆ layoutTopMarginChanged

void CartesianPlotLegend::layoutTopMarginChanged ( float  )
signal

◆ layoutVerticalSpacingChanged

void CartesianPlotLegend::layoutVerticalSpacingChanged ( float  )
signal

◆ lineSymbolWidthChanged

void CartesianPlotLegend::lineSymbolWidthChanged ( float  )
signal

◆ load()

bool CartesianPlotLegend::load ( XmlStreamReader reader,
bool  preview 
)
overridevirtual

◆ loadThemeConfig()

void CartesianPlotLegend::loadThemeConfig ( const KConfig &  config)
overridevirtual

◆ positionChanged [1/2]

◆ positionChanged [2/2]

void CartesianPlotLegend::positionChanged ( QPointF &  )
signal

◆ retransform()

void CartesianPlotLegend::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 171 of file CartesianPlotLegend.cpp.

References d_ptr, and CartesianPlotLegendPrivate::retransform().

Referenced by CartesianPlot::addLegend(), init(), CartesianPlotPrivate::retransform(), and CartesianPlot::updateLegend().

◆ rotationAngleChanged

void CartesianPlotLegend::rotationAngleChanged ( qreal  )
signal

◆ save()

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

◆ setPrinting()

void CartesianPlotLegend::setPrinting ( bool  on)
overridevirtual

Switches the printing mode on/off.

Implements WorksheetElement.

Definition at line 162 of file CartesianPlotLegend.cpp.

References AbstractAspect::d.

◆ setVisible()

void CartesianPlotLegend::setVisible ( bool  on)
overridevirtual

Show/hide the element.

Implements WorksheetElement.

Definition at line 152 of file CartesianPlotLegend.cpp.

Referenced by visibilityChangedSlot().

◆ setZValue()

void CartesianPlotLegend::setZValue ( qreal  )
overridevirtual

overrides the implementation in WorksheetElement and sets the z-value to the maximal possible, legends are drawn on top of all other object in the plot.

Reimplemented from WorksheetElement.

Definition at line 179 of file CartesianPlotLegend.cpp.

References AbstractAspect::d.

◆ title()

TextLabel * CartesianPlotLegend::title ( )

Definition at line 203 of file CartesianPlotLegend.cpp.

References title().

Referenced by loadThemeConfig(), and title().

◆ visibilityChanged

void CartesianPlotLegend::visibilityChanged ( bool  )
signal

◆ visibilityChangedSlot

void CartesianPlotLegend::visibilityChangedSlot ( )
privateslot

Definition at line 417 of file CartesianPlotLegend.cpp.

References AbstractAspect::d, and setVisible().

Referenced by initActions().

Member Data Documentation

◆ d_ptr

CartesianPlotLegendPrivate* const CartesianPlotLegend::d_ptr
protected

Definition at line 97 of file CartesianPlotLegend.h.

Referenced by graphicsItem(), and retransform().

◆ m_plot

CartesianPlot* CartesianPlotLegend::m_plot {nullptr}
private

◆ visibilityAction

QAction* CartesianPlotLegend::visibilityAction {nullptr}
private

Definition at line 105 of file CartesianPlotLegend.h.

Referenced by createContextMenu(), and initActions().


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