wxMaxima
Classes | Public Member Functions | Static Public Attributes | List of all members
AnimationCell Class Referencefinal
Inheritance diagram for AnimationCell:
Inheritance graph
[legend]
Collaboration diagram for AnimationCell:
Collaboration graph
[legend]

Classes

class  GifDataObject
 A Gif object for the clipboard. More...
 

Public Member Functions

 AnimationCell (GroupCell *group, Configuration **config, std::shared_ptr< wxFileSystem > filesystem, int framerate=-1)
 
 AnimationCell (GroupCell *group, Configuration **config, int framerate=-1)
 
 AnimationCell (GroupCell *group, const AnimationCell &cell)
 
 AnimationCell (GroupCell *group, Configuration **config, const wxMemoryBuffer &image, const wxString &type)
 A constructor that loads the compressed file from a wxMemoryBuffer.
 
 AnimationCell (GroupCell *group, Configuration **config, const wxString &image, bool remove)
 
std::unique_ptr< CellCopy (GroupCell *group) const override
 
void operator= (const AnimationCell &)=delete
 
 AnimationCell (const AnimationCell &)=delete
 
void SetConfiguration (Configuration **config) override
 
int GetPPI () const override
 
size_t GetOriginalWidth () const override
 
size_t GetOriginalHeight () const override
 
wxString GetExtension () const override
 Returns the file name extension that matches the image type.
 
const CellTypeInfoGetInfo () override
 Returns the information about this cell's type.
 
int Length () const
 
void LoadImages (wxMemoryBuffer imageData)
 
void LoadImages (wxString imageFile)
 
void SetPPI (int ppi) override
 Set the animation's resolution.
 
bool CanExportSVG () const override
 Can the current image be exported in SVG format?
 
bool IsOk () const
 
const wxString & GetToolTip (wxPoint point) const override
 
void ClearCache () override
 
void LoadImages (wxArrayString images, bool deleteRead)
 
int GetDisplayedIndex () const
 
wxImage GetBitmap (int n) const
 
void SetDisplayedIndex (int ind)
 
wxSize ToImageFile (wxString file) override
 Exports the image the animation currently displays.
 
wxSize ToGif (wxString file)
 Exports the whole animation as animated gif.
 
bool CopyToClipboard () const override
 Copies the cell to the system's clipboard.
 
bool CopyAnimationToClipboard ()
 Put the animation on the clipboard.
 
int GetFrameRate () const
 
void ReloadTimer ()
 
void StopTimer ()
 
int SetFrameRate (int Freq)
 
bool AnimationRunning () const
 
void AnimationRunning (bool run)
 
bool CanPopOut () const override
 Can this cell be popped out interactively in gnuplot?
 
void GnuplotSource (int image, wxString gnuplotFilename, wxString dataFilename, std::shared_ptr< wxFileSystem > filesystem)
 
wxString GnuplotSource () const override
 The name of the file with gnuplot commands that created this file.
 
- Public Member Functions inherited from ImgCellBase
 ImgCellBase (GroupCell *group, Configuration **config)
 
ImgCellBaseoperator= (const ImgCellBase &)=delete
 This class can be derived from wxAccessible which has no copy constructor.
 
- Public Member Functions inherited from Cell
 Cell (GroupCell *group, Configuration **config)
 
int Scale_Px (double px) const
 
AFontSize Scale_Px (AFontSize size) const
 
virtual ~Cell ()
 Delete this list of cells.
 
int CellsInListRecursive () const
 How many cells does this cell contain? More...
 
wxRect CropToUpdateRegion (wxRect rect) const
 The part of the rectangle rect that is in the region that is currently drawn.
 
bool InUpdateRegion () const
 Is this cell inside the region that is currently drawn?
 
bool SoftLineBreak (bool breakLine=true)
 Do we want this cell to start with a linebreak?
 
bool BreakLineHere () const
 Are we allowed to break a line here?
 
bool HasHardLineBreak () const
 Does this cell begin with a manual linebreak?
 
