wxMaxima
Loading...
Searching...
No Matches
Data Structures | Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
Worksheet Class Reference

The canvas that contains the spreadsheet the whole program is about. More...

#include <Worksheet.h>

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

Data Structures

class  SimpleMathConfigurationIterator
 

Public Member Functions

bool UpdateControlsNeeded ()
 Is an update of the worksheet controls needed?
 
void UpdateControlsNeeded (bool updateControlsNeeded)
 
bool IsEmpty () const
 Is this worksheet empty?
 
void CloseAutoCompletePopup ()
 Close the autocompletion pop-up if it is currently open.
 
void OnChar (wxKeyEvent &event)
 Key for a printable character pressed.
 
void OnKeyDown (wxKeyEvent &event)
 A special key has been pressed.
 
void SetCellStyle (GroupCell *group, GroupType style)
 Change the style of a cell.
 
void NumberSections () const
 Renumber all sections.
 
bool SectioningMoveIn (GroupCell *parent)
 Make this chapter/section/... a section/subsection/... changing its subheadings, too.
 
bool SectioningMoveOut (GroupCell *parent)
 Make this section/subsection/... a chapter/section/... changing its subheadings, too.
 
void WindowActive (bool active)
 Is this window active?
 
void ClearNotification ()
 Clears the notification message from SetNotification.
 
void SetNotification (const wxString &message, int flags=wxICON_INFORMATION)
 Inform the user that something happened in a non-active window.
 
void OnActivate (wxActivateEvent &event)
 Is called if this element looses or gets the focus.
 
EditorCellGetActiveCell () const
 Get the currently active EditorCell.
 
EditorCellKeyboardSelectionStart () const
 Tells us which cell the keyboard selection has started in.
 
EditorCellMouseSelectionStart () const
 
EditorCellSearchStart () const
 
int IndexSearchStartedAt () const
 
CellPointersGetCellPointers ()
 
CellPointers::ErrorListGetErrorList ()
 
TextCellGetCurrentTextCell () const
 
void SetCurrentTextCell (TextCell *cell)
 
void SetWorkingGroup (GroupCell *group)
 
void UpdateTableOfContents ()
 Update the table of contents.
 
void QuestionPending (bool pending)
 Does maxima currently wait for the answer of a question?
 
void SetMaximaDocDir (const wxString &dir)
 
bool GCContainsCurrentQuestion (const GroupCell *cell)
 Does the GroupCell cell points to contain the question currently asked by maxima?
 
void OpenQuestionCaret (const wxString &txt={})
 Move the cursor to the question maxima currently asks and if needed add a cell for user input.
 
void UpdateScrollPos ()
 Execute all collected scroll events in one go.
 
GroupCellGetWorkingGroup (bool resortToLast=false) const
 Returns the cell maxima currently works on.
 
void LoadHelpFileAnchors (const wxString &docdir, const wxString &maximaVersion)
 Tries to parse maxima's manual in order to find out which anchors it contains.
 
wxString GetHelpfileAnchorName (const wxString &keyword)
 
wxString GetHelpfileURL (const wxString &keyword)
 
int GetCellIndex (Cell *cell) const
 Returns the index in (i...) or (o...)
 
MaximaManualGetMaximaManual ()
 

Data Fields

RecentDocuments m_unsavedDocuments
 
stx::optional< Notificationm_notificationMessage
 A error notification message.
 
AutoComplete m_autocomplete
 The storage for the autocompletion feature.
 
std::vector< wxString > m_replacementsForCurrentWord
 Suggestions for how the word that was right-clicked on could continue.
 
MaximaManual m_maximaManual
 

Protected Member Functions

void FocusTextControl ()
 
virtual wxSize DoGetBestClientSize () const override
 
void UpdateConfigurationClientSize ()
 

Protected Attributes

wxString m_lastQuestion
 
int m_virtualWidth_Last = -1
 
int m_virtualHeight_Last = -1
 
wxBitmap m_memory
 A memory we can manually buffer the contents of the area that is to be redrawn in.
 
CellPtr< GroupCellm_recalculateStart
 Where to start recalculation. NULL = No recalculation needed.
 
