document.h

Go to the documentation of this file.

// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
// This file is intended for public distribution.

#ifndef LAYOUT_MODEL_DOCUMENT_H_
#define LAYOUT_MODEL_DOCUMENT_H_

#include <LayOutAPI/common.h>
#include <LayOutAPI/model/defs.h>
#include <LayOutAPI/model/imagerep.h>
#include <time.h>

typedef enum {
  LODocumentVersion_1 = 1,      
  LODocumentVersion_2 = 2,      
  LODocumentVersion_3 = 3,      
  LODocumentVersion_2013 = 13,  
  LODocumentVersion_2014 = 14,  
  LODocumentVersion_2015 = 15,  
  LODocumentVersion_2016 = 16,  
  LODocumentVersion_2017 = 17,  
  LODocumentVersion_2018 = 18,  
  LODocumentVersion_2019 = 19,  
  LODocumentVersion_2020 = 20,  
  LODocumentVersion_2021 = 21,  
  LODocumentVersion_2022 = 22,  
  LODocumentVersion_2023 = 23,  

  LODocumentVersion_Current = LODocumentVersion_2023,  

  LONumDocumentVersions
} LODocumentVersion;

typedef enum {
  LODocumentUnits_FractionalInches = 0,  
  LODocumentUnits_DecimalInches,         
  LODocumentUnits_DecimalFeet,           
  LODocumentUnits_DecimalMillimeters,    
  LODocumentUnits_DecimalCentimeters,    
  LODocumentUnits_DecimalMeters,         
  LODocumentUnits_DecimalPoints,         

  LONumDocumentUnits
} LODocumentUnits;

#ifdef __cplusplus
extern "C" {
#endif

LO_RESULT LODocumentCreateEmpty(LODocumentRef* document);

LO_RESULT LODocumentCreateFromFile(LODocumentRef* document, const char* path);

LO_RESULT LODocumentCreateFromTemplate(LODocumentRef* document, const char* path);

LO_RESULT LODocumentRelease(LODocumentRef* document);

LO_RESULT LODocumentAddReference(LODocumentRef document);

LO_RESULT LODocumentSaveToFile(LODocumentRef document, const char* path, LODocumentVersion version);

LO_RESULT LODocumentExportToPDF(
    LODocumentRef document, const char* path, LODictionaryRef options_dict);


LO_RESULT LODocumentExportToImageSet(
    LODocumentRef document, const char* export_path, const char* base_name,
    LOImageRepOutputFormat format, LODictionaryRef options_dict);

LO_RESULT LODocumentGetFilePath(LODocumentRef document, SUStringRef* path);

LO_RESULT LODocumentGetNumberOfLayers(LODocumentRef document, size_t* num_layers);

LO_RESULT LODocumentGetLayerAtIndex(
    LODocumentRef document, size_t index, LOLayerRef* layer_definition);

LO_RESULT LODocumentGetLayers(LODocumentRef document, LOLayerListRef layer_definitions);

LO_RESULT LODocumentGetActiveLayer(LODocumentRef document, LOLayerRef* layer_definition);

LO_RESULT LODocumentSetActiveLayer(LODocumentRef document, LOLayerRef layer_definition);

LO_RESULT LODocumentReorderLayer(
    LODocumentRef document, LOLayerRef layer_definition, size_t new_index);
LO_RESULT LODocumentAddLayer(LODocumentRef document, bool shared, LOLayerRef* layer_definition);

LO_RESULT LODocumentRemoveLayer(
    LODocumentRef document, LOLayerRef* layer_definition, bool delete_entities);

LO_RESULT LODocumentGetPageInfo(LODocumentRef document, LOPageInfoRef* page_info);

LO_RESULT LODocumentGetGrid(LODocumentRef document, LOGridRef* grid);

LO_RESULT LODocumentGetNumberOfPages(LODocumentRef document, size_t* num_pages);

LO_RESULT LODocumentGetPageAtIndex(LODocumentRef document, size_t index, LOPageRef* page);

LO_RESULT LODocumentGetPages(LODocumentRef document, LOPageListRef pages);

LO_RESULT LODocumentGetInitialPage(LODocumentRef document, LOPageRef* page);

LO_RESULT LODocumentSetInitialPage(LODocumentRef document, LOPageRef page);

LO_RESULT LODocumentAddPage(LODocumentRef document, LOPageRef* page);

LO_RESULT LODocumentRemovePage(LODocumentRef document, LOPageRef* page);

LO_RESULT LODocumentReorderPage(LODocumentRef document, LOPageRef page, size_t new_index);

LO_RESULT LODocumentAddEntity(
    LODocumentRef document, LOEntityRef entity, LOLayerRef layer_definition, LOPageRef page);

LO_RESULT LODocumentAddEntityUsingIndexes(
    LODocumentRef document, LOEntityRef entity, size_t layer_index, size_t page_index);

LO_RESULT LODocumentRemoveEntity(LODocumentRef document, LOEntityRef* entity);

LO_RESULT LODocumentGetNumberOfSharedEntities(LODocumentRef document, size_t* num_shared_entities);

LO_RESULT LODocumentGetSharedEntityAtIndex(
    LODocumentRef document, size_t index, LOEntityRef* entity);

LO_RESULT LODocumentGetSharedEntities(LODocumentRef document, LOEntityListRef entity_list);

LO_RESULT LODocumentGetObjectSnap(LODocumentRef document, bool* object_snap);

LO_RESULT LODocumentSetObjectSnap(LODocumentRef document, bool object_snap);

LO_RESULT LODocumentGetGridSnap(LODocumentRef document, bool* grid_snap);

LO_RESULT LODocumentSetGridSnap(LODocumentRef document, bool grid_snap);

LO_RESULT LODocumentGetTimeCreated(LODocumentRef document, time_t* time_created);

LO_RESULT LODocumentGetTimeModified(LODocumentRef document, time_t* time_modified);

LO_RESULT LODocumentGetTimePublished(LODocumentRef document, time_t* time_published);

LO_RESULT LODocumentGetUnits(LODocumentRef document, LODocumentUnits* units, double* precision);

LO_RESULT LODocumentSetUnits(LODocumentRef document, LODocumentUnits units, double precision);


LO_RESULT LODocumentGetNumberOfAutoTextDefinitions(LODocumentRef document, size_t* size);

LO_RESULT LODocumentGetAutoTextDefinitionAtIndex(
    LODocumentRef document, size_t index, LOAutoTextDefinitionRef* autotext);

LO_RESULT LODocumentGetAutoTextDefinitionByName(
    LODocumentRef document, const char* name, LOAutoTextDefinitionRef* autotext);

LO_RESULT LODocumentGetAutoTextDefinitions(
    LODocumentRef document, LOAutoTextDefinitionListRef autotexts);

LO_RESULT LODocumentAddAutoTextDefinition(
    LODocumentRef document, int type, const char* name, LOAutoTextDefinitionRef* autotext);

LO_RESULT LODocumentRemoveAutoTextDefinition(
    LODocumentRef document, LOAutoTextDefinitionRef* autotext, bool convert_tags_to_normal_text);

LO_RESULT LODocumentGetLengthFormatter(LODocumentRef document, SULengthFormatterRef* formatter);
#ifdef __cplusplus
}  // extern "C" {
#endif

#endif  // LAYOUT_MODEL_DOCUMENT_H_