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)  

WorksheetElementContainer Class Referenceabstract

Worksheet element container - parent of multiple elements This class provides the functionality for a containers of multiple worksheet elements. Such a container can be a plot or group of elements. More...

#include <WorksheetElementContainer.h>

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

Public Types

typedef WorksheetElementContainerPrivate 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 Slots

void retransform () override
 
void childHovered ()
 
void childUnhovered ()
 
- Public Slots inherited from WorksheetElement
virtual void retransform ()=0
 Tell the element to newly transform its graphics item into its coordinate system. More...
 
- 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...
 

Public Member Functions

 WorksheetElementContainer (const QString &, AspectType)
 
 ~WorksheetElementContainer () override
 
QGraphicsItem * graphicsItem () const override
 Return the graphics item representing this element. More...
 
void setVisible (bool) override
 Show/hide the element. More...
 
bool isVisible () const override
 Return whether the element is (at least) partially visible. More...
 
bool isFullyVisible () const override
 Return whether the element is fully visible (i.e., including all child elements). More...
 
void setPrinting (bool) override
 Switches the printing mode on/off. More...
 
QRectF rect () const
 
virtual void setRect (const QRectF &)=0
 
virtual void prepareGeometryChange ()
 
void handleResize (double horizontalRatio, double verticalRatio, bool pageResize=false) override
 
void visibleChanged (bool)
 
- Public Member Functions inherited from WorksheetElement
 WorksheetElement (const QString &, AspectType)
 
 ~WorksheetElement () override
 
virtual void setZValue (qreal)
 
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
 
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...
 
virtual void save (QXmlStreamWriter *) const =0
 Save as XML. More...
 
virtual bool load (XmlStreamReader *, bool preview)=0
 Load from XML. More...
 

Protected Slots

virtual void handleAspectAdded (const AbstractAspect *)
 
- Protected Slots inherited from AbstractAspect
virtual void childSelected (const AbstractAspect *)
 
virtual void childDeselected (const AbstractAspect *)
 

Protected Member Functions

 WorksheetElementContainer (const QString &, WorksheetElementContainerPrivate *, AspectType)
 
- 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

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

Friends

class WorksheetElementContainerSetVisibleCmd
 

Additional Inherited Members

- 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 &)
 

Detailed Description

Worksheet element container - parent of multiple elements This class provides the functionality for a containers of multiple worksheet elements. Such a container can be a plot or group of elements.

File : WorksheetElementContainer.cpp Project : LabPlot

Description : Worksheet element container - parent of multiple elements

Copyright : (C) 2009 Tilman Benkert (thzs@.nosp@m.gmx..nosp@m.net) Copyright : (C) 2012-2015 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 37 of file WorksheetElementContainer.h.

Member Typedef Documentation

◆ Private

Constructor & Destructor Documentation

◆ WorksheetElementContainer() [1/2]

WorksheetElementContainer::WorksheetElementContainer ( const QString &  name,
AspectType  type 
)

◆ ~WorksheetElementContainer()

WorksheetElementContainer::~WorksheetElementContainer ( )
overridedefault

◆ WorksheetElementContainer() [2/2]

WorksheetElementContainer::WorksheetElementContainer ( const QString &  name,
WorksheetElementContainerPrivate dd,
AspectType  type 
)
protected

Member Function Documentation

◆ childHovered

void WorksheetElementContainer::childHovered ( )
slot

Definition at line 183 of file WorksheetElementContainer.cpp.

References AbstractAspect::d.

Referenced by handleAspectAdded().

◆ childUnhovered

void WorksheetElementContainer::childUnhovered ( )
slot

Definition at line 192 of file WorksheetElementContainer.cpp.

References AbstractAspect::d.

Referenced by handleAspectAdded().

◆ graphicsItem()

QGraphicsItem * WorksheetElementContainer::graphicsItem ( ) const
overridevirtual

◆ handleAspectAdded

◆ handleResize()

void WorksheetElementContainer::handleResize ( double  horizontalRatio,
double  verticalRatio,
bool  pageResize = false 
)
overridevirtual

called if the size of the worksheet page was changed and the content has to be adjusted/resized (pageResize = true) or if a new rectangular for the element container was set (pageResize = false). In the second case, WorksheetElement::handleResize() is called for every worksheet child to adjuste the content to the new size. In the first case, a new rectangular for the container is calculated and set first, which on the other hand, triggers the content adjustments in the container children.

Implements WorksheetElement.

Definition at line 151 of file WorksheetElementContainer.cpp.

References AbstractAspect::d, DEBUG, rect(), and setRect().

Referenced by AbstractPlot::handleResize().

◆ isFullyVisible()

bool WorksheetElementContainer::isFullyVisible ( ) const
overridevirtual

Return whether the element is fully visible (i.e., including all child elements).

The standard implementation returns isVisible().

Reimplemented from WorksheetElement.

Definition at line 116 of file WorksheetElementContainer.cpp.

References AbstractAspect::Compress, and AbstractAspect::IncludeHidden.

◆ isVisible()

bool WorksheetElementContainer::isVisible ( ) const
overridevirtual

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

Implements WorksheetElement.

Definition at line 111 of file WorksheetElementContainer.cpp.

References AbstractAspect::d.

Referenced by CartesianPlot::createContextMenu(), and CartesianPlotDock::load().

◆ prepareGeometryChange()

void WorksheetElementContainer::prepareGeometryChange ( )
virtual

Definition at line 200 of file WorksheetElementContainer.cpp.

References AbstractAspect::d.

Referenced by AxisPrivate::recalcShapeAndBoundingRect().

◆ rect()

◆ retransform

void WorksheetElementContainer::retransform ( )
overrideslot

◆ setPrinting()

void WorksheetElementContainer::setPrinting ( bool  on)
overridevirtual

Switches the printing mode on/off.

Implements WorksheetElement.

Definition at line 125 of file WorksheetElementContainer.cpp.

References AbstractAspect::d.

◆ setRect()

virtual void WorksheetElementContainer::setRect ( const QRectF &  )
pure virtual

◆ setVisible()

void WorksheetElementContainer::setVisible ( bool  on)
overridevirtual

◆ visibleChanged()

void WorksheetElementContainer::visibleChanged ( bool  )

Friends And Related Function Documentation

◆ WorksheetElementContainerSetVisibleCmd

friend class WorksheetElementContainerSetVisibleCmd
friend

Definition at line 74 of file WorksheetElementContainer.h.

Member Data Documentation

◆ d_ptr

WorksheetElementContainerPrivate* const WorksheetElementContainer::d_ptr
protected

Definition at line 64 of file WorksheetElementContainer.h.

Referenced by graphicsItem().


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