int m_pointer_x = -1
 The x position of the mouse pointer.
 
int m_pointer_y = -1
 The y position of the mouse pointer.
 
bool m_mouseMotionWas = false
 Was there a mouse motion we didn't react to until now?
 
bool m_inPopupMenu = false
 Is there an active popup menu?
 
wxString m_currentFile
 The name of the currently-opened file.
 
FindReplaceDialogm_findDialog = NULL
 The find-and-replace-dialog.
 
wxTimer m_keyboardInactiveTimer
 The timer that tells us when the keyboard is inactive so an autosave isn't disrupting.
 
EvaluationQueue m_evaluationQueue
 The list of cells that have to be evaluated.
 
ToolBarm_mainToolBar = NULL
 The toolbar of the main window: We need to access it and therefore have it defined here.
 
bool m_questionPrompt = false
 true = the last reply from maxima was a question
 
void MarkRefreshAsDone ()
 Handle redrawing the worksheet or of parts of it.
 
bool RedrawIfRequested ()
 Redraw the worksheet if RequestRedraw() has been called.
 
void RequestRedraw (GroupCell *start=NULL)
 Request the worksheet to be redrawn.
 
void RequestRedraw (wxRect rect)
 Request a part of the worksheet to be redrawn.
 
void ForceRedraw ()
 Redraw the window now and mark any pending redraw request as "handled".
 
void CodeCellVisibilityChanged ()
 To be called after enabling or disabling the visibility of code cells.
 
void UpdateConfig ()
 Re-read the configuration.
 
const wxString UnicodeToMaxima (wxString s)
 Make a few unicode characters interpretable by maxima.
 
void ScrollToStart ()
 Scroll to the start of the worksheet.
 
void ScrollToError ()
 Unfold the cell that produced the error, if necessary and, if requested, scroll to it.
 
bool HCaretActive () const
 Is the vertically-drawn cursor active?
 
bool CanMergeSelection () const
 Can we merge the selected cells into one?
 
bool CanUndo () const
 
bool CanRedo () const
 
void Undo ()
 
void Redo ()
 
void TreeUndo_ClearBuffers ()
 
 Worksheet (wxWindow *parent, int id, Configuration *config, wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, bool reactToEvents=true)
 The constructor.
 
virtual ~Worksheet ()
 The destructor.
 
void DestroyTree ()
 Clear the whole worksheet.
 
std::unique_ptr< GroupCellCopyTree () const
 Copies the worksheet's entire contents.
 
GroupCellInsertGroupCells (std::unique_ptr< GroupCell > &&cells, GroupCell *where, UndoActions *undoBuffer)
 Insert group cells into the worksheet.
 
GroupCellInsertGroupCells (std::unique_ptr< GroupCell > &&cells, GroupCell *where=NULL)
 Insert group cells into the worksheet.
 
void InsertLine (std::unique_ptr< Cell > &&newCell, bool forceNewLine=false)
 Add a new line to the output cell of the working group.
 
GroupCellGetInsertGroup () const
 The group that the line's cells will belong to - used by InsertLine.
 
bool RecalculateIfNeeded (bool timeout=false)
 Actually recalculate the worksheet.
 
void Recalculate (Cell *start)
 Schedule a recalculation of the worksheet starting with the cell start.
 
void Recalculate ()
 
void ClearDocument ()
 Empties the current document.
 
void ResetInputPrompts ()
 
bool CanCopy () const
 
bool CanPaste () const
 
bool CanCut () const
 
void SelectAll ()
 Select the whole document.
 
bool HasCellsSelected () const
 Is at least one entire cell selected?
 
void DeleteRegion (GroupCell *start, GroupCell *end, UndoActions *undoBuffer)
 
void DeleteRegion (GroupCell *start, GroupCell *end)
 
void DeleteSelection ()
 
void TOCdnd (GroupCell *dndStart, GroupCell *dndEnd)
 
bool CanDeleteRegion (GroupCell *start, const GroupCell *end) const
 Is it possible to delete the cells between start and end?
 
bool CanDeleteSelection () const
 Is it possible to delete the currently selected cells?
 
void DeleteCurrentCell ()
 Delete the currently active cell - or the cell above this one.
 
