1.6.0/doc/c__content__operation_8h_source.html

#ifndef _C_CONTENT_OPERATION_H

#define _C_CONTENT_OPERATION_H


#include "vanillapdf/c_export.h"

#include "vanillapdf/c_handles.h"

#include "vanillapdf/c_values.h"


#ifdef __cplusplus

extern "C"

{

#endif


    typedef enum {

        ContentOperationType_Undefined = 0,

        ContentOperationType_Generic,

        ContentOperationType_LineWidth,

        ContentOperationType_LineCap,

        ContentOperationType_LineJoin,

        ContentOperationType_MiterLimit,

        ContentOperationType_DashPattern,

        ContentOperationType_ColorRenderingIntent,

        ContentOperationType_Flatness,

        ContentOperationType_GraphicsState,

        ContentOperationType_SaveGraphicsState,

        ContentOperationType_RestoreGraphicsState,

        ContentOperationType_TransformationMatrix,

        ContentOperationType_BeginSubpath,

        ContentOperationType_Line,

        ContentOperationType_FullCurve,

        ContentOperationType_FinalCurve,

        ContentOperationType_InitialCurve,

        ContentOperationType_CloseSubpath,

        ContentOperationType_Rectangle,

        ContentOperationType_Stroke,

        ContentOperationType_CloseAndStroke,

        ContentOperationType_FillPathNonzero,

        ContentOperationType_FillPathCompatibility,

        ContentOperationType_FillPathEvenOdd,

        ContentOperationType_FillStrokeNonzero,

        ContentOperationType_FillStrokeEvenOdd,

        ContentOperationType_CloseFillStrokeNonzero,

        ContentOperationType_CloseFillStrokeEvenOdd,

        ContentOperationType_EndPath,

        ContentOperationType_ClipPathNonzero,

        ContentOperationType_ClipPathEvenOdd,

        ContentOperationType_BeginText,

        ContentOperationType_EndText,

        ContentOperationType_CharacterSpacing,

        ContentOperationType_WordSpacing,

        ContentOperationType_HorizontalScaling,

        ContentOperationType_Leading,


        ContentOperationType_TextFont,

        ContentOperationType_TextRenderingMode,

        ContentOperationType_TextRise,

        ContentOperationType_TextTranslate,

        ContentOperationType_TextTranslateLeading,

        ContentOperationType_TextMatrix,

        ContentOperationType_TextNextLine,


        ContentOperationType_TextShow,


        ContentOperationType_TextShowArray,

        ContentOperationType_TextNextLineShow,

        ContentOperationType_TextNextLineShowSpacing,

        ContentOperationType_SetCharWidth,

        ContentOperationType_SetCacheDevice,

        ContentOperationType_ColorSpaceStroke,

        ContentOperationType_ColorSpaceNonstroke,

        ContentOperationType_SetColorStroke,

        ContentOperationType_SetColorStrokeExtended,

        ContentOperationType_SetColorNonstroke,

        ContentOperationType_SetColorNonstrokeExtended,

        ContentOperationType_SetStrokingColorSpaceGray,

        ContentOperationType_SetNonstrokingColorSpaceGray,

        ContentOperationType_SetStrokingColorSpaceRGB,

        ContentOperationType_SetNonstrokingColorSpaceRGB,

        ContentOperationType_SetStrokingColorSpaceCMYK,

        ContentOperationType_SetNonstrokingColorSpaceCMYK,

        ContentOperationType_ShadingPaint,

        ContentOperationType_BeginInlineImageObject,

        ContentOperationType_BeginInlineImageData,

        ContentOperationType_EndInlineImageObject,

        ContentOperationType_InvokeXObject,

        ContentOperationType_DefineMarkedContentPoint,

        ContentOperationType_DefineMarkedContentPointWithPropertyList,

        ContentOperationType_BeginMarkedContentSequence,

        ContentOperationType_BeginMarkedContentSequenceWithPropertyList,

        ContentOperationType_EndMarkedContentSequence,

        ContentOperationType_BeginCompatibilitySection,

        ContentOperationType_EndCompatibilitySection

    } ContentOperationType;


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperation_GetOperationType(ContentOperationHandle* handle, ContentOperationType* result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperation_ToBeginText(ContentOperationHandle* handle, ContentOperationBeginTextHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperation_ToEndText(ContentOperationHandle* handle, ContentOperationEndTextHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperation_ToInstruction(ContentOperationHandle* handle, ContentInstructionHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperation_FromInstruction(ContentInstructionHandle* handle, ContentOperationHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperation_Release(ContentOperationHandle* handle);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationGeneric_GetOperator(ContentOperationGenericHandle* handle, ContentOperatorHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationGeneric_GetOperandsSize(ContentOperationGenericHandle* handle, size_type* result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationGeneric_GetOperandAt(ContentOperationGenericHandle* handle, size_type at, ObjectHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationGeneric_ToContentOperation(ContentOperationGenericHandle* handle, ContentOperationHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationGeneric_FromContentOperation(ContentOperationHandle* handle, ContentOperationGenericHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationGeneric_Release(ContentOperationGenericHandle* handle);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShow_GetValue(ContentOperationTextShowHandle* handle, StringObjectHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShow_SetValue(ContentOperationTextShowHandle* handle, StringObjectHandle* data);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShow_ToContentOperation(ContentOperationTextShowHandle* handle, ContentOperationHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShow_FromContentOperation(ContentOperationHandle* handle, ContentOperationTextShowHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShow_Release(ContentOperationTextShowHandle* handle);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShowArray_GetValue(ContentOperationTextShowArrayHandle* handle, ArrayObjectHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShowArray_SetValue(ContentOperationTextShowArrayHandle* handle, ArrayObjectHandle* data);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShowArray_ToContentOperation(ContentOperationTextShowArrayHandle* handle, ContentOperationHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShowArray_FromContentOperation(ContentOperationHandle* handle, ContentOperationTextShowArrayHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextShowArray_Release(ContentOperationTextShowArrayHandle* handle);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_GetName(ContentOperationTextFontHandle* handle, NameObjectHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_SetName(ContentOperationTextFontHandle* handle, NameObjectHandle* data);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_GetScale(ContentOperationTextFontHandle* handle, IntegerObjectHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_SetScale(ContentOperationTextFontHandle* handle, IntegerObjectHandle* data);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_ToContentOperation(ContentOperationTextFontHandle* handle, ContentOperationHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_FromContentOperation(ContentOperationHandle* handle, ContentOperationTextFontHandle** result);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationTextFont_Release(ContentOperationTextFontHandle* handle);


    VANILLAPDF_API error_type CALLING_CONVENTION ContentOperationEndText_Release(ContentOperationEndTextHandle* handle);


#ifdef __cplusplus

};

#endif


#endif /* _C_CONTENT_OPERATION_H */

c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.

c_handles.h
This file contains all type forward declarations returned by the library API.

c_values.h
This file contains types and constants used as parameters or return values.

ArrayObjectHandle
An array object is a one-dimensional collection of objects arranged sequentially.

ContentInstructionHandle
Base class for all content objects and operations.

ContentOperationBeginTextHandle
Starts a new ContentObjectTextHandle section.

ContentOperationEndTextHandle
Terminates the ContentObjectTextHandle started with ContentOperationBeginTextHandle.

ContentOperationEndTextHandle::ContentOperationEndText_Release
error_type CALLING_CONVENTION ContentOperationEndText_Release(ContentOperationEndTextHandle *handle)
Decrement the internal reference counter.

ContentOperationGenericHandle
Unresolved operation often containing unknown operator.

ContentOperationGenericHandle::ContentOperationGeneric_GetOperator
error_type CALLING_CONVENTION ContentOperationGeneric_GetOperator(ContentOperationGenericHandle *handle, ContentOperatorHandle **result)
Get operator from unknown operation.

ContentOperationGenericHandle::ContentOperationGeneric_ToContentOperation
error_type CALLING_CONVENTION ContentOperationGeneric_ToContentOperation(ContentOperationGenericHandle *handle, ContentOperationHandle **result)
Reinterpret current object as ContentOperationHandle.

ContentOperationGenericHandle::ContentOperationGeneric_GetOperandAt
error_type CALLING_CONVENTION ContentOperationGeneric_GetOperandAt(ContentOperationGenericHandle *handle, size_type at, ObjectHandle **result)
Get operand at location at.

ContentOperationGenericHandle::ContentOperationGeneric_GetOperandsSize
error_type CALLING_CONVENTION ContentOperationGeneric_GetOperandsSize(ContentOperationGenericHandle *handle, size_type *result)
Get number of operands belonging to the operator.

ContentOperationGenericHandle::ContentOperationGeneric_Release
error_type CALLING_CONVENTION ContentOperationGeneric_Release(ContentOperationGenericHandle *handle)
Decrement the internal reference counter.

ContentOperationGenericHandle::ContentOperationGeneric_FromContentOperation
error_type CALLING_CONVENTION ContentOperationGeneric_FromContentOperation(ContentOperationHandle *handle, ContentOperationGenericHandle **result)
Convert ContentOperationHandle to ContentOperationGenericHandle.

ContentOperationHandle
Atomic operation modifying graphics state parameters.

ContentOperationHandle::ContentOperation_ToEndText
error_type CALLING_CONVENTION ContentOperation_ToEndText(ContentOperationHandle *handle, ContentOperationEndTextHandle **result)
Reinterpret current object as ContentOperationEndTextHandle.

ContentOperationHandle::ContentOperation_FromInstruction
error_type CALLING_CONVENTION ContentOperation_FromInstruction(ContentInstructionHandle *handle, ContentOperationHandle **result)
Convert ContentInstructionHandle to ContentOperationHandle.

ContentOperationHandle::ContentOperation_GetOperationType
error_type CALLING_CONVENTION ContentOperation_GetOperationType(ContentOperationHandle *handle, ContentOperationType *result)
Get derived type of current object.

ContentOperationHandle::ContentOperation_ToBeginText
error_type CALLING_CONVENTION ContentOperation_ToBeginText(ContentOperationHandle *handle, ContentOperationBeginTextHandle **result)
Reinterpret current object as ContentOperationBeginTextHandle.

ContentOperationHandle::ContentOperation_Release
error_type CALLING_CONVENTION ContentOperation_Release(ContentOperationHandle *handle)
Decrement the internal reference counter.

ContentOperationHandle::ContentOperation_ToInstruction
error_type CALLING_CONVENTION ContentOperation_ToInstruction(ContentOperationHandle *handle, ContentInstructionHandle **result)
Reinterpret current object as ContentInstructionHandle.

ContentOperationTextFontHandle
Set the text font and the text font size.

ContentOperationTextFontHandle::ContentOperationTextFont_SetName
error_type CALLING_CONVENTION ContentOperationTextFont_SetName(ContentOperationTextFontHandle *handle, NameObjectHandle *data)
Set new font name.

ContentOperationTextFontHandle::ContentOperationTextFont_Release
error_type CALLING_CONVENTION ContentOperationTextFont_Release(ContentOperationTextFontHandle *handle)
Decrement the internal reference counter.

ContentOperationTextFontHandle::ContentOperationTextFont_SetScale
error_type CALLING_CONVENTION ContentOperationTextFont_SetScale(ContentOperationTextFontHandle *handle, IntegerObjectHandle *data)
Set new font scaling.

ContentOperationTextFontHandle::ContentOperationTextFont_GetScale
error_type CALLING_CONVENTION ContentOperationTextFont_GetScale(ContentOperationTextFontHandle *handle, IntegerObjectHandle **result)
Get current font scaling.

ContentOperationTextFontHandle::ContentOperationTextFont_FromContentOperation
error_type CALLING_CONVENTION ContentOperationTextFont_FromContentOperation(ContentOperationHandle *handle, ContentOperationTextFontHandle **result)
Convert ContentOperationHandle to ContentOperationTextFontHandle.

ContentOperationTextFontHandle::ContentOperationTextFont_GetName
error_type CALLING_CONVENTION ContentOperationTextFont_GetName(ContentOperationTextFontHandle *handle, NameObjectHandle **result)
Get name of the font to be set.

ContentOperationTextFontHandle::ContentOperationTextFont_ToContentOperation
error_type CALLING_CONVENTION ContentOperationTextFont_ToContentOperation(ContentOperationTextFontHandle *handle, ContentOperationHandle **result)
Reinterpret current object as ContentOperationHandle.

ContentOperationTextShowArrayHandle
Show one or more text strings, allowing individual glyph positioning.

ContentOperationTextShowArrayHandle::ContentOperationTextShowArray_SetValue
error_type CALLING_CONVENTION ContentOperationTextShowArray_SetValue(ContentOperationTextShowArrayHandle *handle, ArrayObjectHandle *data)
Set new text strings to be shown.

ContentOperationTextShowArrayHandle::ContentOperationTextShowArray_GetValue
error_type CALLING_CONVENTION ContentOperationTextShowArray_GetValue(ContentOperationTextShowArrayHandle *handle, ArrayObjectHandle **result)
One or more text strings to be shown.

ContentOperationTextShowArrayHandle::ContentOperationTextShowArray_ToContentOperation
error_type CALLING_CONVENTION ContentOperationTextShowArray_ToContentOperation(ContentOperationTextShowArrayHandle *handle, ContentOperationHandle **result)
Reinterpret current object as ContentOperationHandle.

ContentOperationTextShowArrayHandle::ContentOperationTextShowArray_Release
error_type CALLING_CONVENTION ContentOperationTextShowArray_Release(ContentOperationTextShowArrayHandle *handle)
Decrement the internal reference counter.

ContentOperationTextShowArrayHandle::ContentOperationTextShowArray_FromContentOperation
error_type CALLING_CONVENTION ContentOperationTextShowArray_FromContentOperation(ContentOperationHandle *handle, ContentOperationTextShowArrayHandle **result)
Convert ContentOperationHandle to ContentOperationTextShowArrayHandle.

ContentOperationTextShowHandle
Stream operation for showing a simple text string.

ContentOperationTextShowHandle::ContentOperationTextShow_FromContentOperation
error_type CALLING_CONVENTION ContentOperationTextShow_FromContentOperation(ContentOperationHandle *handle, ContentOperationTextShowHandle **result)
Convert ContentOperationHandle to ContentOperationTextShowHandle.

ContentOperationTextShowHandle::ContentOperationTextShow_SetValue
error_type CALLING_CONVENTION ContentOperationTextShow_SetValue(ContentOperationTextShowHandle *handle, StringObjectHandle *data)
Set a new text string to be shown.

ContentOperationTextShowHandle::ContentOperationTextShow_ToContentOperation
error_type CALLING_CONVENTION ContentOperationTextShow_ToContentOperation(ContentOperationTextShowHandle *handle, ContentOperationHandle **result)
Reinterpret current object as ContentOperationHandle.

ContentOperationTextShowHandle::ContentOperationTextShow_Release
error_type CALLING_CONVENTION ContentOperationTextShow_Release(ContentOperationTextShowHandle *handle)
Decrement the internal reference counter.

ContentOperationTextShowHandle::ContentOperationTextShow_GetValue
error_type CALLING_CONVENTION ContentOperationTextShow_GetValue(ContentOperationTextShowHandle *handle, StringObjectHandle **result)
A text string to be shown.

ContentOperatorHandle
An operator is a PDF keyword specifying some action that shall be performed, such as painting a graph...

IntegerObjectHandle
Integer objects represent mathematical integers.

NameObjectHandle
A name object is an atomic symbol uniquely defined by a sequence of characters.

ObjectHandle
Base class for syntactic tokens.

StringObjectHandle
Reprsents human readable text.

ContentOperationType
ContentOperationType
Derived types of ContentOperationHandle.
Definition: c_content_operation.h:72

ContentOperationType_TextFont
@ ContentOperationType_TextFont
Set the text font and the text font size.
Definition: c_content_operation.h:120

ContentOperationType_TextShow
@ ContentOperationType_TextShow
Stream operation for showing a simple text string.
Definition: c_content_operation.h:132

ContentOperationType_TextShowArray
@ ContentOperationType_TextShowArray
Show one or more text strings, allowing individual glyph positioning.
Definition: c_content_operation.h:138

ContentOperationType_Generic
@ ContentOperationType_Generic
Unresolved operation often containing unknown operator.
Definition: c_content_operation.h:78

error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25

size_type
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62