ICONVIEW.h

00001 /*********************************************************************
00002 *                SEGGER Microcontroller GmbH & Co. KG                *
00003 *        Solutions for real time microcontroller applications        *
00004 **********************************************************************
00005 *                                                                    *
00006 *        (c) 1996 - 2016  SEGGER Microcontroller GmbH & Co. KG       *
00007 *                                                                    *
00008 *        Internet: www.segger.com    Support:  support@segger.com    *
00009 *                                                                    *
00010 **********************************************************************
00011 
00012 ** emWin V5.38 - Graphical user interface for embedded applications **
00013 All  Intellectual Property rights  in the Software belongs to  SEGGER.
00014 emWin is protected by  international copyright laws.  Knowledge of the
00015 source code may not be used to write a similar product.  This file may
00016 only be used in accordance with the following terms:
00017 
00018 The software has been licensed to  NXP Semiconductors USA, Inc.  whose
00019 registered  office  is  situated  at 411 E. Plumeria Drive, San  Jose,
00020 CA 95134, USA  solely for  the  purposes  of  creating  libraries  for
00021 NXPs M0, M3/M4 and  ARM7/9 processor-based  devices,  sublicensed  and
00022 distributed under the terms and conditions of the NXP End User License
00023 Agreement.
00024 Full source code is available at: www.segger.com
00025 
00026 We appreciate your understanding and fairness.
00027 ----------------------------------------------------------------------
00028 Licensing information
00029 
00030 Licensor:                 SEGGER Microcontroller Systems LLC
00031 Licensed to:              NXP Semiconductors, 1109 McKay Dr, M/S 76, San Jose, CA 95131, USA
00032 Licensed SEGGER software: emWin
00033 License number:           GUI-00186
00034 License model:            emWin License Agreement, dated August 20th 2011
00035 Licensed product:         -
00036 Licensed platform:        NXP's ARM 7/9, Cortex-M0,M3,M4
00037 Licensed number of seats: -
00038 ----------------------------------------------------------------------
00039 File        : ICONVIEW.h
00040 Purpose     : ICONVIEW include
00041 --------------------END-OF-HEADER-------------------------------------
00042 */
00043 
00044 #ifndef ICONVIEW_H
00045 #define ICONVIEW_H
00046 
00047 #include "WM.h"
00048 #include "DIALOG_Intern.h"      /* Req. for Create indirect data structure */
00049 #include "WIDGET.h"
00050 
00051 #if GUI_WINSUPPORT
00052 
00053 #if defined(__cplusplus)
00054   extern "C" {     /* Make sure we have C-declarations in C++ programs */
00055 #endif
00056 
00057 /*********************************************************************
00058 *
00059 *       Defines
00060 *
00061 **********************************************************************
00062 */
00063 //
00064 // Status- and create flags
00065 //
00066 #define ICONVIEW_CF_AUTOSCROLLBAR_V (1 << 1)
00067 #define ICONVIEW_SF_AUTOSCROLLBAR_V ICONVIEW_CF_AUTOSCROLLBAR_V
00068 
00069 //
00070 // Color indices
00071 //
00072 #define ICONVIEW_CI_BK              0
00073 #define ICONVIEW_CI_UNSEL           0
00074 #define ICONVIEW_CI_SEL             1
00075 #define ICONVIEW_CI_DISABLED        2
00076 
00077 //
00078 // Icon alignment flags, horizontal
00079 //
00080 #define ICONVIEW_IA_HCENTER         (0 << 0)
00081 #define ICONVIEW_IA_LEFT            (1 << 0)
00082 #define ICONVIEW_IA_RIGHT           (2 << 0)
00083 
00084 //
00085 // Icon alignment flags, vertical
00086 //
00087 #define ICONVIEW_IA_VCENTER         (0 << 2)
00088 #define ICONVIEW_IA_BOTTOM          (1 << 2)
00089 #define ICONVIEW_IA_TOP             (2 << 2)
00090 
00091 /*********************************************************************
00092 *
00093 *       Types
00094 *
00095 **********************************************************************
00096 */
00097 typedef WM_HMEM ICONVIEW_Handle;
00098 
00099 /*********************************************************************
00100 *
00101 *       Public functions
00102 *
00103 **********************************************************************
00104 */
00105 ICONVIEW_Handle ICONVIEW_CreateEx      (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int xSizeItems, int ySizeItems);
00106 ICONVIEW_Handle ICONVIEW_CreateUser    (int x0, int y0, int xSize, int ySize, WM_HWIN hParent, int WinFlags, int ExFlags, int Id, int xSizeItems, int ySizeItems, int NumExtraBytes);
00107 ICONVIEW_Handle ICONVIEW_CreateIndirect(const GUI_WIDGET_CREATE_INFO * pCreateInfo, WM_HWIN hWinParent, int x0, int y0, WM_CALLBACK * cb);
00108 
00109 int  ICONVIEW_AddBitmapItem           (ICONVIEW_Handle hObj, const GUI_BITMAP * pBitmap, const char * pText);
00110 int  ICONVIEW_AddBMPItem              (ICONVIEW_Handle hObj, const U8 * pBMP, const char * pText);
00111 int  ICONVIEW_AddBMPItemEx            (ICONVIEW_Handle hObj, const void * pBMP, GUI_GET_DATA_FUNC * pfGetData, const char * pText);
00112 int  ICONVIEW_AddStreamedBitmapItem   (ICONVIEW_Handle hObj, const void * pStreamedBitmap, const char * pText);
00113 void ICONVIEW_DeleteItem              (ICONVIEW_Handle hObj, unsigned Index);
00114 void ICONVIEW_EnableStreamAuto        (void);
00115 U32  ICONVIEW_GetItemUserData         (ICONVIEW_Handle hObj, int Index);
00116 int  ICONVIEW_GetNumItems             (ICONVIEW_Handle hObj);
00117 int  ICONVIEW_GetItemText             (ICONVIEW_Handle hObj, int Index, char * pBuffer, int MaxSize);
00118 int  ICONVIEW_GetSel                  (ICONVIEW_Handle hObj);
00119 int  ICONVIEW_GetUserData             (ICONVIEW_Handle hObj, void * pDest, int NumBytes);
00120 int  ICONVIEW_InsertBitmapItem        (ICONVIEW_Handle hObj, const GUI_BITMAP * pBitmap, const char * pText, int Index);
00121 int  ICONVIEW_InsertBMPItem           (ICONVIEW_Handle hObj, const U8 * pBMP, const char * pText, int Index);
00122 int  ICONVIEW_InsertBMPItemEx         (ICONVIEW_Handle hObj, const void * pBMP, GUI_GET_DATA_FUNC * pfGetData, const char * pText, int Index);
00123 int  ICONVIEW_InsertStreamedBitmapItem(ICONVIEW_Handle hObj, const void * pStreamedBitmap, const char * pText, int Index);
00124 int  ICONVIEW_SetBitmapItem           (ICONVIEW_Handle hObj, int Index, const GUI_BITMAP * pBitmap);
00125 void ICONVIEW_SetBkColor              (ICONVIEW_Handle hObj, int Index, GUI_COLOR Color);
00126 int  ICONVIEW_SetBMPItem              (ICONVIEW_Handle hObj, const U8 * pBMP, int Index);
00127 int  ICONVIEW_SetBMPItemEx            (ICONVIEW_Handle hObj, const void * pBMP, GUI_GET_DATA_FUNC * pfGetData, int Index);
00128 void ICONVIEW_SetFont                 (ICONVIEW_Handle hObj, const GUI_FONT * pFont);
00129 void ICONVIEW_SetFrame                (ICONVIEW_Handle hObj, int Coord, int Value);
00130 void ICONVIEW_SetItemText             (ICONVIEW_Handle hObj, int Index, const char * pText);
00131 void ICONVIEW_SetItemUserData         (ICONVIEW_Handle hObj, int Index, U32 UserData);
00132 void ICONVIEW_SetSel                  (ICONVIEW_Handle hObj, int Sel);
00133 void ICONVIEW_SetSpace                (ICONVIEW_Handle hObj, int Coord, int Value);
00134 int  ICONVIEW_SetStreamedBitmapItem   (ICONVIEW_Handle hObj, int Index, const void * pStreamedBitmap);
00135 void ICONVIEW_SetIconAlign            (ICONVIEW_Handle hObj, int IconAlign);
00136 void ICONVIEW_SetTextAlign            (ICONVIEW_Handle hObj, int TextAlign);
00137 void ICONVIEW_SetTextColor            (ICONVIEW_Handle hObj, int Index, GUI_COLOR Color);
00138 int  ICONVIEW_SetUserData             (ICONVIEW_Handle hObj, const void * pSrc, int NumBytes);
00139 void ICONVIEW_SetWrapMode             (ICONVIEW_Handle hObj, GUI_WRAPMODE WrapMode);
00140 
00141 void ICONVIEW_Callback(WM_MESSAGE * pMsg);
00142 
00143 #if defined(__cplusplus)
00144   }
00145 #endif
00146 
00147 #endif  // GUI_WINSUPPORT
00148 #endif  // ICONVIEW_H
00149 
00150 /*************************** End of file ****************************/