AnimationCellGetSelectedAnimation () const
 Returns the selected cell - or NULL, if the selection isn't an animation.
 
ImgCellGetSelectedImgCell () const
 Returns the selected cell - or NULL, if the selection isn't an image.
 
ImgCellBaseGetSelectedImgCellBase () const
 Returns the selected cell - or NULL, if the selection isn't image nor animation.
 
TextCellGetSelectedTextCell () const
 Returns the selected cell - or NULL, if the selection isn't a text cell.
 
bool CanAnimate () const
 Does it make sense to enable the "Play" button and the slider now?
 
void Animate (bool run=true) const
 Animate the current slide show.
 
void DivideCell ()
 
void MergeCells ()
 
void SetLastQuestion (const wxString &lastQuestion)
 
wxString GetLastQuestion () const
 
bool CutToClipboard ()
 Add the currently selected cells to the clipboard and delete them.
 
void PasteFromClipboard ()
 
bool Copy (bool astext=false) const
 Copy the current selection to the clipboard.
 
bool CopyCells () const
 Copy the selection to the clipboard as it would appear in a .wxm file.
 
bool CopyMatlab () const
 Copy a Matlab representation of the current selection to the clipboard.
 
bool CopyText () const
 Copy a textual representation of the current selection to the clipboard.
 
bool CopyTeX () const
 Copy the TeX representation of the current selection to the clipboard.
 
wxString ConvertSelectionToMathML () const
 Convert the current selection to MathML.
 
wxBitmap ConvertSelectionToBitmap () const
 Convert the current selection to a bitmap.
 
bool CopyMathML () const
 Copy the MathML representation of the current selection to the clipboard.
 
bool CopyBitmap () const
 Copy a bitmap of the current selection to the clipboard.
 
bool CopyAnimation () const
 Copy the current animation to the clipboard.
 
bool CopySVG () const
 Copy a svg of the current selection to the clipboard.
 
bool CopyRTF () const
 Copy a rtf version of the current selection to the clipboard.
 
wxSize CopyToFile (const wxString &file) const
 
wxSize CopyToFile (const wxString &file, Cell *start, Cell *end, bool asData=false, double scale=1) const
 
void CalculateReorderedCellIndices (GroupCell *tree, int &cellIndex, std::vector< int > &cellMap)
 
bool ExportToHTML (const wxString &file)
 Export the file to an html document.
 
void ExportToMAC (wxTextFile &output, GroupCell *tree, bool wxm, const std::vector< int > &cellMap, bool fixReorderedIndices)
 Export a region of the file to a .wxm or .mac file maxima's load command can read.
 
bool ExportToMAC (const wxString &file)
 Export the file to a text file maxima's load command can read.
 
wxString RTFStart () const
 The start of a RTF document.
 
wxString RTFEnd () const
 The end of a RTF document.
 
bool ExportToTeX (const wxString &file)
 export to a LaTeX file
 
wxString GetString (bool lb=false) const
 Convert the current selection to a string.
 
GroupCellGetTree () const
 
std::unique_ptr< GroupCell > * GetTreeAddress ()
 
CellGetSelectionStart () const
 Return the first of the currently selected cells.
 
CellGetSelectionEnd () const
 Return the last of the currently selected cells.
 
void ClearSelection ()
 Clear the selection - make it empty, i.e. no selection.
 
void SetSelection (Cell *sel)
 Select the cell sel.
 
void SetSelection (Cell *start, Cell *end)
 Select the cell range start-end.
 
bool CanEdit ()
 We can edit the input if the we have the whole input in selection!
 
bool ActivatePrevInput ()
 
bool ActivateNextInput ()
 
wxString GetStatusText () const
 
bool StatusTextChangedHas ()
 
bool StatusTextHas () const
 
void ScrollToCaret ()
 Request to scroll to the cursor as soon as wxMaxima is idle.
 
bool ScrollToCaretIfNeeded ()
 Scrolls to the cursor, if requested.
 
void ScrollToCellIfNeeded ()
 Scrolls to the cell given by ScheduleScrollToCell; Is called once we have time to do so.
 
