idialog.h

GIS格式转换软件vc源码.GIS格式转换软件vc源码.

   // Then the parameterFile should be deleted from the disk.
   // The workspace itself will not exist until after the FME returns.
   //
   // If FME_FALSE is returned, they hit cancel.
   // If FME_TRUE is returned, they actually
   // did it, and the name of the parameter file and workspace file */
   virtual FME_Boolean generate(IFMEString &parameterFileName,  // out
                                IFMEString &workspaceFileName   // out
                               ) const = 0;

   // -----------------------------------------------------------------------
   /*! This method attempts to guess the format based on the extension of the 
   // filename passed in.  If we can guess, the result is written into
   // the "formatName" pointer, and FME_TRUE is returned.
   // If no guess can be made, then FME_FALSE is returned and the formatName is left
   // unset. */
   virtual FME_Boolean guessFormat(const char* filename,
                                   IFMEString& formatName) const = 0;

   // -----------------------------------------------------------------------
   /*! This method displays a standard FME coordinate system dialog to prompt 
   // the user to choose a coordinate system.
   // the "formatName" pointer, and FME_TRUE is returned.
   // If FME_FALSE is returned, they hit cancel.
   // If FME_TRUE is returned, they actually said yes.
   // coordSysName can be set to a default if you want something highlighted
   // when the dialog is brought up */
   virtual FME_Boolean coordSysPrompt(IFMEString& coordSysName) const = 0;

   // -----------------------------------------------------------------------
   /*! This method parses the file with the passed in name and does a standard
   // FME dialog for the parameters listed in the GUI lines in the file.
   // If any DEFAULT_MACRO lines were found, these supply default values.
   // If the user exits the form with OK, then the file will be overwritten
   // with a new file that alternates MACRO NAME and VALUE, line by line, and
   // FME_TRUE is returned.  Otherwise FME_FALSE is returned. */
   virtual FME_Boolean parameterPrompt(const char* filename) const = 0;

   // -----------------------------------------------------------------------
   /*! This method displays a dialog to prompt the user to choose both a
   // source and destination format and dataset.
   // The four input parameters point to default formats and datasets.
   // If no defaults are desired, then these should be input as 
   // 0 length strings.
   //
   // The "sourceUserDirectives" and "destUserDirectives" are both used 
   // input and output parameters.
   //
   // These userDirectives are encoded into the array with each
   // user directive taking two positions in the array. The
   // first position in each pair is the directive identifier
   // and the second position is the directive value.
   //
   // On input these directives are honoured in the sourceUserDirectives:
   //
   // <dl>
   //     <dt><b>"TITLE"</b></dt>
   //         <dd>The title to be used in the dialog box</dd>
   //     <dt><b>"LIMIT_FORMATS"</b></dt>
   //         <dd>The short names of the only formats that will be allowed,
   //             separated by | characters.</dd>
   //     <dt><b>"SPATIAL_SETTINGS"</b></dt>
   //         <dd>If value is "yes", then the any settings box 
   //             that allows for specifying spatial constraints will
   //             have that aspect remain enabled.</dd>
   //         <dd>If the value is "no", then the spatial area
   //             specification aspect of the settings boxes is
   //             disabled.</dd>
   //         <dd>The default is "yes".</dd>       
   // </dl>
   //
   // The directives returned in the sourceUserDirectives are 
   // as follows:
   //
   // <dl>
   //   <dt><b>"RUNTIME_MACROS"</b></dt><dd>The source runtime macros are in the next position.</dd>
   //   <dt><b>"META_MACROS"</b></dt><dd>The source metafile macros are in the next position.</dd>
   //   <dt><b>"METAFILE"</b></dt><dd>The source metafile name is in the next position.</dd>
   //   <dt><b>"COORDSYS"</b></dt><dd>The source coordinate system is in the next position.</dd>
   //   <dt><b>"IDLIST"</b></dt><dd>The id list is in the next position.</dd>
   // </dl>
   //
   // On input these directives are honoured for the destUserDirectives:
   //
   // The directives returned are as follows:
   //
   // <dl>
   //   <dt><b>"RUNTIME_MACROS"</b></dt><dd>The destination runtime macros are in the next position.</dd>
   //   <dt><b>"META_MACROS"</b></dt><dd>The destination metafile macros are in the next position.</dd>
   //   <dt><b>"METAFILE"</b></dt><dd>The destination metafile name is in the next position.</dd>
   //   <dt><b>"COORDSYS"</b></dt><dd>The destination coordinate system is in the next position.</dd>
   // </dl>
   //  
   // This array can be passed untouched to the writer userdirectives
   // parameter tieing the IFMEDialog and the IFMEUniversalWriter object
   // together easily.
   //
   // FME_FALSE is returned if they pressed cancel, 
   // otherwise FME_TRUE is returned.
   //
   // */
   virtual FME_Boolean xlatePrompt(const char* defaultSourceFormat,
                                   const char* defaultSourceDataset,
                                   const char* defaultDestFormat,
                                   const char* defaultDestDataset,
                                   IFMEString& sourceFormat,
                                   IFMEString& sourceDataset,
                                   IFMEStringArray& sourceUserDirectives,
                                   IFMEString& destFormat,
                                   IFMEString& destDataset,
                                   IFMEStringArray& destUserDirectives) const = 0;

