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)  

Note Class Reference

#include <Note.h>

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

Signals

void backgroundColorChanged (QColor)
 
void textColorChanged (QColor)
 
void textFontChanged (QFont)
 
- Signals inherited from AbstractPart
void showRequested ()
 
void importFromFileRequested ()
 
void importFromSQLDatabaseRequested ()
 
void exportRequested ()
 
void printRequested ()
 
void printPreviewRequested ()
 
- 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

 Note (const QString &name)
 
QWidget * view () const override
 Construct a primary view on me. More...
 
QIcon icon () const override
 Return an icon to be used for decorating my views. More...
 
bool exportView () const override
 
bool printView () override
 
bool printPreview () const override
 
void setNote (const QString &)
 
void setText (const QString &s)
 
const QString & note () const
 
void setBackgroundColor (const QColor &)
 
const QColor & backgroundColor () const
 
void setTextColor (const QColor &)
 
const QColor & textColor () const
 
void setTextFont (const QFont &)
 
const QFont & textFont () const
 
void save (QXmlStreamWriter *) const override
 Save as XML. More...
 
bool load (XmlStreamReader *, bool preview) override
 Load from XML. More...
 
- Public Member Functions inherited from AbstractPart
 AbstractPart (const QString &name, AspectType type)
 
 ~AbstractPart () override
 
void deleteView () const
 
PartMdiViewmdiSubWindow () const
 Wrap the view() into a PartMdiView. More...
 
bool hasMdiSubWindow () const
 
QMenu * createContextMenu () override
 Return AbstractAspect::createContextMenu() plus operations on the primary view. More...
 
bool isDraggable () const override
 
QVector< AspectTypedropableOn () const override
 
virtual void registerShortcuts ()
 
virtual void unregisterShortcuts ()
 
- 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 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...
 

Private Attributes

NoteViewm_view {nullptr}
 
QColor m_backgroundColor
 
QColor m_textColor
 
QFont m_textFont
 
QString m_note
 

Additional Inherited Members

- Public Types inherited from AbstractAspect
enum class  ChildIndexFlag { IncludeHidden = 0x01 , Recursive = 0x02 , Compress = 0x04 }
 Flags which control numbering scheme of children. 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...
 
- Protected Slots inherited from AbstractAspect
virtual void childSelected (const AbstractAspect *)
 
virtual void childDeselected (const AbstractAspect *)
 
- 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 inherited from AbstractPart
QWidget * m_partView {nullptr}
 
- Protected Attributes inherited from AbstractAspect
const AspectType m_type
 

Detailed Description

Definition at line 41 of file Note.h.

Constructor & Destructor Documentation

◆ Note()

Note::Note ( const QString &  name)
explicit

File : Notes.cpp Project : LabPlot

Description : Notes Widget for taking notes

Copyright : (C) 2009-2015 Garvit Khatri (garvi.nosp@m.tdel.nosp@m.hi@gm.nosp@m.ail..nosp@m.com) Copyright : (C) 2016 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 44 of file Note.cpp.

References black, m_backgroundColor, m_textColor, and m_textFont.

Member Function Documentation

◆ backgroundColor()

const QColor & Note::backgroundColor ( ) const

◆ backgroundColorChanged

void Note::backgroundColorChanged ( QColor  )
signal

◆ exportView()

bool Note::exportView ( ) const
overridevirtual

Implements AbstractPart.

Definition at line 75 of file Note.cpp.

◆ icon()

QIcon Note::icon ( ) const
overridevirtual

Return an icon to be used for decorating my views.

Reimplemented from AbstractAspect.

Definition at line 53 of file Note.cpp.

◆ load()

bool Note::load ( XmlStreamReader ,
bool  preview 
)
overridevirtual

Load from XML.

XmlStreamReader supports errors as well as warnings. If only warnings (non-critical errors) occur, this function must return the reader at the end element corresponding to the current element at the time the function was called.