void ScheduleScrollToCell (Cell *cell, bool scrollToTop=true)
 Schedules scrolling to a given cell.
 
bool PointVisibleIs (wxPoint point)
 Is the point currently visible on the worksheet?
 
bool CaretVisibleIs ()
 Is the caret (hcaret or vcaret) currently visible on the worksheet?
 
GroupCellFirstVisibleGC ()
 The first groupCell that is currently visible.
 
void ShowPoint (wxPoint point)
 Scrolls to a point on the worksheet.
 
void OnSetFocus (wxFocusEvent &event)
 What to do if the worksheet is in the input focus.
 
void OnKillFocus (wxFocusEvent &event)
 What to do if the worksheet looses the input focus.
 
bool IsSelected (CellType type)
 Does the selection start with a cell of the type "type".
 
void StepAnimation (int change=1)
 Set the slide of the currently selected animation or advance it by one step.
 
bool IsActiveInLast () const
 Is the editor active in the last cell of the worksheet?
 
GroupCellGetLastCell ()
 Returns the last cell of the worksheet.
 
bool IsSelectionInWorkingGroup ()
 Is the selection in the current working group?
 
void SetActiveCell (EditorCell *cell)
 Mark an editor cell as the active one.
 
void SetDefaultHCaret ()
 Set the HCaret to its default location, at the end of the document.
 
void SetHCaret (GroupCell *where)
 Set the HCaret at the location of the given Cell.
 
GroupCellGetHCaret ()
 The cell the horizontal cursor is above. NULL means at the start of the document.
 
void OpenHCaret (const wxString &txt={})
 Place the cursor into a new cell where the horizontal cursor is.
 
void OpenHCaret (const wxString &txt, GroupType type)
 Place the cursor into a new cell where the horizontal cursor is.
 
void ShowHCaret ()
 Activates the horizontal cursor.
 
bool CanUndoInsideCell () const
 Is it possible to issue an undo in the currently selected cell?
 
void UndoInsideCell ()
 
bool CanRedoInsideCell () const
 Is it possible to issue an undo in the currently selected cell?
 
void RedoInsideCell ()
 
void FollowEvaluation (bool followEvaluation)
 Do we want to follow the evaluation process?
 
bool FollowEvaluation () const
 Query if we want to automatically scroll to the cell that is currently evaluated.
 
void ScrolledAwayFromEvaluation (bool ScrolledAway)
 Set or get the "Scrolled away from evaluation" status.
 
bool ScrolledAwayFromEvaluation () const
 
void SaveValue ()
 
bool IsSaved () const
 
void SetSaved (bool saved)
 
void OutputChanged ()
 
void RemoveAllOutput ()
 
void RemoveAllOutput (GroupCell *cell)
 
void Evaluate ()
 Trigger the evaluation of the current cell(s)
 
void AddToEvaluationQueue (GroupCell *cell)
 Adds a group cell to the evaluation queue marking its contents as "outdated".
 
void AddDocumentToEvaluationQueue ()
 
void AddEntireDocumentToEvaluationQueue ()
 Schedule all cells in the document for evaluation.
 
void AddDocumentTillHereToEvaluationQueue ()
 Schedule all cells stopping with the one the caret is in for evaluation.
 
void AddRestToEvaluationQueue ()
 Add all cells below the cursor to the evaluation queue.
 
void AddSectionToEvaluationQueue (GroupCell *start)
 Adds a chapter, a section or a subsection to the evaluation queue.
 
void AddSelectionToEvaluationQueue ()
 Schedule all cells in the selection to be evaluated.
 
void AddSelectionToEvaluationQueue (GroupCell *start, GroupCell *end)
 Schedule all cells in a region to be evaluated.
 
void AddCellToEvaluationQueue (GroupCell *gc)
 Schedule this cell for evaluation.
 
void FoldOccurred ()
 Call when a fold action was detected, to update the state in response to a fold occurring.
 
GroupCellToggleFold (GroupCell *which)
 Fold or unfold a cell.
 
GroupCellToggleFoldAll (GroupCell *which)
 Toggles the status of the fold for the given GroupCell and its children.
 
void FoldAll ()
 Recursively folds the whole document.
 
