wxMaximaFrame Class Reference

The frame containing the menu and the sidebars. More...

#include <wxMaximaFrame.h>

Inheritance diagram for wxMaximaFrame:

Collaboration diagram for wxMaximaFrame:

Public Member Functions
	wxMaximaFrame (wxWindow *parent, int id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxSYSTEM_MENU|wxCAPTION)
virtual	~wxMaximaFrame ()
	The destructor.
void	ShowToolBar (bool show)
	Shows or hides the toolbar. More...
void	UpdateRecentDocuments ()
	Update the recent documents list. More...
void	PopulateRecentDocumentsMenu (wxMenu *menu, int firstEntry, const std::list< wxString > &items)
	Used by UpdateRecentDocuments for populating a menu.
void	PopulateRecentPackagesMenu (wxMenu *menu, int firstEntry, const std::list< wxString > &items)
	Used by UpdateRecentPackages for populating a menu.
bool	IsPaneDisplayed (int id)
	true, if a Pane is currently enabled More...
void	ShowPane (int id, bool show=true)
	Show or hide a sidebar. More...
void	TogglePaneVisibility (int id)
void	AddToHistory (const wxString &cmd)
	Adds a command to the list of recently used maxima commands.
void	EvaluationQueueLength (int length, int numberOfCommands=-1)
	Inform the user about the length of the evaluation queue.
void	StatusMaximaBusy (StatusBar::MaximaStatus status)
	Set the status according to if maxima is calculating. More...
void	UpdateStatusMaximaBusy ()
void	StatusSaveStart ()
	Set the status to "Maxima is saving".
void	StatusSaveFinished ()
	Set the status to "Maxima has finished saving".
void	StatusSaveFailed ()
	Set the status to "Saving has failed".
void	StatusExportStart ()
	Set the status to "Maxima is exporting".
void	StatusExportFinished ()
	Set the status to "Maxima has finished exporting".
void	StatusExportFailed ()
	Set the status to "Exporting has failed".
void	BecomeLogTarget ()
	Makes this window the debug log target of all windows from this maxima process. More...
const std::unordered_map< int, wxString > &	GetSidebarNames () const
	Get the list of human-readable sidebarnames and IDs.
void	StatusText (const wxString &text, bool saveInLog=true)

Static Public Member Functions
static std::size_t	CountWindows ()

Data Fields
StatusBar::MaximaStatus	m_StatusMaximaBusy = StatusBar::wait_for_start
StatusBar::MaximaStatus	m_StatusMaximaBusy_next = StatusBar::wait_for_start

Protected Member Functions
void	OnNotificationClose (wxCommandEvent WXUNUSED(&event))
	Issued if a notification is closed.
void	RemoveTempAutosavefile ()
	Remove an eventual temporary autosave file.
void	ReReadConfig ()
	Re-read the configuration.
void	ReadConfig ()
	Read the configuration from the OS's configuration storage.
void	RegisterAutoSaveFile ()
	Remember a temporary autosave file name.
void	DockAllSidebars (wxCommandEvent &ev)
	An instant single-window mode. More...
wxString	wxMaximaManualLocation ()
Worksheet *	GetWorksheet () const
virtual wxSize	DoGetBestClientSize () const
	The default size for the window.
wxString	GetDemoFile (wxWindowID id) const
	Looks up which demo file belongs to a wxWindowID.
void	OnMenuStatusText (wxMenuEvent &event)
bool	ToolbarIsShown ()

Protected Attributes
Variablespane *	m_variablesPane = NULL
	The panel the user can display variable contents in.
TableOfContents *	m_tableOfContents = NULL
	The table of contents pane.
Configuration	m_configuration
std::size_t	m_bytesFromMaxima = 0
	How many bytes did maxima send us until now?
long	m_pid = -1
	The process id of maxima. Is determined by ReadFirstPrompt.
wxString	m_tempfileName
	The last name GetTempAutosavefileName() has returned.
StatusBar *	m_statusBar = NULL
	The status bar.
MainMenuBar *	m_MenuBar = NULL
	The menu bar.
wxMenu *	m_demo_sub = NULL
	The "demo" sub-menu.
std::vector< wxMenu * >	m_demoSubs
	The submenus for the various "demo" sub-submenus.
wxMenu *	m_viewMenu = NULL
	The "view" menu.
wxMenu *	m_gentranMenu = NULL
	The gentran menu.
wxMenu *	m_subst_Sub = NULL
	The subst submenu.
wxMenu *	m_logexpand_Sub = NULL
	The logexpand submenu.
wxMenu *	m_FileMenu = NULL
	The file menu.
wxMenu *	m_EditMenu = NULL
	The edit menu.
wxMenu *	m_CellMenu = NULL
	The cell menu.
wxMenu *	m_Edit_Zoom_Sub = NULL
	The zoom submenu.
wxMenu *	m_Maxima_Panes_Sub = NULL
	The panes submenu.
