minsky::GodleyTableWindow Class Reference

#include <godleyTableWindow.h>

Inheritance diagram for minsky::GodleyTableWindow:

Collaboration diagram for minsky::GodleyTableWindow:

Public Member Functions
	GodleyTableWindow (GodleyIcon &g)
void	requestRedraw ()
void	requestRedrawCanvas () override
void	mouseDown (float x, float y) override
void	mouseUp (float x, float y) override
void	mouseMove (float x, float y) override
void	zoom (double, double, double z) override
double	zoomFactor () const override
bool	keyPress (const EventInterface::KeyPressArgs &args) override
	handle key press over current itemFocus, More...
bool	hasScrollBars () const override
	return whether this window has scrollbars (needed for MacOSX). More...
void	draw (cairo_t *cairo)
Public Member Functions inherited from minsky::RenderNativeWindow
const RenderFrameArgs &	frameArgs () const
	~RenderNativeWindow () override
virtual void	init ()
	perform any initialisation of any subclasses of this More...
void	renderFrame (const RenderFrameArgs &args)
void	destroyFrame ()
void	draw ()
void	requestRedraw ()
void	macOSXRedraw ()
RenderNativeWindow &	operator= (const RenderNativeWindow &x)
	RenderNativeWindow ()=default
	RenderNativeWindow (const RenderNativeWindow &)=default
Public Member Functions inherited from minsky::EventInterface
virtual void	controlMouseDown (float x, float y)
virtual void	moveTo (float x, float y)
	move this so that (x,y) is centred More...
virtual std::vector< float >	position () const
	current centre coordinates More...
virtual bool	getItemAt (float x, float y)
	item or wire obtained by get*At() calls More...
virtual bool	getWireAt (float x, float y)
	item or wire obtained by get*At() calls More...
Public Member Functions inherited from minsky::GodleyTableEditor
GodleyIcon &	godleyIcon ()
const GodleyIcon &	godleyIcon () const
void	disableButtons ()
void	enableButtons ()
bool	selectedCellInTable () const
	GodleyTableEditor (GodleyIcon &g)
void	draw (cairo_t *cairo)
double	width () const
double	height () const
void	mouseDown (double x, double y)
	event handling More...
void	mouseUp (double x, double y)
void	mouseMoveB1 (double x, double y)
	mouse motion with button 1 pressed More...
void	mouseMove (double x, double y)
void	keyPress (int keySym, const std::string &utf8)
ClickType	clickTypeZoomed (double x, double y) const
	returns the clickType in zoomed coordinates More...
void	addStockVar (double x)
	add/delete rows/columns at x,y More...
void	addStockVarByCol (int c)
void	importStockVar (const std::string &name, double x)
void	importStockVarByCol (const std::string &name, int c)
void	deleteStockVar (double x)
void	deleteStockVarByCol (int c)
void	addFlow (double y)
void	addFlowByRow (int r)
void	deleteFlow (double y)
void	deleteFlowByRow (int r)
int	colXZoomed (double x) const
int	rowYZoomed (double y) const
std::string	moveAssetClass (double x, double y)
std::string	swapAssetClass (double x, double y)
void	highlightColumn (cairo_t *cairo, unsigned col)
void	highlightRow (cairo_t *cairo, unsigned row)
void	highlightCell (cairo_t *cairo, unsigned row, unsigned col)
void	delSelection ()
void	cut ()
void	copy ()
void	paste ()
int	textIdx (double x) const
void	pushHistory ()
void	undo (int changes)
	restore to state changes ago More...
void	adjustWidgets ()
	ensure button widgets are synced with current table data More...
void	update ()
	update canvas godleyIcon, and any related godley icons. Can throw More...
ClickType	clickType (double x, double y) const
std::set< string >	matchingTableColumns (double x)
	return list of matching table columns for column at x More...
std::set< string >	matchingTableColumnsByCol (int c)
void	navigateRight ()
	move selected cell right, left, up or down, moving to next line and wrapping if at end of row or col More...
