CHOOSEFILE.h

00001 /*********************************************************************
00002 *                 SEGGER Software GmbH                               *
00003 *        Solutions for real time microcontroller applications        *
00004 **********************************************************************
00005 *                                                                    *
00006 *        (c) 1996 - 2018  SEGGER Microcontroller GmbH                *
00007 *                                                                    *
00008 *        Internet: www.segger.com    Support:  support@segger.com    *
00009 *                                                                    *
00010 **********************************************************************
00011 
00012 ** emWin V5.48 - 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 by SEGGER Software GmbH to Nuvoton Technology Corporationat the address: No. 4, Creation Rd. III, Hsinchu Science Park, Taiwan
00019 for the purposes  of  creating  libraries  for its 
00020 Arm Cortex-M and  Arm9 32-bit microcontrollers, commercialized and distributed by Nuvoton Technology Corporation
00021 under  the terms and conditions  of  an  End  User  
00022 License  Agreement  supplied  with  the libraries.
00023 Full source code is available at: www.segger.com
00024 
00025 We appreciate your understanding and fairness.
00026 ----------------------------------------------------------------------
00027 Licensing information
00028 Licensor:                 SEGGER Software GmbH
00029 Licensed to:              Nuvoton Technology Corporation, No. 4, Creation Rd. III, Hsinchu Science Park, 30077 Hsinchu City, Taiwan
00030 Licensed SEGGER software: emWin
00031 License number:           GUI-00735
00032 License model:            emWin License Agreement, signed February 27, 2018
00033 Licensed platform:        Cortex-M and ARM9 32-bit series microcontroller designed and manufactured by or for Nuvoton Technology Corporation
00034 ----------------------------------------------------------------------
00035 Support and Update Agreement (SUA)
00036 SUA period:               2018-03-26 - 2019-03-27
00037 Contact to extend SUA:    sales@segger.com
00038 ----------------------------------------------------------------------
00039 File        : CHOOSEFILE.h
00040 Purpose     : File dialog interface
00041 --------------------END-OF-HEADER-------------------------------------
00042 */
00043 
00044 #ifndef CHOOSEFILE_H
00045 #define CHOOSEFILE_H
00046 
00047 #include "WM.h"
00048 
00049 #if GUI_WINSUPPORT
00050 
00051 #if defined(__cplusplus)
00052 extern "C" {     /* Make sure we have C-declarations in C++ programs */
00053 #endif
00054 
00055 /*********************************************************************
00056 *
00057 *       Defines
00058 *
00059 **********************************************************************
00060 */
00061 #define CHOOSEFILE_FINDFIRST 0
00062 #define CHOOSEFILE_FINDNEXT  1
00063 
00064 #define CHOOSEFILE_FLAG_DIRECTORY (1 << 0)
00065 
00066 #ifndef   CHOOSEFILE_MAXLEN
00067   #define CHOOSEFILE_MAXLEN 256
00068 #endif
00069 
00070 #define CHOOSEFILE_BI_CANCEL 0
00071 #define CHOOSEFILE_BI_OK     1
00072 #define CHOOSEFILE_BI_UP     2
00073 
00074 /*********************************************************************
00075 *
00076 *       Types
00077 *
00078 **********************************************************************
00079 */
00080 /*********************************************************************
00081 *
00082 *       CHOOSEFILE_INFO
00083 */
00084 typedef struct CHOOSEFILE_INFO CHOOSEFILE_INFO;
00085 
00086 struct CHOOSEFILE_INFO {
00087   int               Cmd;                                 // Command for GetData() function
00088   int               Id;                                  // Id of pressed button (for internal use only)
00089   const char      * pMask;                               // Mask to be used for searching files
00090   char            * pName;                               // (for internal use only)
00091   char            * pExt;                                // (for internal use only)
00092   char            * pAttrib;                             // (for internal use only)
00093   WM_TOOLTIP_HANDLE hToolTip;                            // (for internal use only)
00094   U32               SizeL;                               // FileSize low word
00095   U32               SizeH;                               // FileSize high word
00096   U32               Flags;                               // File flags
00097   char              pRoot[CHOOSEFILE_MAXLEN];            // Buffer used internally and for passing result
00098   int            (* pfGetData)(CHOOSEFILE_INFO * pInfo); // Pointer to GetData() function
00099 };
00100 
00101 /*********************************************************************
00102 *
00103 *       Functions
00104 *
00105 **********************************************************************
00106 */
00107 WM_HWIN CHOOSEFILE_Create(WM_HWIN           hParent,  // Parent window
00108                           int               xPos,     // xPosition in window coordinates
00109                           int               yPos,     // yPosition in window coordinates
00110                           int               xSize,    // xSize in pixels
00111                           int               ySize,    // ySize in pixels
00112                           const char      * apRoot[], // Pointers to root strings
00113                           int               NumRoot,  // Number of roots
00114                           int               SelRoot,  // Root to be selected at first
00115                           const char      * sCaption, // Shown in title bar
00116                           int               Flags,    // Flags for FRAMEWINDOW
00117                           CHOOSEFILE_INFO * pInfo     // Pointer to CHOOSEFILE_INFO structure
00118                           );
00119 
00120 void    CHOOSEFILE_Callback            (WM_MESSAGE * pMsg);
00121 void    CHOOSEFILE_EnableToolTips      (void);
00122 void    CHOOSEFILE_SetButtonText       (WM_HWIN hWin, unsigned ButtonIndex, const char * pText);
00123 void    CHOOSEFILE_SetDefaultButtonText(unsigned ButtonIndex, const char * pText);
00124 void    CHOOSEFILE_SetDelim            (char Delim);
00125 void    CHOOSEFILE_SetToolTips         (const TOOLTIP_INFO * pInfo, int NumItems);
00126 void    CHOOSEFILE_SetTopMode          (unsigned OnOff);
00127 
00128 #if defined(__cplusplus)
00129   }
00130 #endif
00131 
00132 #endif /* GUI_WINSUPPORT */
00133 
00134 #endif /* CHOOSEFILE_H */
00135 
00136 /*************************** End of file ****************************/