Grid Class Reference

Supplies an accessible grid based on wxGrid. More...

#include <Grid.h>

Inheritance diagram for Grid:

Collaboration diagram for Grid:

Public Member Functions
	Grid (const FormatterContext &context, wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxWANTS_CHARS|wxBORDER, const wxString &name=wxPanelNameStr)
	~Grid ()

Protected Member Functions
void	OnSetFocus (wxFocusEvent &event)
void	OnSelectCell (wxGridEvent &event)
void	OnEditorShown (wxGridEvent &event)
void	OnKeyDown (wxKeyEvent &event)

Private Attributes
FormatterContext	mContext

Detailed Description

Supplies an accessible grid based on wxGrid.

wxGrid with support for accessibility.

Definition at line 189 of file Grid.h.

Constructor & Destructor Documentation

Grid()

Grid::Grid	(	const FormatterContext &	context,
		wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxWANTS_CHARS | wxBORDER,
		const wxString &	name = wxPanelNameStr
	)

Definition at line 464 of file Grid.cpp.

: wxGrid(parent, id, pos, size, style | wxWANTS_CHARS, name), mContext(context)
{
#if wxUSE_ACCESSIBILITY
   GetGridWindow()->SetAccessible(mAx = safenew GridAx(mContext, this));
#endif
 
   // RegisterDataType takes ownership of renderer and editor
 
   RegisterDataType(GRID_VALUE_TIME,
                    safenew NumericRenderer{ mContext, NumericConverterType_TIME() },
                    safenew NumericEditor
                      { mContext, NumericConverterType_TIME(),
                        NumericConverterFormats::SecondsFormat().Internal() });
 
   RegisterDataType(GRID_VALUE_FREQUENCY,
                    safenew NumericRenderer{ mContext, NumericConverterType_FREQUENCY() },
                    safenew NumericEditor
                    { mContext, NumericConverterType_FREQUENCY(),
                      NumericConverterFormats::HertzFormat().Internal() });
 
   RegisterDataType(GRID_VALUE_CHOICE,
                    safenew wxGridCellStringRenderer,
                    safenew ChoiceEditor);
 
   // Bug #2803:
   // Ensure selection doesn't show up.
   SetSelectionForeground(GetDefaultCellTextColour());
   SetSelectionBackground(GetDefaultCellBackgroundColour());
}

References GRID_VALUE_CHOICE, GRID_VALUE_FREQUENCY, GRID_VALUE_TIME, NumericConverterFormats::HertzFormat(), ComponentInterfaceSymbol::Internal(), NumericConverterType_FREQUENCY(), NumericConverterType_TIME(), safenew, and NumericConverterFormats::SecondsFormat().

Here is the call graph for this function:

~Grid()

Grid::~Grid

(

)

Definition at line 502 of file Grid.cpp.

{
#if wxUSE_ACCESSIBILITY
   int cnt = mChildren.size();
   while (cnt--) {
      // PRL: I found this loop destroying right-to-left.
      // Is the sequence of destruction important?
      mChildren.pop_back();
   }
#endif
}

Member Function Documentation

OnEditorShown()

void Grid::OnEditorShown ( wxGridEvent &  event )

protected

Definition at line 534 of file Grid.cpp.

{
   event.Skip();
 
   // Bug #2803 (comment 7):
   // Select row whenever an editor is displayed
   SelectRow(GetGridCursorRow());
}

OnKeyDown()

void Grid::OnKeyDown ( wxKeyEvent &  event )

protected

Definition at line 543 of file Grid.cpp.