virtual bool BreakUp ()
 
bool ContainsRect (const wxRect &sm, bool all=true) const
 
bool ContainsPoint (wxPoint point) const
 
void ClearCacheList ()
 
void SetConfigurationList (Configuration **config)
 
ConfigurationGetConfiguration ()
 
void Draw ()
 
void DrawList (wxPoint point)
 
void DrawList ()
 
virtual void DrawBoundingBox (wxDC &WXUNUSED(dc), bool all=false)
 
bool DrawThisCell (wxPoint point)
 
bool DrawThisCell ()
 
void ForceBreakLine (bool force=true)
 
int GetHeight () const
 
int GetWidth () const
 
int GetCenter () const
 
bool HasValidSize () const
 Is the size valid and not pending a recalculation?
 
bool HasStaleSize () const
 Is the size valid, whether a recalculation is pending or not?
 
bool HasValidPosition () const
 Is the position valid?
 
int GetDrop () const
 
CellType GetType () const
 
int GetMaxDrop () const
 
int GetCenterList () const
 
int GetHeightList () const
 
int GetFullWidth () const
 How many pixels is this list of cells wide, if we don't break it into lines?
 
int GetLineWidth () const
 
int GetCurrentX () const
 
int GetCurrentY () const
 
virtual wxRect GetRect (bool all=false) const
 
virtual bool NeedsRecalculation (AFontSize fontSize) const
 True, if something that affects the cell size has changed.
 
virtual wxString GetDiffPart () const
 
void RecalculateList (AFontSize fontsize)
 
void FontsChangedList ()
 Tell a whole list of cells that their fonts have changed.
 
void ClearNeedsToRecalculateWidths ()
 
void ResetData ()
 Mark all cached size information as "to be calculated". More...
 
void ResetDataList ()
 
void ResetSize ()
 Mark the cached height and width information as "to be calculated".
 
void ResetCellListSizes ()
 Mark the line and cell list widths and heights as "to be calculated".
 
void ResetCellListSizesList ()
 Mark the line and cell list widths and heights as "to be calculated".
 
void SetZeroSize ()
 
void ResetSizeList ()
 Mark the cached height information of the whole list of cells as "to be calculated".
 
void SetBigSkip (bool skip)
 
bool HasBigSkip () const
 
virtual void SetType (CellType type)
 Sets the text style according to the type.
 
TextStyle GetStyle () const
 
void SetPen (double lineWidth=1.0) const
 Sets the drawing pen to the cell's default foreground color.
 
void SetBrush () const
 Sets the fill brush to the cell's default foreground color.
 
wxColour GetForegroundColor () const
 
void SetHighlight (bool highlight)
 Mark this cell as highlighted (e.G. being in a maxima box)
 
bool GetHighlight () const
 Is this cell highlighted (e.G. inside a maxima box)
 
virtual void SetExponentFlag ()
 
virtual void SetValue (const wxString &WXUNUSED(text))
 
virtual const wxString & GetValue () const
 
Cellfirst () const
 Get the first cell in this list of cells.
 
Celllast () const
 Get the last cell in this list of cells.
 
Range GetCellsInRect (const wxRect &rect) const
 
Range GetListCellsInRect (const wxRect &rect) const
 
virtual Range GetInnerCellsInRect (const wxRect &rect) const
 Select the cells inside this cell described by the rectangle rect.
 
virtual bool IsOperator () const
 Is this cell an operator?
 
bool IsCompound () const
 Do we have an operator in this line - draw () in frac...
 
virtual bool IsShortNum () const
 
GroupCellGetGroup () const
 Returns the group cell this cell belongs to.
 
virtual wxString ListToString () const
 Returns the list's representation as a string.
 
wxString VariablesAndFunctionsList () const
 
virtual wxString ListToMatlab () const
 Convert this list to its LaTeX representation.
 
virtual wxString ListToTeX () const
 Convert this list to its LaTeX representation.
 
virtual wxString ListToXML () const
 Convert this list to a representation fit for saving in a .wxmx file.
 
