autotextdefinition.h

Go to the documentation of this file.

// Copyright 2016 Trimble Navigation Ltd. All Rights Reserved.
// This file is intended for public distribution.

#ifndef LAYOUT_MODEL_AUTOTEXTDEFINITION_H_
#define LAYOUT_MODEL_AUTOTEXTDEFINITION_H_

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

typedef enum {
  LOAutoTextDefinitionType_File = 0,
  LOAutoTextDefinitionType_PageName,
  LOAutoTextDefinitionType_PageNumber,
  LOAutoTextDefinitionType_CustomText,
  LOAutoTextDefinitionType_DateCurrent,
  LOAutoTextDefinitionType_DateCreated,
  LOAutoTextDefinitionType_DateModified,
  LOAutoTextDefinitionType_DatePublished,

  // Mandatory types
  LOAutoTextDefinitionType_ModelGroupName,
  LOAutoTextDefinitionType_ModelComponentInstanceName,
  LOAutoTextDefinitionType_ModelComponentDefinitionName,
  LOAutoTextDefinitionType_ModelComponentDescription,
  LOAutoTextDefinitionType_ModelVolume,
  LOAutoTextDefinitionType_ModelFaceArea,
  LOAutoTextDefinitionType_ModelEdgeLength,
  LOAutoTextDefinitionType_ModelCoordinates,
  LOAutoTextDefinitionType_ModelDynamicComponentAttribute,
  LOAutoTextDefinitionType_ModelClassifierAttribute,
  LOAutoTextDefinitionType_ModelComponentInstanceAttribute,
  LOAutoTextDefinitionType_ModelComponentDefinitionAttribute,

  // Must be last to give us a count of the number of types.
  LOAutoTextDefinitionType_Count
} LOAutoTextDefinitionType;

typedef enum {
  LOAutoTextDefinitionNumberingStyle_Arabic = 0,
  LOAutoTextDefinitionNumberingStyle_ArabicPadded,
  LOAutoTextDefinitionNumberingStyle_UCAlpha,
  LOAutoTextDefinitionNumberingStyle_LCAlpha,
  LOAutoTextDefinitionNumberingStyle_UCRoman,
  LOAutoTextDefinitionNumberingStyle_LCRoman,

  // Must be last to give us a count of styles.
  LOAutoTextDefinitionNumberingStyle_Count
} LOAutoTextDefinitionNumberingStyle;

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus


LO_RESULT LOAutoTextDefinitionGetType(LOAutoTextDefinitionRef autotext,
                                      LOAutoTextDefinitionType* type);

LO_RESULT LOAutoTextDefinitionGetMandatory(LOAutoTextDefinitionRef autotext,
                                           bool* is_mandatory);

LO_RESULT LOAutoTextDefinitionGetDocument(LOAutoTextDefinitionRef autotext,
                                          LODocumentRef* document);

LO_RESULT LOAutoTextDefinitionGetName(LOAutoTextDefinitionRef autotext,
                                      SUStringRef* name);

LO_RESULT LOAutoTextDefinitionSetName(LOAutoTextDefinitionRef autotext,
                                      const char* name);

LO_RESULT LOAutoTextDefinitionGetTag(LOAutoTextDefinitionRef autotext,
                                     SUStringRef* tag);

LO_RESULT LOAutoTextDefinitionGetIndex(LOAutoTextDefinitionRef autotext,
                                       size_t* index);

LO_RESULT LOAutoTextDefinitionGetCustomText(LOAutoTextDefinitionRef autotext,
                                            SUStringRef* custom_text);

LO_RESULT LOAutoTextDefinitionSetCustomText(LOAutoTextDefinitionRef autotext,
                                            const char* custom_text);

LO_RESULT LOAutoTextDefinitionGetDateFormat(LOAutoTextDefinitionRef autotext,
                                            SUStringRef* date_format);

LO_RESULT LOAutoTextDefinitionSetDateFormat(LOAutoTextDefinitionRef autotext,
                                            const char* date_format);

LO_RESULT LOAutoTextDefinitionGetDisplayFullPath(
    LOAutoTextDefinitionRef autotext, bool* is_display_full_path);

LO_RESULT LOAutoTextDefinitionSetDisplayFullPath(
    LOAutoTextDefinitionRef autotext, bool is_display_full_path);

LO_RESULT LOAutoTextDefinitionGetDisplayFileExtension(
    LOAutoTextDefinitionRef autotext, bool* is_display_file_ext);

LO_RESULT LOAutoTextDefinitionSetDisplayFileExtension(
    LOAutoTextDefinitionRef autotext, bool is_display_file_ext);
LO_RESULT LOAutoTextDefinitionGetPageNumberStyle(
    LOAutoTextDefinitionRef autotext,
    LOAutoTextDefinitionNumberingStyle* numbering_style);

LO_RESULT LOAutoTextDefinitionSetPageNumberStyle(
    LOAutoTextDefinitionRef autotext,
    LOAutoTextDefinitionNumberingStyle numbering_style);

LO_RESULT LOAutoTextDefinitionGetPageNumberStartIndex(
    LOAutoTextDefinitionRef autotext, int* start_index);

LO_RESULT LOAutoTextDefinitionSetPageNumberStartIndex(
    LOAutoTextDefinitionRef autotext, int start_index);

LO_RESULT LOAutoTextDefinitionGetPageNumberStartPage(
    LOAutoTextDefinitionRef autotext, LOPageRef* page);

LO_RESULT LOAutoTextDefinitionSetPageNumberStartPage(
    LOAutoTextDefinitionRef autotext, LOPageRef page);

#ifdef __cplusplus
}  // end extern "C"
#endif // __cplusplus

#endif // LAYOUT_MODEL_AUTOTEXTDEFINITION_H_