void UnfoldAll ()
 Recursively unfolds the whole document.
 
void SetZoomFactor (double newzoom, bool recalc=true)
 
void CommentSelection ()
 
void OnScrollChanged (wxScrollEvent &ev)
 Called if the user is using the scrollbar for scrolling through the document.
 
void OnScrollEvent (wxScrollWinEvent &ev)
 
void OnMouseWheel (wxMouseEvent &event)
 Called if the mouse wheel sents events.
 
bool FindIncremental (const wxString &str, bool down, bool ignoreCase)
 Do an incremental search from the cursor or the point the last search started at.
 
bool FindIncremental_RegEx (const wxString &str, bool down)
 
bool FindNext (const wxString &str, bool down, bool ignoreCase, bool warn=true)
 Find the next occurrence of a string.
 
bool FindNext_Regex (const wxString &str, const bool &down, bool warn=true)
 
void Replace (const wxString &oldString, const wxString &newString, bool ignoreCase)
 Replace the current occurrence of a string.
 
void Replace_RegEx (const wxString &oldString, const wxString &newString)
 
int ReplaceAll (const wxString &oldString, const wxString &newString, bool ignoreCase)
 Replace all occurrences of a string.
 
int ReplaceAll_RegEx (const wxString &oldString, const wxString &newString)
 
wxString GetInputAboveCaret ()
 
wxString GetOutputAboveCaret ()
 
void LoadSymbols ()
 Compile a list of known autocompletion symbols.
 
bool Autocomplete (AutoComplete::autoCompletionType type=AutoComplete::command)
 
void AddSymbol (const wxString &fun, AutoComplete::autoCompletionType type=AutoComplete::command)
 Add a symbol to the autocompletion list.
 
void AddSymbols (const wxString &xml)
 Add a xml-encoded list of symbols to the autocompletion list.
 
void AddSymbols (wxXmlDocument xml)
 Add a xml-encoded list of symbols to the autocompletion list.
 
void SetActiveCellText (const wxString &text)
 
bool InsertText (const wxString &text)
 
void OpenNextOrCreateCell ()
 
void OnFollow ()
 Called when the "Scroll to currently evaluated" button is pressed.
 
void SelectGroupCell (GroupCell *cell)
 Set this cell as the currently selected one.
 
void SetAnswer (const wxString &answer)
 Handling questions from and answers for maxima.
 
void QuestionAnswered ()
 Mark the current question from maxima as "answered"..
 
bool QuestionPending () const
 Does maxima wait for the answer of a question?
 

Detailed Description

The canvas that contains the spreadsheet the whole program is about.

This canvas contains all the math-, title-, image- input- ("editor-")- etc.- cells of the current session.

