ZmTableTool.H

/* ZmTableTool.H */
/* $Id: ZmTableTool.H,v 1.5 2005/03/01 14:44:32 vlad Exp $ */
#ifndef __ZmTableTool_H
#define __ZmTableTool_H

#include <X11/Intrinsic.h>

#include <mix/Types.h>
#include <mix/IntAr.H>
#include <mix/growbuf.h>
#include <zm/ZmSelection.H>


#define ZmTT_DEFAULT_COLUMN_WIDTH   10

#define ZmTT_DEFAULT_RES_NAME       "TableTool"

#define ZmTT_DEFAULT_ROW_LABEL_WIDTH    6

#define ZmTT_VECTOR_SEPARATOR       "; "

class ZmTableTool : public ZmSelection
{
public:

  ZmTableTool (Widget wParent, int nColumns,
           const char* szResName = ZmTT_DEFAULT_RES_NAME);

  virtual ~ZmTableTool ();

  /*
   * Common service operations.
   */

  operator Widget () const;

  virtual void  set_visible_rows_number (int nVisRows);

  virtual void  limit_size ();

  virtual void  refresh ();

  virtual void  commit_changes ();

  void      fix_left_column (Logic flag);
  Logic     is_left_column_fixed () const;

  void      fix_rows_number (Logic flag);
  Logic     is_rows_number_fixed () const;

  void      set_current_pos (int iRow, int iColumn);
  void      get_current_pos (int& iRow, int& iColumn) const;

  enum ValueDiagnose {
    vdOK,       
    vdBadNumber,    
    vdBadDomain,    
    vdBadRange,     
    vdBadDbName,    
    vdTooLong,      
    vdTooShort,     
    vdSkip,     
    vdEmpty     
  };

  ValueDiagnose verify_string (AtomType atype, int dim, const char* s);

  ValueDiagnose verify_int (AtomType atype, const char* s);

  ValueDiagnose verify_real (AtomType atype, const char* s);

  void  scan_string (AtomType atype, const char* s, void* v);

  void  scan_string (AtomType atype, int dim, const char* s, void* v);

  /*
   * Virtual interface to overload in derived classes.
   * Internal data representation only.
   */

  /* *** Visual changes cause changes in internal data repres. *** */

  virtual void  write_cell (int iRow, int iColumn, const char* s);

  virtual void  delete_rows (int iRow, int nRows);

  virtual void  insert_rows (int iRow, int nRows);

  virtual void  add_row ();


  /* *** Internal data changes cause changes in visual repres. *** */

  virtual int   get_rows_count ();

  virtual char* draw_cell (int iRow, int iColumn);

  virtual char* get_column_label (int iColumn);

  virtual char* get_row_label (int iRow);

  /* sizes */

  virtual int   get_column_width (int iColumn);

  virtual int   get_column_length (int iColumn);

  virtual int   get_row_labels_width ();


  /* *** Virtual callbacks' stubs *** */

  virtual Logic start_modifying_cell (int iRow, int iColumn,
                      const char* szText);

  virtual Logic verify_cell (int iRow, int iColumn, const char* szText);

  virtual void  popup_menu (int iRow, int iColumn);


  /*
   *  Working with selection
   */

  void      select_all_rows ();

  void      unselect_rows ();

  void      select_row (int iRow);

  void      select_till_row (int iRow);

  void      get_selected_rows (IntAr& sRows) const;


  void      select_all_columns ();

  void      unselect_columns ();

  void      select_column (int iColumn, bool bForce = false);

  void      get_selected_columns (IntAr& sCols) const;



  /*
   *  Working with clipboard
   */

  virtual void  highlight_data (bool flag);

  void      copy_to_clipboard (Time timestamp);

  void      paste_from_clipboard (Time timestamp);

protected:

  Widget    wMatrix;

  Widget    wPopup;

  Widget    wPopupItem[16];
#define POPUP_MENU_clipboard    0
#define POPUP_MENU_sep1     1
#define POPUP_MENU_COPY     2
#define POPUP_MENU_PASTE    3
#define POPUP_MENU_sep2     4
#define POPUP_MENU_sep3     5
#define POPUP_MENU_rows     6
#define POPUP_MENU_sep4     7
#define POPUP_MENU_INSERT_ROW   8
#define POPUP_MENU_INSERT_ROWS  9
#define POPUP_MENU_DELETE   10
#define POPUP_MENU_DUPLICATE    11
#define POPUP_MENU_SELECT_ROW   12
#define POPUP_MENU_SELECT_TILL  13
#define POPUP_MENU_SELECT_ALL   14
#define POPUP_MENU_UNSELECT_ALL 15


  int       rows_cnt, columns_cnt;

  int       popup_row, popup_column;

  Logic     bFixedRowsNumber;

  GrowingBuffer gb;

  GrowingBuffer gbClipboard;

  enum DataDirection {
    Cell,
    Rows,
    Columns
  };

  /* Last selected row; -1 means disabled. */
  int       last_sel_row;

  IntAr     selRows;

  IntAr     selCols;

  IntAr     pubRows;

  IntAr     pubCols;


  Logic event_to_pos (XEvent* xev, int& iRow, int& iColumn);

  void  set_row_labels ();

  void  set_column_labels ();

  void  set_column_widths ();

  void  set_column_lengths ();

  void  normalize_pos (int& iRow, int& iColumn);

  /*
   * Own dialogs.
   */

  Logic dialog_number_of_rows (int &nRows);


  /*
   * Callbacks.
   */

  static void   PostItCB (Widget w, XtPointer pUserData,
              XEvent* event, Boolean* rc);

  static void   DrawWriteCellCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);

  static void   InsertRowCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);
  static void   InsertRowsCB (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

  static void   DeleteRowsCB (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

  static void   DuplicateRowsCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);

  static void   SelectRowCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);

  static void   SelectRowsHereCB (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

  static void   SelectAllRowsCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);

  static void   UnselectAllRowsCB (Widget w, XtPointer pUserData,
                   XtPointer pCallData);

  static void   EnterCellCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);

  static void   ModifyCellCB (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

  static void   VerifyCellCB (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

  static void   TrackVisibleCellCB (Widget w, XtPointer pUserData,
                    XtPointer pCallData);

  static void   LabelCB (Widget w, XtPointer pUserData,
             XtPointer pCallData);



  /*
   * Clipboard related callbacks
   */

  static void   ClipbCutCB (Widget w, XtPointer pUserData,
                XtPointer pCallData);

  static void   ClipbCopyCB (Widget w, XtPointer pUserData,
                 XtPointer pCallData);

  static void   ClipbPasteCB (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

};


#endif /* ZmTableTool.H */