This function is normally intended to be called directly after the ctor. If you want to call load on an aspect that has been altered, you must make sure beforehand that it is in the same state as after creation, e.g., remove all its child aspects.

Returns
false on error

Implements AbstractAspect.

Definition at line 144 of file Note.cpp.

References i18n, m_backgroundColor, m_note, m_textColor, m_textFont, XmlStreamReader::raiseError(), READ_QCOLOR, READ_QFONT, AbstractAspect::readBasicAttributes(), and AbstractAspect::readCommentElement().

Referenced by Folder::readChildAspectElement().

◆ note()

const QString & Note::note ( ) const

Definition at line 83 of file Note.cpp.

References m_note.

Referenced by NoteView::NoteView(), and setNote().

◆ printPreview()

bool Note::printPreview ( ) const
overridevirtual

Implements AbstractPart.

Definition at line 69 of file Note.cpp.

References m_view, and NoteView::print().

◆ printView()

bool Note::printView ( )
overridevirtual

Implements AbstractPart.

Definition at line 57 of file Note.cpp.

References m_view, and NoteView::print().

◆ save()

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

◆ setBackgroundColor()

void Note::setBackgroundColor ( const QColor &  color)

Definition at line 87 of file Note.cpp.

References backgroundColorChanged(), and m_backgroundColor.

◆ setNote()

void Note::setNote ( const QString &  note)

Definition at line 79 of file Note.cpp.

References m_note, and note().

Referenced by OriginProjectParser::loadNote(), setText(), and NoteView::textChanged().

◆ setText()

void Note::setText ( const QString &  s)
inline

Definition at line 55 of file Note.h.

References setNote().

Referenced by OriginProjectParser::loadFolder().

◆ setTextColor()

void Note::setTextColor ( const QColor &  color)

Definition at line 96 of file Note.cpp.

References m_textColor, and textColorChanged().

◆ setTextFont()

void Note::setTextFont ( const QFont &  font)

Definition at line 105 of file Note.cpp.

References m_textFont, and textFontChanged().

◆ textColor()

const QColor & Note::textColor ( ) const

Definition at line 101 of file Note.cpp.

References m_textColor.

Referenced by NoteDock::loadConfigFromTemplate(), NoteView::NoteView(), and NoteDock::setNotesList().

◆ textColorChanged

void Note::textColorChanged ( QColor  )
signal

Referenced by NoteView::NoteView(), and setTextColor().

◆ textFont()

const QFont & Note::textFont ( ) const

Definition at line 110 of file Note.cpp.

References m_textFont.

Referenced by NoteDock::loadConfigFromTemplate(), NoteView::NoteView(), and NoteDock::setNotesList().

◆ textFontChanged

void Note::textFontChanged ( QFont  )
signal

Referenced by NoteView::NoteView(), and setTextFont().

◆ view()

QWidget * Note::view ( ) const
overridevirtual

Construct a primary view on me.

The caller receives ownership of the view.

This method may be called multiple times during the life time of a Part, or it might not get called at all. Parts must not depend on the existence of a view for their operation.

Implements AbstractPart.

Definition at line 114 of file Note.cpp.

References AbstractPart::m_partView, and m_view.

Member Data Documentation

◆ m_backgroundColor

QColor Note::m_backgroundColor
private

Definition at line 77 of file Note.h.

Referenced by backgroundColor(), load(), Note(), save(), and setBackgroundColor().

◆ m_note

QString Note::m_note
private

Definition at line 80 of file Note.h.

Referenced by load(), note(), save(), and setNote().

◆ m_textColor

QColor Note::m_textColor
private

Definition at line 78 of file Note.h.

Referenced by load(), Note(), save(), setTextColor(), and textColor().

◆ m_textFont

QFont Note::m_textFont
private

Definition at line 79 of file Note.h.

Referenced by load(), Note(), save(), setTextFont(), and textFont().

◆ m_view

NoteView* Note::m_view {nullptr}
mutableprivate

Definition at line 76 of file Note.h.

Referenced by printPreview(), printView(), and view().


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