{
   auto keyCode = event.GetKeyCode();
   int crow = GetGridCursorRow();
   int ccol = GetGridCursorCol();
 
   if (event.CmdDown() && crow != wxGridNoCellCoords.GetRow() && ccol != wxGridNoCellCoords.GetCol())
   {
      wxClipboardLocker cb;
 
      switch (keyCode)
      {
         case 'C': // Copy
         {
            wxTextDataObject *data = safenew wxTextDataObject(GetCellValue(crow, ccol));
            wxClipboard::Get()->SetData(data);
            return;
         }
         break;
 
         case 'X': // Cut
         {
            wxTextDataObject *data = safenew wxTextDataObject(GetCellValue(crow, ccol));
            wxClipboard::Get()->SetData(data);
            SetCellValue(crow, ccol, "" );
            return;
         }
         break;
 
         case 'V': // Paste
         {
            if (wxClipboard::Get()->IsSupported(wxDF_UNICODETEXT))
            {
               wxTextDataObject data;
               if (wxClipboard::Get()->GetData(data))
               {
                  SetCellValue(crow, ccol, data.GetText());
                  return;
               }
            }
         }
         break;
      }
   }
 
   switch (keyCode)
   {
      case WXK_LEFT:
      case WXK_RIGHT:
      {
         int rows = GetNumberRows();
         int cols = GetNumberCols();
 
         const bool has_cells = rows > 0 && cols > 0;
 
         if (has_cells) {
            int crow = GetGridCursorRow();
            int ccol = GetGridCursorCol();
 
            const bool has_no_selection = crow == wxGridNoCellCoords.GetRow() || ccol == wxGridNoCellCoords.GetCol();
 
            if (has_no_selection) {
               SetGridCursor(0, 0);
            }
            else if (event.GetKeyCode() == WXK_LEFT) {
               if (crow == 0 && ccol == 0) {
                  // do nothing
               }
               else if (ccol == 0) {
                  SetGridCursor(crow - 1, cols - 1);
               }
               else {
                  SetGridCursor(crow, ccol - 1);
               }
            }
            else {
               if (crow == rows - 1 && ccol == cols - 1) {
                  // do nothing
               }
               else if (ccol == cols - 1) {
                  SetGridCursor(crow + 1, 0);
               }
               else {
                  SetGridCursor(crow, ccol + 1);
               }
            }
         }
 
#if wxUSE_ACCESSIBILITY
         // Make sure the NEW cell is made available to the screen reader
         mAx->SetCurrentCell(GetGridCursorRow(), GetGridCursorCol());
#endif
      }
      break;
 
      case WXK_TAB:
      {
         if (event.ControlDown()) {
            int flags = wxNavigationKeyEvent::FromTab |
                        ( event.ShiftDown() ?
                          wxNavigationKeyEvent::IsBackward :
                          wxNavigationKeyEvent::IsForward );
            Navigate(flags);
            return;
         }
 
         int rows = GetNumberRows();
         int cols = GetNumberCols();
         int crow = GetGridCursorRow();
         int ccol = GetGridCursorCol();
 
         const auto is_empty = rows <= 0 || cols <= 0;
         const auto has_no_selection = crow == wxGridNoCellCoords.GetRow() || ccol == wxGridNoCellCoords.GetCol();
 
         if (event.ShiftDown()) {
            if (is_empty) {
               Navigate(wxNavigationKeyEvent::FromTab | wxNavigationKeyEvent::IsBackward);
               return;
            }
 
            if (crow == 0 && ccol == 0) {
               Navigate(wxNavigationKeyEvent::FromTab | wxNavigationKeyEvent::IsBackward);
               return;
            }
 
            if (has_no_selection) {
               SetGridCursor(rows -1, cols - 1);
            }
            else if (ccol == 0) {
               SetGridCursor(crow - 1, cols - 1);
            }
            else {
               SetGridCursor(crow, ccol - 1);
            }
         }
         else {
            if (is_empty) {
               Navigate(wxNavigationKeyEvent::FromTab | wxNavigationKeyEvent::IsForward);
               return;
            }
 
            if (crow == rows - 1 && ccol == cols - 1) {
               Navigate(wxNavigationKeyEvent::FromTab | wxNavigationKeyEvent::IsForward);
               return;
            }
 
            if (has_no_selection) {
               SetGridCursor(0, 0);
            }
            else if (ccol == cols - 1) {
               SetGridCursor(crow + 1, 0);
            }
            else {
               SetGridCursor(crow, ccol + 1);
            }
         }
 
         MakeCellVisible(GetGridCursorRow(), GetGridCursorCol());
 
#if wxUSE_ACCESSIBILITY
         // Make sure the NEW cell is made available to the screen reader
         mAx->SetCurrentCell(GetGridCursorRow(), GetGridCursorCol());
#endif
      }
      break;
 
      case WXK_RETURN:
      case WXK_NUMPAD_ENTER:
      {
         if (!IsCellEditControlShown()) {
            wxTopLevelWindow *tlw = wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
            wxWindow *def = tlw->GetDefaultItem();
            if (def && def->IsEnabled()) {
               wxCommandEvent cevent(wxEVT_COMMAND_BUTTON_CLICKED,
                                     def->GetId());
               cevent.SetEventObject( def );
               GetParent()->GetEventHandler()->ProcessEvent(cevent);
            }
         }
         else {
            wxGrid::OnKeyDown(event);
 
            // This looks strange, but what it does is selects the cell when
            // enter is pressed after editing.  Without it, Jaws and Window-Eyes
            // do not speak the NEW cell contents (the one below the edited one).
            SetGridCursor(GetGridCursorRow(), GetGridCursorCol());
         }
         break;
      }
 
      default:
         wxGrid::OnKeyDown(event);
      break;
   }
}

References BasicUI::Get(), safenew, and wxEVT_COMMAND_BUTTON_CLICKED.

Here is the call graph for this function:

OnSelectCell()

void Grid::OnSelectCell ( wxGridEvent &  event )

protected

Definition at line 523 of file Grid.cpp.

{
   event.Skip();
 
   MakeCellVisible(event.GetRow(), event.GetCol());
 
#if wxUSE_ACCESSIBILITY
   mAx->SetCurrentCell(event.GetRow(), event.GetCol());
#endif
}

OnSetFocus()

void Grid::OnSetFocus ( wxFocusEvent &  event )

protected

Definition at line 514 of file Grid.cpp.

{
   event.Skip();
 
#if wxUSE_ACCESSIBILITY
   mAx->SetCurrentCell(GetGridCursorRow(), GetGridCursorCol());
#endif
}

Member Data Documentation

mContext

FormatterContext Grid::mContext

private

Definition at line 225 of file Grid.h.

---

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

• Grid.h
• Grid.cpp