void	navigateLeft ()
	move selected cell right, left, up or down, moving to next line and wrapping if at end of row or col More...
void	navigateUp ()
	move selected cell right, left, up or down, moving to next line and wrapping if at end of row or col More...
void	navigateDown ()
	move selected cell right, left, up or down, moving to next line and wrapping if at end of row or col More...

Protected Member Functions
bool	redraw (int, int, int width, int height) override
Protected Member Functions inherited from minsky::GodleyTableEditor
int	colX (double x) const
	column at x in unzoomed coordinates More...
int	rowY (double y) const
	row at y in unzoomed coordinates More...
void	checkCell00 ()
	check if cell (0,0) is selected, and deselect if so handle delete or backspace. Cell assumed selected More...
void	handleBackspace ()
void	handleDelete ()

Private Member Functions
	CLASSDESC_ACCESS (GodleyTableWindow)

Additional Inherited Members
Public Types inherited from minsky::GodleyTableEditor
enum	ClickType {   background, row0, col0, internal,   importStock, rowWidget, colWidget }
Public Types inherited from minsky::ButtonWidgetEnums
enum	RowCol { row, col }
enum	Pos {   first, second, middle, last,   firstAndLast }
Public Types inherited from minsky::GodleyAssetClass
enum	AssetClass { noAssetClass, asset, liability, equity }
enum	DisplayStyle { DRCR, sign }
Static Public Member Functions inherited from minsky::RenderNativeWindow
static double	scaleFactor ()
Public Attributes inherited from minsky::EventInterface
ItemPtr	item
	item or wire obtained by get*At() calls More...
WirePtr	wire
	item or wire obtained by get*At() calls More...
Public Attributes inherited from minsky::GodleyTableEditor
double	leftTableOffset =4*ButtonWidget<col>::buttonSpacing
	offset of the table within the window More...
double	topTableOffset =30
bool	drawButtons =true
	whether to draw row/column buttons More...
unsigned	scrollRowStart =1
	starting row/col number of the scrolling region More...
unsigned	scrollColStart =1
int	selectedRow =-1
	which cell is active, none initially More...
int	selectedCol =-1
int	srcRow =-1
	src cell in the event of a move More...
int	srcCol =-1
int	hoverRow =-1
int	hoverCol =-1
std::vector< double >	colLeftMargin
	computed positions of the table columns More...
double	rowHeight =0
	computed height of each row More...
unsigned	insertIdx =0
	location of insertion pointer in selected cell, as well as other end of selection (if mouse-swiped) More...
unsigned	selectIdx =0
double	zoomFactor =1
	zoom the display More...
std::size_t	maxHistory {100}
	maximum no. of history states to save More...
std::size_t	historyPtr =0
Static Public Attributes inherited from minsky::RenderNativeWindow
static ecolab::cairo::Colour	backgroundColour {0.8,0.8,0.8,1}
Static Public Attributes inherited from minsky::GodleyTableEditor
static constexpr double	columnButtonsOffset =12
static constexpr double	pulldownHot =12
	space for ▼ in stackVar cells minimum column width (for eg empty columns) More...
static constexpr double	minColumnWidth =4*ButtonWidget<col>::buttonSpacing
Protected Attributes inherited from minsky::GodleyTableEditor
std::vector< ButtonWidget< row > >	rowWidgets
std::vector< ButtonWidget< col > >	colWidgets
int	motionRow =-1
int	motionCol =-1
	current cell under mouse motion More...
std::deque< GodleyTable >	history

Detailed Description

Definition at line 216 of file godleyTableWindow.h.

Constructor & Destructor Documentation

GodleyTableWindow()

minsky::GodleyTableWindow::GodleyTableWindow ( GodleyIcon &  g )

inline

Definition at line 229 of file godleyTableWindow.h.

: GodleyTableEditor(g) {}

Member Function Documentation

CLASSDESC_ACCESS()

