folder.h

Go to the documentation of this file.

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

/*  */

#ifndef FOLDER_H
#define FOLDER_H

#ifndef FOLDER_ERRORS_H
    #include <tc/folder_errors.h>
#endif

#ifndef INFOMANAGER_H
#include <tc/tc_startup.h>
#endif

#ifndef WORKSPACEOBJECT_H
    #include <tccore/workspaceobject.h>
#endif

typedef enum FL_sort_criteria_e {
    FL_fsc_as_ordered,

    FL_fsc_by_name,
    FL_fsc_by_object,
    FL_fsc_by_type,
    FL_fsc_by_date_created,
    FL_fsc_by_date_modified,
    FL_fsc_by_date_released,

    FL_fsc_no_order,
    FL_fsc_bad

} FL_sort_criteria_t;

typedef enum FL_sort_order_e {

    FL_fso_ascending,
    FL_fso_descending,
    FL_fso_as_ordered,

    FL_fso_bad

} FL_sort_order_t;

#ifdef OBSOLETE
    const int FSC_asOrdered     = FL_fsc_as_ordered;
    const int FSC_byName        = FL_fsc_by_name;
    const int FSC_byObject      = FL_fsc_by_object;
    const int FSC_byType        = FL_fsc_by_type;
    const int FSC_byDateCreated = FL_fsc_by_date_created;
    const int FSC_byDateModified= FL_fsc_by_date_modified;
    const int FSC_byDateReleased= FL_fsc_by_date_released;
    const int FSO_ascending     = FL_fso_ascending;
    const int FSO_descending    = FL_fso_descending;
#endif

#include <tc/libtc_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

extern TC_API int FL_init_module();

extern TC_API int FL_exit_module();

extern TC_API int FL_create(
    const char      name[WSO_name_size_c + 1],          
    const char      description[WSO_desc_size_c + 1],   
    tag_t*          pfolder_tag                         
    );

extern TC_API int FL_initialize(
    tag_t           folder_tag,                         
    const char      name[WSO_name_size_c + 1],          
    const char      description[WSO_desc_size_c + 1]    
    );


extern TC_API int FL_initialize2(
    tag_t           folder_tag,                         
    const char      *name,                              
    const char      *description                        
    );

extern TC_API int FL_extent(
    int*            num_of_folders,     
    tag_t**         ppfolder_tags       
    );

extern TC_API int FL_insert(
    tag_t           folder_tag,             
    tag_t           workspaceobject_tag,    
    int             position                
    );

extern TC_API int FL_insert_instances(
    tag_t           folder_tag,             
    int             nInstances,             
    tag_t*          workspaceobject_tags,   
    int             position                
    );

extern TC_API int FL_remove(
    tag_t           folder_tag,             
    tag_t           workspaceobject_tag     
    );

extern TC_API int FL_move(
    tag_t           folder_tag,         
    int             old_start_index,    
    int             old_end_index,      
    int             new_start_index     
    );

extern TC_API int FL_copy(
    tag_t           folder_tag,                             
    const char      new_folder_name[WSO_name_size_c + 1],   
    tag_t*          new_folder_tag                          
    );

extern TC_API int FL_copy2(
    tag_t           folder_tag,                             
    const char      *new_folder_name,                       
    tag_t*          new_folder_tag                          
    );

extern TC_API int FL_ask_references(
    tag_t               folder_tag,             
    FL_sort_criteria_t  sort_criteria,          
    int*                num_of_references,      
    tag_t**             list_of_references      
    );

extern TC_API int FL_ask_index(
    tag_t               folder_tag,             
    tag_t               workspaceobject_tag,    
    FL_sort_criteria_t  sort_criteria,          
    int*                ref_index               
    );

extern TC_API int FL_set_sort_order(
    tag_t           folder_tag,     
    FL_sort_order_t sort_order      
    );

extern TC_API int FL_ask_sort_order(
    tag_t               folder_tag,     
    FL_sort_order_t*    sort_order      
    );

extern TC_API int FL_set_sort_criteria(
    tag_t               folder_tag,     
    FL_sort_criteria_t  sort_criteria   
    );

extern TC_API int FL_ask_sort_criteria(
    tag_t               folder_tag,     
    FL_sort_criteria_t* sort_criteria   
    );

extern TC_API int FL_ask_size(
    tag_t           folder_tag,         
    int*            number_of_entries   
    );

extern TC_API int FL_user_update_newstuff_folder (
    tag_t           folder_tag      
    );

#ifdef __cplusplus
}
#endif

#include <tc/libtc_undef.h>

#endif