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)  

PlotArea Class Reference

Plot area (for background filling and clipping). More...

#include <PlotArea.h>

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

Public Types

enum class  BackgroundType { Color , Image , Pattern }
 
enum class  BackgroundColorStyle {
  SingleColor , HorizontalLinearGradient , VerticalLinearGradient , TopLeftDiagonalLinearGradient ,
  BottomLeftDiagonalLinearGradient , RadialGradient
}
 
enum class  BackgroundImageStyle {
  ScaledCropped , Scaled , ScaledAspectRatio , Centered ,
  Tiled , CenterTiled
}
 
typedef PlotAreaPrivate 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 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)
 
- 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

 PlotArea (const QString &name, CartesianPlot *parent)
 
 ~PlotArea () override
 
QGraphicsItem * graphicsItem () const override
 Return the graphics item representing this element. 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 loadThemeConfig (const KConfig &config) override
 
void saveThemeConfig (const KConfig &config) override
 
bool isHovered () const
 
bool isPrinted () const
 
bool isSelected () const
 
void save (QXmlStreamWriter *) const override
 Save as XML. More...
 
bool load (XmlStreamReader *, bool preview) override
 Load from XML. 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
 
- 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...
 
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
 
virtual QIcon icon () const
 Return an icon to be used for decorating my views. More...
 
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

 PlotArea (const QString &name, CartesianPlot *parent, PlotAreaPrivate *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

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

Private Member Functions

void init ()
 

Private Attributes

CartesianPlotm_parent
 

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

Plot area (for background filling and clipping).

File : PlotArea.cpp Project : LabPlot

Description : Plot area (for background filling and clipping).

Copyright : (C) 2011-2020 by 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 38 of file PlotArea.h.

Member Typedef Documentation

◆ Private

Definition at line 82 of file PlotArea.h.

Member Enumeration Documentation

◆ BackgroundColorStyle

Enumerator
SingleColor 
HorizontalLinearGradient 
VerticalLinearGradient 
TopLeftDiagonalLinearGradient 
BottomLeftDiagonalLinearGradient 
RadialGradient 

Definition at line 46 of file PlotArea.h.

◆ BackgroundImageStyle

Enumerator
ScaledCropped 
Scaled 
ScaledAspectRatio 
Centered 
Tiled 
CenterTiled 

Definition at line 48 of file PlotArea.h.

◆ BackgroundType

Enumerator
Color 
Image 
Pattern 

Definition at line 45 of file PlotArea.h.

Constructor & Destructor Documentation

◆ PlotArea() [1/2]

PlotArea::PlotArea ( const QString &  name,
CartesianPlot parent 
)
explicit

Definition at line 49 of file PlotArea.cpp.

References init().

◆ ~PlotArea()

PlotArea::~PlotArea ( )
overridedefault

◆ PlotArea() [2/2]

PlotArea::PlotArea ( const QString &  name,
CartesianPlot parent,
PlotAreaPrivate dd 
)
protected

Definition at line 56 of file PlotArea.cpp.

References init().

Member Function Documentation

◆ backgroundBrushStyleChanged

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

◆ backgroundColorStyleChanged

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

◆ backgroundFileNameChanged

void PlotArea::backgroundFileNameChanged ( QString &  )
signal

◆ backgroundFirstColorChanged

void PlotArea::backgroundFirstColorChanged ( QColor &  )
signal

◆ backgroundImageStyleChanged

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

◆ backgroundOpacityChanged

void PlotArea::backgroundOpacityChanged ( float  )
signal

◆ backgroundSecondColorChanged

void PlotArea::backgroundSecondColorChanged ( QColor &  )
signal

◆ backgroundTypeChanged

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

◆ borderCornerRadiusChanged

void PlotArea::borderCornerRadiusChanged ( float  )
signal

◆ borderOpacityChanged

void PlotArea::borderOpacityChanged ( float  )
signal

◆ borderPenChanged

void PlotArea::borderPenChanged ( QPen &  )
signal

◆ graphicsItem()

QGraphicsItem * PlotArea::graphicsItem ( ) const
overridevirtual

Return the graphics item representing this element.

Implements WorksheetElement.

Definition at line 96 of file PlotArea.cpp.

References d_ptr.

Referenced by CartesianPlot::init().

◆ handleResize()

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

Implements WorksheetElement.

Definition at line 123 of file PlotArea.cpp.

References AbstractAspect::d, and DEBUG.

◆ init()

void PlotArea::init ( )
private

◆ isHovered()

bool PlotArea::isHovered ( ) const

Definition at line 111 of file PlotArea.cpp.

References CartesianPlot::isHovered(), and m_parent.

Referenced by PlotAreaPrivate::paint().

◆ isPrinted()

bool PlotArea::isPrinted ( ) const

Definition at line 115 of file PlotArea.cpp.

References CartesianPlot::isPrinted(), and m_parent.

Referenced by PlotAreaPrivate::paint().

◆ isSelected()

bool PlotArea::isSelected ( ) const

Definition at line 119 of file PlotArea.cpp.

References CartesianPlot::isSelected(), and m_parent.

Referenced by PlotAreaPrivate::paint().

◆ isVisible()

bool PlotArea::isVisible ( ) const
overridevirtual

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

Implements WorksheetElement.

Definition at line 106 of file PlotArea.cpp.

References AbstractAspect::d.

◆ load()

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

◆ loadThemeConfig()

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

Reimplemented from WorksheetElement.

Definition at line 582 of file PlotArea.cpp.

References black, Color, Worksheet::convertToSceneUnits(), Worksheet::Point, Scaled, SingleColor, and white.

◆ retransform()

void PlotArea::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 134 of file PlotArea.cpp.

◆ save()

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

◆ saveThemeConfig()

void PlotArea::saveThemeConfig ( const KConfig &  config)
overridevirtual

Reimplemented from WorksheetElement.

Definition at line 607 of file PlotArea.cpp.

◆ setPrinting()

void PlotArea::setPrinting ( bool  on)
inlineoverridevirtual

Switches the printing mode on/off.

Implements WorksheetElement.

Definition at line 53 of file PlotArea.h.

◆ setVisible()

void PlotArea::setVisible ( bool  on)
overridevirtual

Show/hide the element.

Implements WorksheetElement.

Definition at line 101 of file PlotArea.cpp.

Member Data Documentation

◆ d_ptr

PlotAreaPrivate* const PlotArea::d_ptr
protected

Definition at line 86 of file PlotArea.h.

Referenced by graphicsItem().

◆ m_parent

CartesianPlot* PlotArea::m_parent
private

Definition at line 106 of file PlotArea.h.

Referenced by isHovered(), isPrinted(), and isSelected().


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