gridview.h

mini gui 1.6.8 lib and source

/**
 * \file gridview.h
 * \author Wei Yongming <[e-mail]>
 * \date 2002/01/06
 * 
 * The header file of MiniGUI extension library.
 *
 \verbatim
    Copyright (C) 2002-2005 Feynman Software
    Copyright (C) 1998-2002 Wei Yongming

    This file is part of MiniGUI, a compact cross-platform Graphics 
    User Interface (GUI) support system for real-time embedded systems.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    If you are using MiniGUI for developing commercial, proprietary, or other
    software not covered by the GPL terms, you must have a commercial license
    for MiniGUI. Please see http://www.minigui.com/product/index.html for 
    how to obtain this. If you are interested in the commercial MiniGUI 
    licensing, please write to [e-mail]. 

 \endverbatim
 */

/*
 * $Id: gridview.h,v 1.6 2005/09/04 06:50:19 jpzhang Exp $
 *
 *             MiniGUI for Linux/uClinux, eCos, uC/OS-II, VxWorks, 
 *                     and ThreadX version 1.6.x
 *             Copyright (C) 2002-2005 Feynman Software.
 *             Copyright (C) 1998-2002 Wei Yongming.
 */

#ifndef EXT_GRIDVIEW_H
#define EXT_GRIDVIEW_H