minsky::GodleyTableWindow::CLASSDESC_ACCESS ( GodleyTableWindow  )

private

draw()

void minsky::GodleyTableEditor::draw

Definition at line 156 of file godleyTableWindow.cc.

  {
    const CairoSave cs(cairo);
    cairo_scale(cairo,zoomFactor,zoomFactor);
    Pango pango(cairo);
    pango.setMarkup("Flows ↓ / Stock Vars →");
    rowHeight=pango.height()+2;
    const double tableHeight=(m_godleyIcon.table.rows()-scrollRowStart+1)*rowHeight;
    double x=leftTableOffset;
    double lastAssetBoundary=x;
    auto assetClass=GodleyAssetClass::noAssetClass;
    // only recalculate colmn widths when no cell is selected.
    const bool resizeGrid=selectedCol<0 || selectedRow<0 || motionRow>=0 || motionCol>=0;
    if (resizeGrid)
      colLeftMargin.clear();
  
    for (unsigned col=0; col<m_godleyIcon.table.cols(); ++col)
      {
        // omit stock columns less than scrollColStart
        if (col>0 && col<scrollColStart) continue;
        // vertical lines & asset type tag
        if (assetClass!=m_godleyIcon.table._assetClass(col))
          {
            if (assetClass!=GodleyAssetClass::noAssetClass)
              {
                pango.setMarkup(capitalise(enumKey<GodleyAssetClass::AssetClass>(assetClass)));
                // increase column by enough to fit asset class label
                if (x < pango.width()+lastAssetBoundary+3)
                  x=pango.width()+lastAssetBoundary+3;
                cairo_move_to(cairo,0.5*(x+lastAssetBoundary-pango.width()),0);
                showAsset(pango, cairo, assetClass);
              }
            lastAssetBoundary=x;
          
            assetClass=m_godleyIcon.table._assetClass(col);
            cairo_move_to(cairo,x+3,topTableOffset);
            cairo_rel_line_to(cairo,0,tableHeight);
          }
        cairo_move_to(cairo,x,topTableOffset);
        cairo_rel_line_to(cairo,0,tableHeight);
        cairo_set_line_width(cairo,0.5);
        cairo_stroke(cairo);
      
        if (drawButtons && col>0 && col<colWidgets.size())
          {
            const CairoSave cs(cairo);
            cairo_move_to(cairo, x, columnButtonsOffset);
            colWidgets[col].draw(cairo);   
          }
      
        if (col>1)
          {
            cairo_move_to(cairo,x-pulldownHot,topTableOffset);
            pango.setMarkup("▼");
            pango.show();
          }
      
        double y=topTableOffset;
        double colWidth=minColumnWidth;
        for (unsigned row=0; row<m_godleyIcon.table.rows(); ++row)
          {
            if (row>0 && row<scrollRowStart) continue;

            if (drawButtons && col==0 && row>0 && row<rowWidgets.size())
              {
                const CairoSave cs(cairo);
                cairo_move_to(cairo, 0, y);
                rowWidgets[row].draw(cairo);
              }
            
            const CairoSave cs(cairo);
            if (row!=0 || col!=0)               
              {
                // Make sure non-utf8 chars converted to utf8 as far as possible. for ticket 1166.  
                string text=utf_to_utf<char>(m_godleyIcon.table.cell(row,col));
                if (!text.empty())
                  {
                    string value;
                    FlowCoef fc(text);
                    if (cminsky().displayValues && col!=0)  // Do not add value "= 0.0" to first column. For tickets 1064/1274
                      try
                        {
                          auto vv=cminsky().variableValues
                            [valueId(m_godleyIcon.group.lock(),utf_to_utf<char>(fc.name))];
                          if (vv->idx()>=0)
                            {
                              const double val=fc.coef*vv->value();
                              auto ee=engExp(val);
                              if (ee.engExp==-3) ee.engExp=0;
                              value=" = "+mantissa(val,ee)+expMultiplier(ee.engExp);
                            }
                        }
                      catch (const std::exception& ex)
                        {
                          value=string("= Err: ")+ex.what();
                          // highlight error in red
                          cairo_set_source_rgb(cairo,1,0,0);
                        }
                            
                    // the active cell renders as bare LaTeX code for
                    // editing, all other cells rendered as LaTeX
                    if ((int(row)!=selectedRow || int(col)!=selectedCol) && !m_godleyIcon.table.initialConditionRow(row))
                      {
                        if (row>0 && col>0)    
                          { // handle DR/CR mode and colouring of text
                            if (fc.coef<0)
                              cairo_set_source_rgb(cairo,1,0,0);
                            if (cminsky().displayStyle==GodleyTable::DRCR)
                              {
                                if (assetClass==GodleyAssetClass::asset ||
                                    assetClass==GodleyAssetClass::noAssetClass)
                                  text = (fc.coef<0)?"CR ":"DR ";
                                else
                                  text = (fc.coef<0)?"DR ":"CR ";
                                fc.coef=abs(fc.coef);
                                text+=latexToPango(fc.str());
                              }
                            else
                              text = latexToPango(text);
                          }
                        else // is flow tag, stock var or initial condition
                          text = latexToPango(text);
                        text+=value;
                      }
                    else
                      //Display values of parameters used as initial conditions in Godley tables. for ticket 1126.  
                      if (m_godleyIcon.table.initialConditionRow(row) && cminsky().displayValues) text=defang(text+=value);
                      else text=defang(text);
                  }
                pango.setMarkup(text);
              }
            // allow extra space for the ▼ in row 0
            colWidth=max(colWidth,pango.width() + (row==0? pulldownHot:0));
            cairo_move_to(cairo,x+3,y);
            pango.show();
            y+=rowHeight;
          }
        colWidth+=5;

        if (resizeGrid)
          {
            colLeftMargin.push_back(x);
            x+=colWidth;
          }
        else if (col+1<colLeftMargin.size())
          x=colLeftMargin[col+1];
      }

    // display pulldown for last column
    cairo_move_to(cairo,x-pulldownHot,topTableOffset);
    pango.setMarkup("▼");
    pango.show();

  
    pango.setMarkup
      (capitalise(enumKey<GodleyAssetClass::AssetClass>(assetClass)));
    // increase column by enough to fit asset class label
    if (x < pango.width()+lastAssetBoundary+3)
      x=pango.width()+lastAssetBoundary+3;
    cairo_move_to(cairo,0.5*(x+lastAssetBoundary-pango.width()),0);
    showAsset(pango, cairo, assetClass);
    // final column vertical line
    colLeftMargin.push_back(x);
    cairo_move_to(cairo,x,topTableOffset);
    cairo_rel_line_to(cairo,0,tableHeight);
    cairo_move_to(cairo,x+3,topTableOffset);
    cairo_rel_line_to(cairo,0,tableHeight);
    cairo_set_line_width(cairo,0.5);
    cairo_stroke(cairo);

    cairo_move_to(cairo,x-pulldownHot,topTableOffset);

    // now row sum column
    x+=3;
    double y=topTableOffset;
    cairo_move_to(cairo,x,0);     // display A-L-E above the final column. for ticket 1285
    pango.setMarkup("A-L-E");
    pango.show();
    double colWidth=pango.width();
  
    for (unsigned row=0; row<m_godleyIcon.table.rows(); ++row)    // perform row sum on stock var heading column too. for ticket 1285
      {
        if (row >0 && row<scrollRowStart) continue;                    
        pango.setMarkup(latexToPango(m_godleyIcon.rowSum(row)));
        colWidth=max(colWidth,pango.width());
        cairo_move_to(cairo,x,y);
        pango.show();
        y+=rowHeight;
      }

    x+=colWidth;
    y=topTableOffset;
    for (unsigned row=0; row<=m_godleyIcon.table.rows(); ++row)
      {
        // horizontal lines
        if (row>0 && row<scrollRowStart) continue;
        cairo_move_to(cairo,leftTableOffset,y);
        cairo_line_to(cairo,x,y);
        cairo_set_line_width(cairo,0.5);
        cairo_stroke(cairo);
        y+=rowHeight;
      }

    // final vertical line
    colLeftMargin.push_back(x);
    cairo_move_to(cairo,x,topTableOffset);
    cairo_rel_line_to(cairo,0,tableHeight);
    cairo_set_line_width(cairo,0.5);
    cairo_stroke(cairo);

    // indicate cell mouse is hovering over
    if ((hoverRow>0 || hoverCol>0) &&                                
        size_t(hoverRow)<m_godleyIcon.table.rows() &&
        size_t(hoverCol)<m_godleyIcon.table.cols())
      {
        const CairoSave cs(cairo);
        cairo_rectangle(cairo,
                        colLeftMargin[hoverCol],hoverRow*rowHeight+topTableOffset,
                        colLeftMargin[hoverCol+1]-colLeftMargin[hoverCol],rowHeight);
        cairo_set_line_width(cairo,1);
        cairo_stroke(cairo);
      }
          
    // indicate selected cells
    {
      const CairoSave cs(cairo);
      if (selectedRow==0 || (selectedRow>=int(scrollRowStart) && selectedRow<int(m_godleyIcon.table.rows())))
        {
          size_t i=0, j=0;
          if (selectedRow>=int(scrollRowStart)) j=selectedRow-scrollRowStart+1;

          if (motionCol>=0 && selectedRow==0 && selectedCol>0) // whole col being moved
            {
              highlightColumn(cairo,selectedCol);
              highlightColumn(cairo,motionCol);
            }
          else if (motionRow>=0 && selectedCol==0 && selectedRow>0) // whole Row being moved
            {
              highlightRow(cairo,selectedRow);
              highlightRow(cairo,motionRow);
            }
          else if (selectedCol==0 || /* selecting individual cell */
                   (selectedCol>=int(scrollColStart) && selectedCol<int(m_godleyIcon.table.cols())))   
            {
              if ((selectedRow>1 || selectedRow <0) || selectedCol!=0) // can't select flows/stockVars or Initial Conditions labels
                {
                  if (selectedCol>=int(scrollColStart)) i=selectedCol-scrollColStart+1;
                  const double xx=colLeftMargin[i], yy=j*rowHeight+topTableOffset;
                  {
                    const cairo::CairoSave cs(cairo);
                    cairo_set_source_rgba(cairo,1,1,1,1);
                    cairo_rectangle(cairo,xx,yy,colLeftMargin[i+1]-xx,rowHeight);
                    cairo_fill_preserve(cairo);
                    cairo_set_source_rgba(cairo,1,.55,0,1);
                    cairo_set_line_width(cairo,2);
                    cairo_stroke(cairo);
                  }
                  pango.setMarkup(defang(m_godleyIcon.table.cell(selectedRow,selectedCol)));
                  cairo_move_to(cairo,xx,yy);
                  pango.show();
                                  
                  // show insertion cursor
                  cairo_move_to(cairo,xx+pango.idxToPos(insertIdx),yy);
                  cairo_rel_line_to(cairo,0,rowHeight);
                  cairo_set_line_width(cairo,1);
                  cairo_stroke(cairo);
                  if (motionRow>0 && motionCol>0)
                    highlightCell(cairo,motionRow,motionCol);
                  if (selectIdx!=insertIdx)
                    {
                      // indicate some text has been selected
                      cairo_rectangle(cairo,xx+pango.idxToPos(insertIdx),yy,
                                      pango.idxToPos(selectIdx)-pango.idxToPos(insertIdx),rowHeight);
                      cairo_set_source_rgba(cairo,0.5,0.5,0.5,0.5);
                      cairo_fill(cairo);
                   }
                }
            }
        }
    }
  }