virtual wxString ListToMathML (bool startofline=false) const
 Convert this list to a MathML representation.
 
virtual wxString ListToOMML (bool startofline=false) const
 Convert this list to an OMML representation.
 
virtual wxString ListToRTF (bool startofline=false) const
 Convert this list to an RTF representation.
 
virtual wxString ToOMML () const
 
virtual wxString ToMathML () const
 Convert this cell to a representation fit for saving in a .wxmx file.
 
virtual void Unbreak ()
 
virtual void UnbreakList ()
 
CellGetPrevious () const
 
CellGetNext () const
 Get the next cell in the list.
 
CellGetNextToDraw () const
 
virtual void SetNextToDraw (Cell *next)
 
template<typename T , typename Del , typename std::enable_if< std::is_base_of< Cell, T >::value, bool >::type = true>
void SetNextToDraw (const std::unique_ptr< T, Del > &ptr)
 
bool IsComment () const
 
bool IsHidden () const
 
virtual void Hide (bool hide=true)
 
bool IsEditable (bool input=false) const
 
virtual void ProcessEvent (wxKeyEvent &WXUNUSED(event))
 Processes a key event.
 
virtual bool AddEnding ()
 
virtual void SelectPointText (wxPoint point)
 
virtual void SelectRectText (wxPoint one, wxPoint two)
 
virtual void PasteFromClipboard (bool primary=false)
 
virtual bool CutToClipboard ()
 
virtual void SelectAll ()
 
virtual bool CanCopy () const
 
virtual wxPoint PositionToPoint (int WXUNUSED(pos)=-1)
 
virtual bool IsDirty () const
 
virtual void SwitchCaretDisplay ()
 
virtual void SetFocus (bool WXUNUSED(focus))
 
void SetForeground ()
 Sets the foreground color.
 
virtual bool IsActive () const
 
virtual void SetStyle (TextStyle style)
 Sets the TextStyle of this cell.
 
bool IsMath () const
 Is this cell possibly output of maxima?
 
void CopyCommonData (const Cell &cell)
 Copy common data (used when copying a cell)
 
std::unique_ptr< CellCopyList (GroupCell *group) const
 Return a copy of the list of cells beginning with this one.
 
void ClearToolTip ()
 Remove this cell's tooltip.
 
void SetToolTip (wxString &&toolTip)
 Set the tooltip to a given temporary string - the cell will move from it.
 
void SetToolTip (const wxString *tooltip)
 
void AddToolTip (const wxString &tip)
 Add another tooltip to this cell.
 
virtual void SetCurrentPoint (wxPoint point)
 Tells this cell where it is placed on the worksheet.
 
void SetCurrentPoint (int x, int y)
 Tells this cell where it is placed on the worksheet.
 
wxPoint GetCurrentPoint () const
 Where is this cell placed on the worksheet?
 
bool IsBrokenIntoLines () const
 
bool GetSuppressMultiplicationDot () const
 
void SetSuppressMultiplicationDot (bool val)
 
bool GetHidableMultSign () const
 Whether this is a hidable multiplication sign.
 
void SetHidableMultSign (bool val)
 
virtual void SetAltCopyText (const wxString &text)
 
virtual const wxString & GetAltCopyText () const
 Get the text set using SetAltCopyText - may be empty.
 
const wxString & GetLocalToolTip () const
 
- Public Member Functions inherited from Observed
bool IsNull () const
 
bool HasControlBlock () const
 
bool HasOneCellPtr () const
 

Static Public Attributes

static wxDataFormat m_gifFormat
 A class that publishes wxm data to the clipboard.
 

Additional Inherited Members

- Static Public Member Functions inherited from Cell
static wxString OMML2RTF (wxXmlNode *node)
 Converts an OMML tag to the corresponding RTF snippet.
 
static wxString OMML2RTF (wxString ommltext)
 Converts OMML math to RTF math.
 
static wxString RTFescape (wxString, bool MarkDown=false)
 Escape a string for RTF.
 
