formattedtext.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_FORMATTED_TEXT_H_
#define LAYOUT_MODEL_FORMATTED_TEXT_H_

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

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

typedef enum {
  LOFormattedTextGrowMode_Unbounded = 0, 
  LOFormattedTextGrowMode_Bounded,       
  LONumFormattedTextGrowModes
} LOFormattedTextGrowMode;

typedef enum {
  LOFormattedTextAnchorType_TopLeft,      
  LOFormattedTextAnchorType_CenterLeft,   
  LOFormattedTextAnchorType_BottomLeft,   
  LOFormattedTextAnchorType_TopRight,     
  LOFormattedTextAnchorType_CenterRight,  
  LOFormattedTextAnchorType_BottomRight,  
  LOFormattedTextAnchorType_TopCenter,    
  LOFormattedTextAnchorType_CenterCenter, 
  LOFormattedTextAnchorType_BottomCenter, 
  LONumFormattedTextAnchorTypes
} LOFormattedTextAnchorType;

LO_RESULT LOFormattedTextCreateAtPoint(LOFormattedTextRef* text,
                                       const LOPoint2D* anchor_point,
                                       LOFormattedTextAnchorType anchor_type,
                                       const char* plain_text);

LO_RESULT LOFormattedTextCreateWithBounds(LOFormattedTextRef* text,
                                          const LOAxisAlignedRect2D* bounds,
                                          const char* plain_text);

LO_RESULT LOFormattedTextCreateAtPointFromFile(LOFormattedTextRef* text,
    const LOPoint2D* anchor_point,
    LOFormattedTextAnchorType anchor_type,
    const char* path);

LO_RESULT LOFormattedTextCreateWithBoundsFromFile(
    LOFormattedTextRef* text,
    const char* path,
    const LOAxisAlignedRect2D* bounds);

LO_RESULT LOFormattedTextAddReference(LOFormattedTextRef text);

/*
@brief Releases a formatted text object. The object will be invalidated if
       releasing the last reference.
@param[in] text The formatted text object.
@return
- \ref SU_ERROR_NONE on success
- \ref SU_ERROR_NULL_POINTER_INPUT if text is NULL
- \ref SU_ERROR_INVALID_INPUT if *text does not refer to a valid object
*/
LO_RESULT LOFormattedTextRelease(LOFormattedTextRef* text);

LO_EXPORT LOFormattedTextRef LOFormattedTextFromEntity(LOEntityRef entity);

LO_EXPORT LOEntityRef LOFormattedTextToEntity(LOFormattedTextRef text);

LO_RESULT LOFormattedTextGetRTF(LOFormattedTextRef text,
                                SUStringRef* rtf_text,
                                LOPageRef page_for_autotext);

LO_RESULT LOFormattedTextSetRTF(LOFormattedTextRef text,
                                const char* rtf_text);

LO_RESULT LOFormattedTextGetDisplayText(LOFormattedTextRef text,
                                        SUStringRef* display_text,
                                        LOPageRef page_for_autotext);

LO_RESULT LOFormattedTextGetPlainTextLength(LOFormattedTextRef text,
                                            size_t* length);

LO_RESULT LOFormattedTextGetPlainText(LOFormattedTextRef text,
                                      SUStringRef* plain_text);

LO_RESULT LOFormattedTextSetPlainText(LOFormattedTextRef text,
                                      const char* plain_text);

LO_RESULT LOFormattedTextSetTextWithStyle(LOFormattedTextRef text,
                                          const char* plain_text,
                                          LOStyleRef style);

LO_RESULT LOFormattedTextAppendTextWithStyle(LOFormattedTextRef text,
                                             const char* plain_text,
                                             LOStyleRef style);

LO_RESULT LOFormattedTextGetStyleAtCharacter(LOFormattedTextRef text,
                                             size_t index,
                                             LOStyleRef style);

LO_RESULT LOFormattedTextGetStyleRunAtCharacter(LOFormattedTextRef text,
                                                size_t index,
                                                size_t length,
                                                LOStyleRef style);

LO_RESULT LOFormattedTextSetStyleForRange(LOFormattedTextRef text,
                                          LOStyleRef style,
                                          size_t range_begin,
                                          size_t range_length);

LO_RESULT LOFormattedTextGetGrowMode(LOFormattedTextRef text,
                                     LOFormattedTextGrowMode* mode);

LO_RESULT LOFormattedTextSetGrowMode(LOFormattedTextRef text,
                                     LOFormattedTextGrowMode mode);

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