hasScrollBars()

bool minsky::GodleyTableWindow::hasScrollBars ( ) const

inlineoverridevirtual

return whether this window has scrollbars (needed for MacOSX).

Reimplemented from minsky::RenderNativeWindow.

Definition at line 240 of file godleyTableWindow.h.

{return true;}

keyPress()

bool minsky::GodleyTableWindow::keyPress ( const EventInterface::KeyPressArgs &  )

inlineoverridevirtual

handle key press over current itemFocus,

Parameters

keySym	the X key sym code
utf8	utf8 encoded character
state	modifer state 1=shift, 2=caps lock, 4=ctrl, 8=alt
x	& y contain mouse coordinates

Returns

true if event handled

Reimplemented from minsky::EventInterface.

Definition at line 238 of file godleyTableWindow.h.

References minsky::GodleyTableEditor::keyPress(), minsky::EventInterface::KeyPressArgs::keySym, and minsky::EventInterface::KeyPressArgs::utf8.

    {GodleyTableEditor::keyPress(args.keySym,args.utf8); return true;}

Here is the call graph for this function:

mouseDown()

void minsky::GodleyTableWindow::mouseDown ( float  x, float  y  )

inlineoverridevirtual

Reimplemented from minsky::EventInterface.

Definition at line 233 of file godleyTableWindow.h.

