page.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_PAGE_H_
#define LAYOUT_MODEL_PAGE_H_

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

typedef enum {
  LOPageEntityIteratorFlags_None = 0x0,  
  LOPageEntityIteratorFlags_SkipHidden = 0x1,         
  LOPageEntityIteratorFlags_SkipLocked = 0x2,         
  LOPageEntityIteratorFlags_SkipHiddenOrLocked = 0x3  
} LOPageEntityIteratorFlags;

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

LO_RESULT LOPageGetName(LOPageRef page, SUStringRef* name);

LO_RESULT LOPageSetName(LOPageRef page, const char* name);

LO_RESULT LOPageGetInPresentation(LOPageRef page, bool* in_presentation);

LO_RESULT LOPageSetInPresentation(LOPageRef page, bool in_presentation);

LO_RESULT LOPageGetLayerVisible(LOPageRef page, LOLayerRef layer_definition, bool* visible);

LO_RESULT LOPageSetLayerVisible(LOPageRef page, LOLayerRef layer_definition, bool visible);

LO_RESULT LOPageGetLayerInstances(
    LOPageRef page, size_t array_size, LOLayerInstanceRef layer_instances[], size_t* number_copied);

LO_RESULT LOPageGetLayerInstanceAtIndex(
    LOPageRef page, size_t index, LOLayerInstanceRef* layer_instance);

LO_RESULT LOPageGetPageIndex(LOPageRef page, size_t* index);

LO_RESULT LOPageGetNumberOfNonSharedEntities(LOPageRef page, size_t* num_nonshared_entities);

LO_RESULT LOPageGetNonSharedEntityAtIndex(LOPageRef page, size_t index, LOEntityRef* entity);

LO_RESULT LOPageGetNonSharedEntities(LOPageRef page, LOEntityListRef entity_list);

LO_RESULT LOPageCreateEntityIterator(
    LOPageRef page, LOPageEntityIteratorFlags flags, LOEntityIteratorRef* entity_iterator);

LO_RESULT LOPageCreateReverseEntityIterator(
    LOPageRef page, LOPageEntityIteratorFlags flags, LOEntityIteratorRef* entity_iterator);

LO_RESULT LOPageGetDocument(LOPageRef page, LODocumentRef* document);

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

#endif  // LAYOUT_MODEL_PAGE_H_