#ifdef  __cplusplus
extern "C" {
#endif

    /**
     * \addtogroup mgext_fns
     * @{
     */

    /**
     * \addtogroup mgext_controls
     * @{
     */

    /**
     * \defgroup mgext_ctrl_grid GridView control
     * @{
     */

#define CTRL_GRIDVIEW               "gridview"

#define GVS_COLFIRST                0x0000
#define GVS_ROWFIRST                0x0001

#define GRID_OKAY                   0
#define GRID_ERR                    (-1)

/** struct of the whole grid control */
typedef struct _GRIDVIEWDATA
{
    /** The number of the rows */
    int nr_rows;
    /** The number of the columns */
    int nr_cols;
    /** The default height of a row */
    int row_height;
    /** The default width of a column */
    int col_width;
} GRIDVIEWDATA;

/** The alignment of the cell */
/** column text horizontal left align, default */
#define GV_HALIGN_LEFT                          0x00000001
/** column text horizontal right align */
#define GV_HALIGN_RIGHT                         0x00000002
/** column text horizontal center align */
#define GV_HALIGN_CENTER                        0x00000003
/** column text vertical top align */
#define GV_VALIGN_TOP                           0x00000010
/** column text vertical bottom align */        
#define GV_VALIGN_BOTTOM                        0x00000020
/** column text vertical center align */        
#define GV_VALIGN_CENTER                        0x00000030

/** mask of horizontal align type */
#define GV_HALIGN_MASK                          0x0000000F

/** mask of vertical align type */
#define GV_VALIGN_MASK                          0x000000F0

/** the type of the unknown cell, use unknow type to query cell type */
#define GV_TYPE_UNKNOWN                         0x00000000
/** the text type of the cell */
#define GV_TYPE_TEXT                            0x00000100
/** the digit type of the cell */
#define GV_TYPE_NUMBER                          0x00000200
/** the checkbox type of the cell */
#define GV_TYPE_CHECKBOX                        0x00000300
/** the type of the cell having selection */
#define GV_TYPE_SELECTION                       0x00000400
/** the cell type of the row header or column header */
#define GV_TYPE_HEADER                          0x00000500
/** the cell type of the cell */
#define GV_TYPE_TABLEHEADER                     0x00000600

/** mask of grid cell type */
#define GV_TYPE_MASK                            0x0000FF00

/** a style of the cell, which has a icon bitmap */
#define GVS_WITHICON                            0x00010000
/** a style of the cell, which contains a checkbox */
#define GVS_WITHCHECKBOX                        0x00020000

/** a style of the cell, which text is multiple line*/
#define GVS_MULTLINE                          0x00100000
/** a status of the cell, which is read only*/
#define GVS_READONLY                            0x00200000
/** a status of the cell which has a checkbox and the checkbox is checked */
#define GVS_BOXCHECKED                          0x00400000

#define GVITEM_STYLE                            0x0001
#define GVITEM_BGCOLOR                          0x0002
#define GVITEM_FGCOLOR                          0x0004
#define GVITEM_FONT                             0x0008
#define GVITEM_IMAGE                            0x0010
#define GVITEM_MAINCONTENT                      0x0020 
#define GVITEM_SIZE                             0x0040

#define GVITEM_ALLCONTENT                       0x00FF

/** struct of the selected cell(s) */
typedef struct _GRIDCELLS
{
    /** the start row of the selected cell(s) */
    int row;
    /** the start column of the selected cell(s) */
    int column;
    /** the number of the column(s) which contain(s) selected cell(s) */
    int width;
    /** the number of the row(s) which contain(s) selected cell(s) */
    int height;
}GRIDCELLS;

typedef int (*GRIDCELLEVALCALLBACK)(GRIDCELLS* target, GRIDCELLS* source, DWORD dwAddData);

typedef struct _GRIDCELLDEPENDENCE
{
    GRIDCELLS source;
    GRIDCELLS target;
    GRIDCELLEVALCALLBACK callback;
    DWORD dwAddData;
}GRIDCELLDEPENDENCE;

/** struct of the header type cell */
typedef struct _GRIDCELLDATAHEADER
{
    /** the height of a row or the width of a column */
    int size;
    /** the caption of the row or column */
    char* buff;
    /** the length of the buff string */
    int len_buff;
}GRIDCELLDATAHEADER;

/** struct of the text type cell */
typedef struct _GRIDCELLDATATEXT
{
    /** the caption of the row or column */
    char* buff;
    /** the length of the buff string */
    int len_buff;
}GRIDCELLDATATEXT;

/** struct of the number type cell */
typedef struct _GRIDCELLDATANUMBER
{
    /** the value of the number type cell*/
    double number;
    /** the format of the number to display */
    char* format;
    /** the length of the format string */
    int len_format;
}GRIDCELLDATANUMBER;

/** struct of the checkbox type cell */
typedef struct _GRIDCELLDATACHECKBOX
{
    /** whether this checkbox is checked */
    BOOL checked;
    /** the text after checkbox */
    char* text;
    /** when used for set, -1 means null-terminated */
    int len_text;
}GRIDCELLDATACHECKBOX;

/** struct of the selection type cell */
typedef struct _GRIDCELLDATASELECTION
{
    /** the index of the combobox that current selected */
    int cur_index;
    /** "Yes\nNo\n"*/
    char* selections;
    /** when used for set, -1 means null-terminated */
    int len_sel;
}GRIDCELLDATASELECTION;

#if 0
/** struct of the evaluation type cell */
typedef struct _GRIDCELLDATAEVAL
{
    /** the value of the evaluation type cell */
    double number;
    /** the evaluation of one special cell */
    GRIDCELLS sourcecells;
    /** the callback function of one special cell */
    GRIDCELLEVALCALLBACK eval_callback;
    /** the format of the number to display */
    char* format;
    /** the length of the format string */
    int len_format;
}GRIDCELLDATAEVAL;
#endif

/** struct of the cell */
typedef struct _GRIDCELLDATA
{
    /** mask of properties, can be OR'ed with following values:
     * set or get a cell style
     * - GVITEM_STYLE\n
     * set or get a cell text color 
     * - GVITEM_FGCOLOR\n
     * set or get a cell background color 
     * - GVITEM_BGCOLOR\n
     * set or get a cell text font 
     * - GVITEM_FONT\n
     * set or get a cell's image 
     * - GVITEM_IMAGE\n
     * set or get all of the content of a cell
     * - GVITEM_ALLCONTENT\n
     * set or get the main content of a cell
     * - GVITEM_MAINCONTENT\n
     */
    DWORD mask;

    /** the style of the cell */
    DWORD style;
    /** text color */
    gal_pixel color_fg;
    /** the background color */
    gal_pixel color_bg;
    /** text font */
    PLOGFONT font;
    /** Pointer to the bitmap of one cell */
    PBITMAP image;
    /** the concrete data of one cell */
    void* content;
}GRIDCELLDATA;

    /** \defgroup mgext_control_grid_msgs Messages of grid control
     * @{
     */

/**
  * \def GRIDM_SETCELLPROPERTY
  *  
  * An Application sends a GRIDM_SETCELLPROPERTY message to set the cells' property in the grid control. 
  *
  *\code
  * GRIDM_SETCELLPROPERTY
  * GRIDCELLS cells;
  * GRIDCELLDATA* celldata;
  *
  * wParam cells, the cell(s) which you want to set it's(their) property
  * lParam celldata, the pointer of the property you want to set. 
  * \endcode
  *
  * \return Returns GRID_OKAY if successful, or GRID_ERR otherwise.
  * \sa GRIDCELLDATA
  */
#define  GRIDM_SETCELLPROPERTY    0xF210

/**
  * \def GRIDM_GETCELLPROPERTY
  *
  * An Application sends a GRIDM_GETPROPERTY message to get a single cell's property in the grid control.
  *
  *\code
  * GRIDM_GETCELLPROPERTY
  * GRIDCELLS cells;
  * GRIDCELLDATA* celldata;
  *
  * wParam cell. the cell(only for one cell now) which you want to get it's property
  * lParam celldata,  the pointer of the property you want to get. 
  * \endcode
  *
  * \return Returns GRID_OKAY if successful, or GRID_ERR otherwise.
  * \sa GRIDCELLDATA
  */

#define  GRIDM_GETCELLPROPERTY    0xF211

/**
  * \def GRIDM_SETCOLWIDTH
  *
  * An Application sends a GRIDM_SETCOLWIDTH message to set column width in the grid control.
  * if (lParam < 1 or lParam > nCols) , if will do nothing. nCows is the columns' count of the grid control.
  *
  *\code
  * GRIDM_SETCOLWIDTH
  * int index;
  * int width;
  *
  * wParam index, the index of the column which you want to set width.
  * lParam width, the width of the column you want to set. 
  * \endcode