wxMenu *	m_EquationsMenu = NULL
	The equations menu.
wxMenu *	m_MaximaMenu = NULL
	The maxima menu.
wxMenu *	m_matrix_menu = NULL
	The matrix menu.
wxMenu *	m_SimplifyMenu = NULL
	The simplify menu.
wxMenu *	m_Simplify_Gamma_Sub = NULL
	The factorials and gamma submenu.
wxMenu *	m_debugTypeMenu = NULL
	Contains the menu for the debugger trigger settingxc.
wxMenu *	m_Simplify_Trig_Sub = NULL
	The trigonometric submenu.
wxMenu *	m_Simplify_Complex_Sub = NULL
	The complex submenu.
wxMenu *	m_CalculusMenu = NULL
	The calculus menu.
wxMenu *	m_PlotMenu = NULL
	The plot menu.
wxMenu *	m_listMenu = NULL
	The list menu.
wxMenu *	m_NumericMenu = NULL
	The numeric menu.
wxMenu *	m_HelpMenu = NULL
	The help menu.
ScrollingGenWizPanel *	m_wizard = NULL
long	m_drawDimensions_last = -1
	Are we inside a 2d or 3d draw command?
bool	m_newStatusText
	Do we have new text to output in the Status Bar?
wxString	m_rightStatusText
	The text for the Right half of the Status Bar.
wxString	m_leftStatusText
	The text for the Left half of the Status Bar.
DrawSidebar *	m_drawPane = NULL
	The sidebar with the draw commands.
std::array< wxString, 10 >	m_statusTextHistory
std::unordered_map< wxWindowID, wxString >	m_demoFilesIDs
SymbolsSidebar *	m_symbolsSidebar = NULL
int	m_EvaluationQueueLength = 0
	The current length of the evaluation queue of commands we still need to send to maxima.
bool	m_updateEvaluationQueueLengthDisplay = true
	Do we need to update the display showing the evaluation queue length?
int	m_commandsLeftInCurrentCell = 0
	The number of commands left in the current of the evaluation queue item.
bool	m_first = true
	Do we expect the 1st prompt from maxima to appear?
std::unique_ptr< wxAuiManager >	m_manager
	The manager for dynamic screen layouts.
Worksheet *const	m_worksheet = NULL
	The worksheet itself. More...
History *const	m_history = NULL
	The history pane.
XmlInspector *	m_xmlInspector = NULL
	A XmlInspector-like xml monitor.
bool	m_forceStatusbarUpdate = false
	true=force an update of the status bar at the next call of StatusMaximaBusy()
LogPane *	m_logPane = NULL
	The panel the log and debug messages will appear on.
RecentDocuments	m_recentDocuments
RecentDocuments	m_recentPackages
wxMenu *	m_recentDocumentsMenu = NULL
wxMenu *	m_unsavedDocumentsMenu = NULL
wxMenu *	m_recentPackagesMenu = NULL
wxMenu *	m_autoSubscriptMenu = NULL
wxMenu *	m_equationTypeMenuMenu = NULL
wxMenu *	m_roundedMatrixParensMenu = NULL

Detailed Description

The frame containing the menu and the sidebars.

Member Function Documentation

BecomeLogTarget()

void wxMaximaFrame::BecomeLogTarget

(

)

Makes this window the debug log target of all windows from this maxima process.

Only necessary on the mac where the same process creates loads of windows.

DockAllSidebars()

void wxMaximaFrame::DockAllSidebars ( wxCommandEvent &  ev )

protected

An instant single-window mode.

A last resort if https://trac.wxwidgets.org/ticket/18815 hinders one from re-docking windows.

IsPaneDisplayed()

bool wxMaximaFrame::IsPaneDisplayed

(

int

id

)

true, if a Pane is currently enabled

Parameters

id	The event that toggles the visibility of the pane that is to be queried

ShowPane()

void wxMaximaFrame::ShowPane	(	int	id,
		bool	show = true
	)

Show or hide a sidebar.

Parameters

id	The type of the sidebar to show/hide
show	true: show the sidebar false: hide it

ShowToolBar()

void wxMaximaFrame::ShowToolBar

(

bool

show

)

Shows or hides the toolbar.

Parameters

show	true: Show the toolbar false: Hide the toolbar

StatusMaximaBusy()

void wxMaximaFrame::StatusMaximaBusy ( StatusBar::MaximaStatus  status )

inline

Set the status according to if maxima is calculating.

Parameters

status

true: Maxima is calculating false: Maxima is waiting for input

UpdateRecentDocuments()

void wxMaximaFrame::UpdateRecentDocuments

(

)

Update the recent documents list.

Copies the string array containing the list of recent documents to the recent documents menu.

Field Documentation

m_worksheet

Worksheet* const wxMaximaFrame::m_worksheet = NULL

protected

The worksheet itself.

The worksheet

---

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

• src/wxMaximaFrame.h
• src/wxMaximaFrame.cpp