static wxString XMLescape (wxString)
 Escape a string for XML.
 
static std::unique_ptr< CellCopyList (GroupCell *group, const Cell *cell)
 Return a copy of the given list of cells.
 
static std::unique_ptr< CellMakeVisiblyInvalidCell (GroupCell *group, Configuration **config)
 
- Static Public Member Functions inherited from Observed
static size_t GetLiveInstanceCount ()
 
static size_t GetLiveControlBlockInstanceCount ()
 
- Protected Member Functions inherited from Cell
void BreakUpAndMark ()
 Break up the internal cells of this cell, and mark it as broken up.
 
std::unique_ptr< CellMakeVisiblyInvalidCell () const
 
virtual int GetInnerCellCount () const
 The number of inner cells - for use by the iterators.
 
virtual CellGetInnerCell (int index) const
 
WorksheetGetWorksheet () const
 
virtual void FontsChanged ()
 To be called if the font has changed.
 
CellPointersGetCellPointers () const
 
void InvalidateMaxDrop ()
 
- Protected Attributes inherited from Cell
wxPoint m_currentPoint {-1, -1}
 
CellPtr< GroupCellm_group
 
CellPtr< Cellm_nextToDraw
 
Configuration ** m_configuration
 
const wxString * m_toolTip
 
int m_height = -1
 The height of this cell.
 
int m_width = -1
 The width of this cell; is recalculated by RecalculateHeight.
 
int m_center = -1
 
AFontSize m_fontSize_Scaled = {}
 The font size is smaller in super- and subscripts.
 
CellType m_type = MC_TYPE_DEFAULT
 
TextStyle m_textStyle = TS_DEFAULT
 

Constructor & Destructor Documentation

◆ AnimationCell()

AnimationCell::AnimationCell ( GroupCell group,
Configuration **  config,
std::shared_ptr< wxFileSystem >  filesystem,
int  framerate = -1 
)

The constructor

Parameters
framerateThe individual frame rate that has to be set for this cell only. If the default frame rate from the config is to be used instead this parameter has to be set to -1.
configA pointer to the pointer to the configuration storage of the worksheet this cell belongs to.
filesystemThe filesystem the contents of this animation can be found in. NULL = the operating system's filesystem
groupThe parent GroupCell this cell belongs to.

Member Function Documentation

◆ ClearCache()

void AnimationCell::ClearCache ( )
overridevirtual

Remove all cached scaled images from memory

To be called when the animation is outside of the displayed portion of the screen; The bitmaps will be re-generated when needed.

Implements ImgCellBase.

◆ Copy()

std::unique_ptr<Cell> AnimationCell::Copy ( GroupCell group) const
overridevirtual

Create a copy of this cell

This method is purely virtual, which means every child class has to define its own Copy() method.

Implements ImgCellBase.

◆ GetFrameRate()

int AnimationCell::GetFrameRate ( ) const

Get the frame rate of this AnimationCell [in Hz].

Returns either the frame rate set for this slide show cell individually or the default frame rate chosen in the config.

◆ GetToolTip()

const wxString & AnimationCell::GetToolTip ( wxPoint  point) const
overridevirtual

Returns the ToolTip this cell provides at a given point.

Parameters
pointThe point in worksheet coordinates, must be inside the cell or else an empty string is returned.
Returns
the tooltip text, or empty string if none.

Implements ImgCellBase.

◆ ReloadTimer()

void AnimationCell::ReloadTimer ( )

Reload the animation timer starting and instantiating and registering it if necessary.

If the timer is already running, the request to reload it is ignored.

◆ SetFrameRate()

int AnimationCell::SetFrameRate ( int  Freq)

Set the frame rate of this AnimationCell [in Hz].

Parameters
FreqThe requested frequency [in Hz] or -1 for: Use the default value.
Returns
The frame rate that was actually set.

◆ StopTimer()

void AnimationCell::StopTimer ( )

Stops the timer

Also deletes the timer as on MSW there aren't many timers available.


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