Most of the logic that handles that this canvas might be larger than the screen (and could even be larger than the computer's RAM would it have been handled as a big bitmap) is provided by wxWidgets:

The worksheet isn't immediately redrawn on a key press, a mouse click or on maxima outputting new data. Instead all such events are processed in order until wxMaxima has caught up with all the events (which causes wxWidgets to send a Idle event to the wxMaxima object) or until we reach a timeout. If the user manages to type faster than wxMaxima redraws the screen this allows us to skip a few redraws in order to process the keypresses as fast as the user types. Also this keeps us responsive even if maxima outputs data faster than wxMaxima can display it.

Constructor & Destructor Documentation

◆ Worksheet()

Worksheet::Worksheet ( wxWindow *  parent,
int  id,
Configuration config,
wxPoint  pos = wxDefaultPosition,
wxSize  size = wxDefaultSize,
bool  reactToEvents = true 
)

The constructor.

This class represents the worksheet shown in the middle of the wxMaxima window.

Parameters
parentThe parent window
idThe window ID. Often wxID_ANY
Theworksheet's initial location
Theworksheet's initial size
reactToEventsCan be set to false for creating an example panel, for example for the config dialogue.

Member Function Documentation

◆ AddEntireDocumentToEvaluationQueue()

void Worksheet::AddEntireDocumentToEvaluationQueue ( )

Schedule all cells in the document for evaluation.

Add the entire document, including hidden cells, to the evaluation queue.

◆ Animate()

void Worksheet::Animate ( bool  run = true) const

Animate the current slide show.

Starts playing the animation of a cell generated with the with_slider_* commands.

Parameters
run
  • false: Stop the animation
  • true: Run the animation

◆ Autocomplete()

bool Worksheet::Autocomplete ( AutoComplete::autoCompletionType  type = AutoComplete::command)

No completions - clear the selection and return false

If there is only one completion, use it

If there are more than one completions, popup a menu

◆ CanMergeSelection()

bool Worksheet::CanMergeSelection ( ) const

Can we merge the selected cells into one?

Todo:
Does it make sense to make to allow the text of sections and image cells with math cells?

◆ CanRedoInsideCell()

bool Worksheet::CanRedoInsideCell ( ) const

Is it possible to issue an undo in the currently selected cell?

Returns
false if no cell is selected or no redo can be executed.

◆ CanUndoInsideCell()

bool Worksheet::CanUndoInsideCell ( ) const

Is it possible to issue an undo in the currently selected cell?

Returns
false if no cell is selected or there is no further undo information

◆ ClearDocument()

void Worksheet::ClearDocument ( )

Empties the current document.

Used before opening a new file or when the "new" button is pressed.

◆ Copy()

bool Worksheet::Copy ( bool  astext = false) const

Copy the current selection to the clipboard.

Parameters
astext
  • true: Copy the current selection as text
  • false: Copy the current selection as they would appear in a .wxm file

◆ DeleteCurrentCell()

void Worksheet::DeleteCurrentCell ( )

Delete the currently active cell - or the cell above this one.

Used for the "delete current cell" shortcut.

◆ DeleteRegion()

void Worksheet::DeleteRegion ( GroupCell start,
GroupCell end,
UndoActions *  undoBuffer 
)

Set the cursor to a sane place

◆ Evaluate()

void Worksheet::Evaluate ( )

Trigger the evaluation of the current cell(s)

Internally this function simulates a click on the "Cell/Evaluate Cell(s)" button.

◆ ExportToHTML()

bool Worksheet::ExportToHTML ( const wxString &  file)

Export the file to an html document.

Todo:
Worksheet and text cell background work fine, but their names might be interchanged.

◆ ExportToMAC()

void Worksheet::ExportToMAC ( wxTextFile &  output,
GroupCell tree,
bool  wxm,
const std::vector< int > &  cellMap,
bool  fixReorderedIndices 
)

Export a region of the file to a .wxm or .mac file maxima's load command can read.

Todo:
Slow: Iterates through a string using [] instead of using an iterator.

◆ ExportToTeX()

bool Worksheet::ExportToTeX ( const wxString &  file)

export to a LaTeX file

Export the file as TeX code.

◆ FindIncremental()

bool Worksheet::FindIncremental ( const wxString &  str,
bool  down,
bool  ignoreCase 
)

Do an incremental search from the cursor or the point the last search started at.

Used by the find dialog.

Todo:
Keep a list of positions the last few letters were found at?

◆ FindNext()

bool Worksheet::FindNext ( const wxString &  str,
bool  down,
bool  ignoreCase,
bool  warn = true 
)

Find the next occurrence of a string.

Used by the find dialog.

◆ FollowEvaluation()

void Worksheet::FollowEvaluation ( bool  followEvaluation)

Do we want to follow the evaluation process?

Maxima can automagically scroll to the cell that is currently evaluated. If it does do so can be queried by FollowEvaluation(). Changing the behavior (for example because the user has scrolled away from the cell being evaluated and now clearly wants the cursor to stay where it is) can be achieved by FollowEvaluation(true) or FollowEvaluation(false).

◆ GetSelectionEnd()

Cell * Worksheet::GetSelectionEnd ( ) const
inline

Return the last of the currently selected cells.

NULL means: No cell is selected.

◆ GetSelectionStart()

Cell * Worksheet::GetSelectionStart ( ) const
inline

Return the first of the currently selected cells.

NULL means: No cell is selected.

◆ GetString()

wxString Worksheet::GetString ( bool  lb = false) const

Convert the current selection to a string.

Parameters
lb
  • true: Include linebreaks
  • false: Remove linebreaks from the converted string

◆ GetWorkingGroup()

GroupCell * Worksheet::GetWorkingGroup ( bool  resortToLast = false) const

Returns the cell maxima currently works on.

NULL if there isn't such a cell.

Parameters
resortToLasttrue = if we already have set the cell maxima works on to NULL use the last cell maxima was known to work on.

◆ InsertGroupCells() [1/2]

GroupCell * Worksheet::InsertGroupCells ( std::unique_ptr< GroupCell > &&  cells,
GroupCell where,
UndoActions *  undoBuffer 
)

Insert group cells into the worksheet.

Parameters
cellsThe list of cells that has to be inserted
whereThe cell the cells have to be inserted after. NULL means: Insert the cells at the beginning of the worksheet.
undoBufferThe buffer the undo information for this action has to be kept in. Might be
  • treeUndoActions for normal deletes,
  • treeRedoActions for deletions while executing an undo or
  • NULL for: Don't keep any copy of the cells.

◆ InsertGroupCells() [2/2]

GroupCell * Worksheet::InsertGroupCells ( std::unique_ptr< GroupCell > &&  cells,
GroupCell where = NULL 
)

Insert group cells into the worksheet.

Parameters
cellsThe list of cells that has to be inserted
whereThe cell the cells have to be inserted after

◆ InsertLine()

void Worksheet::InsertLine ( std::unique_ptr< Cell > &&  newCell,
bool  forceNewLine = false 
)

Add a new line to the output cell of the working group.

If maxima isn't currently evaluating and therefore there is no working group the line is appended to m_last, instead.

◆ IsSelected()

bool Worksheet::IsSelected ( CellType  type)

Does the selection start with a cell of the type "type".

Is this cell selected?

◆ MarkRefreshAsDone()

void Worksheet::MarkRefreshAsDone ( )
inline

Handle redrawing the worksheet or of parts of it.

This functionality is important for scrolling, if we have changed anything that needs updating or if part of the screen memory containing a window was overwritten by a window that was in front of it and now needs to be redrawn for this reason.

We don't redraw the window immediately if this seems necessary but wait for the idle loop instead - which is called when all selected gui events have been processed. This allows us to handle events as fast as the user can type and (if the user types faster than we can display the text) enables us to update the display as often as the typing speed allows, but not more often. Request the worksheet to be redrawn

◆ OnChar()

void Worksheet::OnChar ( wxKeyEvent &  event)

Key for a printable character pressed.

Can call OnCharInActive or OnCharNoActive, if appropriate. See OnKeyDown for non-printable characters like "up" or "right".

◆ OnKeyDown()

void Worksheet::OnKeyDown ( wxKeyEvent &  event)

A special key has been pressed.

Printable characters are handled by OnChar instead.

◆ OnMouseWheel()

void Worksheet::OnMouseWheel ( wxMouseEvent &  event)

Called if the mouse wheel sents events.

The virtual mouse wheel touchpads provide are handled by OnThumbtrack instead.

◆ OnScrollChanged()

void Worksheet::OnScrollChanged ( wxScrollEvent &  ev)

Called if the user is using the scrollbar for scrolling through the document.

See also OnThumbtrack and OnMouseWheel

◆ QuestionPending() [1/2]

bool Worksheet::QuestionPending ( ) const
inline

Does maxima wait for the answer of a question?

Return values
true= maxima waits for the answer of a question.

◆ QuestionPending() [2/2]

void Worksheet::QuestionPending ( bool  pending)
inline

Does maxima currently wait for the answer of a question?

◆ RecalculateIfNeeded()

bool Worksheet::RecalculateIfNeeded ( bool  timeout = false)

Actually recalculate the worksheet.

Todo:
We check here if the recalc start is within the worksheet. Would it make more sense to store the recalculation start in a CellPointer that automagically zeroes itself if that isn't the case?

◆ RedrawIfRequested()

bool Worksheet::RedrawIfRequested ( )

Redraw the worksheet if RequestRedraw() has been called.

Also handles setting tooltips and redrawing the brackets on mouse movements.

◆ Replace()

void Worksheet::Replace ( const wxString &  oldString,
const wxString &  newString,
bool  ignoreCase 
)

Replace the current occurrence of a string.

Used by the find dialog.

◆ ReplaceAll()

int Worksheet::ReplaceAll ( const wxString &  oldString,
const wxString &  newString,
bool  ignoreCase 
)

Replace all occurrences of a string.

Used by the find dialog.

◆ RequestRedraw() [1/2]

void Worksheet::RequestRedraw ( GroupCell start = NULL)

Request the worksheet to be redrawn.

Parameters
startWhich cell do we need to start the redraw in? Subsequent calls to this function with different cells start the redraw at the upmost of the cells that were passed to it.

The actual redraw is done in the idle loop which means that as many redraw actions are merged as is necessary to allow wxMaxima to process things in real time.

Returns
true, if we did redraw a workscreet portion.

◆ RequestRedraw() [2/2]

void Worksheet::RequestRedraw ( wxRect  rect)

Request a part of the worksheet to be redrawn.

Parameters
rectThe rectangle that is to be requested to be redrawn. If this function is called multiple times the rectangles are automatically merged.

The actual redraw is done in the idle loop which means that as many redraw actions are merged as is necessary to allow wxMaxima to process things in real time.

◆ ScrolledAwayFromEvaluation()

void Worksheet::ScrolledAwayFromEvaluation ( bool  ScrolledAway)

Set or get the "Scrolled away from evaluation" status.

Sets FollowEvaluation() to false and enables the toolbar button to follow the evaluation process again.

◆ SetActiveCell()

void Worksheet::SetActiveCell ( EditorCell cell)

Mark an editor cell as the active one.

◆ SetAnswer()

void Worksheet::SetAnswer ( const wxString &  answer)

Handling questions from and answers for maxima.

Remember the answer to the LastQuestion().

◆ SetHCaret()

void Worksheet::SetHCaret ( GroupCell where)

Set the HCaret at the location of the given Cell.

Parameters
whereThe cell to place the cursor before.

◆ SetNotification()

void Worksheet::SetNotification ( const wxString &  message,
int  flags = wxICON_INFORMATION 
)

Inform the user that something happened in a non-active window.

This command will be ignored if the wxMaxima window is currently active

◆ ShowPoint()

void Worksheet::ShowPoint ( wxPoint  point)

Scrolls to a point on the worksheet.

Todo:
I have deactivated this assert for the release as it scares the users in a case we don't seem to have a problem. But we perhaps should try to find out why it is triggered.

Test case:

  • Create a code cell
  • Press the "hide all code cells" button.
  • click between 2 worksheet cells which makes the cursor appear as a horizontal line
  • press any letter.

◆ StepAnimation()

void Worksheet::StepAnimation ( int  change = 1)

Set the slide of the currently selected animation or advance it by one step.

Parameters
change
  • >=0: The slide the animation has to be set to
  • <0: Advance the animation by one step.

◆ ToggleFold()

GroupCell * Worksheet::ToggleFold ( GroupCell which)

Fold or unfold a cell.

Toggles the status of the fold for the given GroupCell.

If the cell is folded, it will be unfolded; otherwise it will be folded.

Parameters
whichThe GroupCell to fold or unfold.
Returns
A pointer to a GroupCell if the action succeeded; NULL otherwise.

◆ ToggleFoldAll()

GroupCell * Worksheet::ToggleFoldAll ( GroupCell which)

Toggles the status of the fold for the given GroupCell and its children.

If the cell is folded, it will be recursively unfolded; otherwise it will be recursively folded.

Parameters
whichThe GroupCell to recursively fold or unfold.
Returns
A pointer to a GroupCell if the action succeeded; NULL otherwise.

◆ UnicodeToMaxima()

const wxString Worksheet::UnicodeToMaxima ( wxString  s)

Make a few unicode characters interpretable by maxima.

Does convert the not equal sign to a '#' and similar.

◆ UpdateTableOfContents()

void Worksheet::UpdateTableOfContents ( )

Update the table of contents.

This function actually only schedules the update of the table-of-contents-tab. The actual update is done when wxMaxima is idle.


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