label.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_LABEL_H_
#define LAYOUT_MODEL_LABEL_H_

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

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

typedef enum {
  LOLabelLeaderLineType_SingleSegment = 0, 
  LOLabelLeaderLineType_TwoSegment,        
  LOLabelLeaderLineType_Bezier,            
  LOLabelLeaderLineType_Unknown,           
  LONumLabelLeaderLineTypes
} LOLabelLeaderLineType;

typedef enum {
  LOLabelTextConnectionType_NoConnection = 0, 
  LOLabelTextConnectionType_Automatic,        
  LOLabelTextConnectionType_ReverseAutomatic, 
  LOLabelTextConnectionType_TopLeft,          
  LOLabelTextConnectionType_CenterLeft,       
  LOLabelTextConnectionType_BottomLeft,       
  LOLabelTextConnectionType_TopRight,         
  LOLabelTextConnectionType_CenterRight,      
  LOLabelTextConnectionType_BottomRight,      
  LONumLabelTextConnectionTypes
} LOLabelTextConnectionType;

LO_RESULT LOLabelCreateAtPoint(LOLabelRef* label,
                               const LOPoint2D* anchor_point,
                               LOFormattedTextAnchorType anchor_type,
                               const char* plain_text,
                               LOLabelLeaderLineType leader_line_type,
                               const LOPoint2D* target_point);

LO_RESULT LOLabelCreateWithBounds(LOLabelRef* label,
                                  const LOAxisAlignedRect2D* bounds,
                                  const char* plain_text,
                                  LOLabelLeaderLineType leader_line_type,
                                  const LOPoint2D* target_point);

LO_RESULT LOLabelAddReference(LOLabelRef label);

LO_RESULT LOLabelRelease(LOLabelRef* label);

LO_EXPORT LOLabelRef LOLabelFromEntity(LOEntityRef entity);

LO_EXPORT LOEntityRef LOLabelToEntity(LOLabelRef label);

LO_RESULT LOLabelGetExplodedEntities(LOLabelRef label,
                                     LOEntityListRef entity_list,
                                     LOPageRef page_for_autotext);

LO_RESULT LOLabelConnectTo(LOLabelRef label,
                           LOConnectionPointRef connection_point);

LO_RESULT LOLabelDisconnect(LOLabelRef label);

LO_RESULT LOLabelCreateLabelTextCopy(LOLabelRef label,
                                     LOFormattedTextRef* text);

LO_RESULT LOLabelCreateLabelDisplayTextCopy(LOLabelRef label,
                                            LOPageRef page,
                                            LOFormattedTextRef* text);

LO_RESULT LOLabelSetLabelText(LOLabelRef label,
                              LOFormattedTextRef text);

LO_RESULT LOLabelCreateLeaderLineCopy(LOLabelRef label, LOPathRef* path);

LO_RESULT LOLabelSetLeaderLine(LOLabelRef label, LOPathRef path);

LO_RESULT LOLabelGetLeaderLineType(LOLabelRef label,
                                   LOLabelLeaderLineType* leader_line_type);

LO_RESULT LOLabelSetLeaderLineType(LOLabelRef label,
                                   LOLabelLeaderLineType leader_line_type);

LO_RESULT LOLabelGetTextConnectionType(LOLabelRef label,
    LOLabelTextConnectionType* text_connection_type);

LO_RESULT LOLabelSetTextConnectionType(LOLabelRef label,
    LOLabelTextConnectionType text_connection_type);

#ifdef __cplusplus
}
#endif // __cplusplus

#endif //LAYOUT_MODEL_LABEL_H_