References minsky::GodleyTableEditor::mouseDown().

{GodleyTableEditor::mouseDown(x,y);}

Here is the call graph for this function:

mouseMove()

void minsky::GodleyTableWindow::mouseMove ( float  x, float  y  )

inlineoverridevirtual

Reimplemented from minsky::EventInterface.

Definition at line 235 of file godleyTableWindow.h.

References minsky::GodleyTableEditor::mouseMove().

{GodleyTableEditor::mouseMove(x,y);}

Here is the call graph for this function:

mouseUp()

void minsky::GodleyTableWindow::mouseUp ( float  x, float  y  )

inlineoverridevirtual

Reimplemented from minsky::EventInterface.

Definition at line 234 of file godleyTableWindow.h.

References minsky::GodleyTableEditor::mouseUp().

{GodleyTableEditor::mouseUp(x,y);}

Here is the call graph for this function:

redraw()

bool minsky::GodleyTableWindow::redraw ( int  , int  , int  width, int  height  )

inlineoverrideprotected

Definition at line 220 of file godleyTableWindow.h.

References minsky::RenderNativeWindow::draw().

                                                          {
      if (surface.get()) {
        draw(surface->cairo());
        return true;
      }
      return false;
    }

Here is the call graph for this function:

requestRedraw()

void minsky::GodleyTableWindow::requestRedraw ( )

