form.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef FORM_H
#define FORM_H

#include <tccore/workspaceobject.h>
#include <form/libform_exports.h>

#define FORM_name_size_c  27

typedef struct FORM_field_s {
    char       name[FORM_name_size_c + 1];
    char*      value;
    int        error;                       
} FORM_field_t;

#ifdef __cplusplus
    extern "C"{
#endif

extern FORM_API int FORM_extent(
    int*            n_instances,    
    tag_t**         instances       
    );

extern FORM_API int FORM_create(
    const char      form_name[WSO_name_size_c + 1],     
    const char      description[WSO_desc_size_c + 1],   
    const char*     form_type,                          
    tag_t*          form                                
    );

extern FORM_API int FORM_copy(
    const char      new_name[WSO_name_size_c + 1],     
    tag_t*          SourceForm_tag,                    
    tag_t*          newForm_tag                        
    );

extern FORM_API int FORM_copy2(
    const char      *new_name,                         
    tag_t*          SourceForm_tag,                    
    tag_t*          newForm_tag                        
    );

extern FORM_API int FORM_initialize(
    tag_t           form,                               
    const char      form_name[WSO_name_size_c + 1],     
    const char      description[WSO_desc_size_c + 1],   
    const char*     form_type                           
    );

extern FORM_API int FORM_initialize2(
    tag_t           form,                               
    const char      *form_name,                         
    const char      *description,                       
    const char*     form_type                           
    );

extern FORM_API int FORM_ask_values(
    tag_t           form,           
    FORM_field_t**  field_data      
    );

extern FORM_API int FORM_free_values(
    FORM_field_t*   field_data      
    );

extern FORM_API int FORM_ask_value(
    tag_t           form,                               
    const char      field_name[FORM_name_size_c + 1],   
    int             max_chars,                          
    char*           field_value,                        
    int*            actual_chars                        
    );

extern FORM_API int FORM_set_value(
    tag_t           form,                               
    const char      field_name[FORM_name_size_c + 1],   
    const char*     field_value                         
    );

extern FORM_API int FORM_ask_file_name(
    tag_t           form,               
    char**          form_file_name      
    );

extern FORM_API int FORM_describe(
    tag_t           form,               
    char**          form_title,         
    int*            num_fields,         
    char***         prop_names,         
    char***         field_names,        
    int**           field_max_lengths,  
    char***         field_values        
    );

extern FORM_API int FORM_details(
    tag_t           form,                   
    char**          form_title,             
    int*            num_fields,             
    char***         prop_names,             
    logical**       prop_is_modifiable,     
    char***         field_names,            
    int**           field_max_lengths,      
    char***         field_values            
    );

extern FORM_API int FORM_ask_pom_instance(
    tag_t           form,           
    tag_t*          pom_instance    
    );

extern FORM_API int FORM_null_pom_instance(
    tag_t           form    
    );

extern FORM_API int FORM_ask_prop_names(
    tag_t           form,           
    int*            n_prop_names,   
    char***         prop_names      
    );

extern FORM_API int FORM_ask_property_descriptors(
    tag_t           form,           
    int*            n_propdescs,    
    tag_t**         propdescs       
    );

#ifdef __cplusplus
}
#endif

#include <form/libform_undef.h>
#endif