#ifdef WIN32
   // -----------------------------------------------------------------------
   /*! This method is used to set the "parent" window of the application so 
   // that the dialogs correctly return focus to the parent after they
   // are dismissed. This prevents the application from loosing focus
   // when the dialogs are used.
   // The return value is meaningless.
   // */
   virtual FME_Boolean setParentWindow(HWND parentHandle) const = 0;

#endif

   // -----------------------------------------------------------------------
   /*! This method is deprecated. See IFMESession::getProperties() method. 
   // This method fills the string array with the mneumonic of the available 
   // formats which are licensed. FME_FALSE is returned if no formats are 
   // available, otherwise it returns FME_TRUE.
   // */
   virtual FME_Boolean getAvailableFormats
      (IFMEStringArray&                availableFormatsList) const = 0;

   // -----------------------------------------------------------------------
   /*! This method is deprecated. See IFMESession::getProperties() method.  
   // This method returns the information for the format, format is the
   // mneumonic name of the format. Only the information of licensed format
   // can be returned. formatinfo is a array of entries, the following
   // describes the array contents in their specific order:    
   // <dl>
   //    <dt>formatLongName</dt>
   //        <dd>A nice longer format name</dd>
   //    <dt>datasetType</dt>   
   //        <dd>Either 'DIR' or 'DIRONLY' or 'FILE' or 'FILEDIR' or 'DIRFILE' or 'DATABASE'</dd>
   //    <dt>direction</dt>     
   //        <dd>Either 'INPUT' or 'OUTPUT' or 'BOTH'</dd>
   //    <dt>filter</dt>        
   //        <dd>a valid DELPHI/Windows Filter, i.e. 'REGIS Files(*.fea)|*.fea|All Files|*.*'</dd>
   //    <dt>coordSysAware</dt> 
   //        <dd>If 'YES', then this format can read its coordinate system</dd>
   //    <dt>sourceSettings</dt>
   //        <dd>YES or NO are the values</dd>
   //    <dt>destSettings</dt>  
   //        <dd>YES or NO are the values</dd>
   //    <dt>genericTrans</dt>  
   //        <dd>Either 'INPUT' or 'OUTPUT' or 'BOTH' for generic translation ability</dd>
   // </dl>
   // Returns FME_FALSE if no format information is found for the 
   // format mneumonic, otherwise it returns FME_TRUE.
   //*/   
   virtual FME_Boolean getFormatInfo
      (const char*                  format, 
       IFMEStringArray&             formatInfo) const = 0;

   // -----------------------------------------------------------------------
   /*! This method is deprecated. See IFMESession::getProperties() method. 
   // This method returns the format information in an array representing name
   // value pairs. The format must be licensed before calling this method.  
   //*/   
   virtual FME_Boolean getFormatInfoEx
      (const char*                  format, 
       IFMEStringArray&             formatInfo) const = 0;

   // -----------------------------------------------------------------------
   /*! <b>BETA</b> -
   // Safe Software reserves the right to release subsequent versions 
   // that require changes to applications that use this API. 
   //
   // Bring up the feature type properties dialog on the given schema feature.
   // <dl>
   //    <dt>session</dt>
   //      <dd>Any FME session</dt>
   //    <dt>format</dt>
   //      <dd>The format name for the format this schema feature is a part of</dd>
   //    <dt>source</dt>
   //      <dd>Whether this feature type is a source or destination feature type</dd>
   //    <dt>schemaFeat</dt>
   //      <dd>The schema feature to edit</dd>
   //    <dt>formatCookie</dt>
   //      <dd>Reserved for internal use, pass in NULL</dd>
   // </dl>
   //    
   //*/
   virtual FME_Boolean featTypeProperties(IFMESession *session,
                                            const IFMEString& format,
                                            FME_Boolean source,
                                            IFMEFeature& schemaFeat,
                                            IFMEString* formatCookie = NULL) const = 0;

protected:
   
   // -----------------------------------------------------------------------
   /* Constructor */
   IFMEDialog() {};

   // -----------------------------------------------------------------------
   /* Destructor */
   virtual ~IFMEDialog() {}                      
   
private:
   // Hide methods that we don't want called.
   
   // -----------------------------------------------------------------------
   // copy constructor
   IFMEDialog(const IFMEDialog& other);

   // -----------------------------------------------------------------------
   // assignment operator.
   IFMEDialog& operator=(const IFMEDialog& other);
};

#endif