inline

Definition at line 230 of file godleyTableWindow.h.

Referenced by requestRedrawCanvas(), and zoom().

{if (surface.get()) surface->requestRedraw();}

Here is the caller graph for this function:

requestRedrawCanvas()

void minsky::GodleyTableWindow::requestRedrawCanvas ( )

inlineoverridevirtual

Reimplemented from minsky::GodleyTableEditor.

Definition at line 231 of file godleyTableWindow.h.

References requestRedraw().

{requestRedraw();}

Here is the call graph for this function:

zoom()

void minsky::GodleyTableWindow::zoom ( double  , double  , double  z  )

inlineoverridevirtual

Reimplemented from minsky::EventInterface.

Definition at line 236 of file godleyTableWindow.h.

References requestRedraw(), and minsky::GodleyTableEditor::zoomFactor.

{GodleyTableEditor::zoomFactor*=z; requestRedraw();}

Here is the call graph for this function:

zoomFactor()

double minsky::GodleyTableWindow::zoomFactor ( ) const

inlineoverridevirtual

Reimplemented from minsky::EventInterface.

Definition at line 237 of file godleyTableWindow.h.

References minsky::GodleyTableEditor::zoomFactor.

{return GodleyTableEditor::zoomFactor;}

---

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

• model/godleyTableWindow.h