Vanilla.PDF  1.5.1
Cross-platform toolkit for creating and modifying PDF documents
List of all members
FileWriterObserverHandle Class Reference

Allows hooking on FileWriterHandle events. More...

Inheritance diagram for FileWriterObserverHandle:
IUnknownHandle
typedef error_type(* FileWriterObserver_OnInitializing_Function) (void *user_data, InputOutputStreamHandle *output_stream)
 The first operation of the FileWriter.
 
typedef error_type(* FileWriterObserver_OnFinalizing_Function) (void *user_data, InputOutputStreamHandle *output_stream)
 The last operation of the FileWriter.
 
typedef error_type(* FileWriterObserver_OnBeforeObjectWrite_Function) (void *user_data, ObjectHandle *object)
 Invoked before every single object is written to the destination file.
 
typedef error_type(* FileWriterObserver_OnAfterObjectWrite_Function) (void *user_data, ObjectHandle *object)
 Invoked after every single object is written to the destination file.
 
typedef error_type(* FileWriterObserver_OnBeforeObjectOffsetRecalculation_Function) (void *user_data, ObjectHandle *object)
 Invoked before new object offset is recalculated.
 
typedef error_type(* FileWriterObserver_OnAfterObjectOffsetRecalculation_Function) (void *user_data, ObjectHandle *object)
 Invoked after new object offset is recalculated.
 
typedef error_type(* FileWriterObserver_OnBeforeEntryOffsetRecalculation_Function) (void *user_data, XrefEntryHandle *entry)
 Invoked before xref entry offset is recalculated.
 
typedef error_type(* FileWriterObserver_OnAfterEntryOffsetRecalculation_Function) (void *user_data, XrefEntryHandle *entry)
 Invoked after xref entry offset is recalculated.
 
typedef error_type(* FileWriterObserver_OnBeforeOutputFlush_Function) (void *user_data, InputOutputStreamHandle *output_stream)
 Invoked before the destination stream is flushed.
 
typedef error_type(* FileWriterObserver_OnAfterOutputFlush_Function) (void *user_data, InputOutputStreamHandle *output_stream)
 Invoked after the destination stream is flushed.
 
error_type FileWriterObserver_CreateCustom (FileWriterObserver_OnInitializing_Function on_initializing, FileWriterObserver_OnFinalizing_Function on_finalizing, FileWriterObserver_OnBeforeObjectWrite_Function on_before_object_write, FileWriterObserver_OnAfterObjectWrite_Function on_after_object_write, FileWriterObserver_OnBeforeObjectOffsetRecalculation_Function on_before_object_offset_recalculation, FileWriterObserver_OnAfterObjectOffsetRecalculation_Function on_after_object_offset_recalculation, FileWriterObserver_OnBeforeEntryOffsetRecalculation_Function on_before_entry_offset_recalculation, FileWriterObserver_OnAfterEntryOffsetRecalculation_Function on_after_entry_offset_recalculation, FileWriterObserver_OnBeforeOutputFlush_Function on_before_output_flush, FileWriterObserver_OnAfterOutputFlush_Function on_after_output_flush, void *user_data, FileWriterObserverHandle **result)
 Create a new FileWriterObserverHandle instance with custom callbacks. More...
 
error_type FileWriterObserver_ToUnknown (FileWriterObserverHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type FileWriterObserver_FromUnknown (IUnknownHandle *handle, FileWriterObserverHandle **result)
 Convert IUnknownHandle to FileWriterObserverHandle.
 
error_type FileWriterObserver_Release (FileWriterObserverHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Allows hooking on FileWriterHandle events.

Examples:
write_custom.c.

Friends And Related Function Documentation

◆ FileWriterObserver_CreateCustom()

error_type FileWriterObserver_CreateCustom ( FileWriterObserver_OnInitializing_Function  on_initializing,
FileWriterObserver_OnFinalizing_Function  on_finalizing,
FileWriterObserver_OnBeforeObjectWrite_Function  on_before_object_write,
FileWriterObserver_OnAfterObjectWrite_Function  on_after_object_write,
FileWriterObserver_OnBeforeObjectOffsetRecalculation_Function  on_before_object_offset_recalculation,
FileWriterObserver_OnAfterObjectOffsetRecalculation_Function  on_after_object_offset_recalculation,
FileWriterObserver_OnBeforeEntryOffsetRecalculation_Function  on_before_entry_offset_recalculation,
FileWriterObserver_OnAfterEntryOffsetRecalculation_Function  on_after_entry_offset_recalculation,
FileWriterObserver_OnBeforeOutputFlush_Function  on_before_output_flush,
FileWriterObserver_OnAfterOutputFlush_Function  on_after_output_flush,
void *  user_data,
FileWriterObserverHandle **  result 
)
related

Create a new FileWriterObserverHandle instance with custom callbacks.

Callbacks can be set to NULL, if there is no action associated with them

Examples:
write_custom.c.

◆ FileWriterObserver_Release()

error_type FileWriterObserver_Release ( FileWriterObserverHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release
Examples:
write_custom.c.

The documentation for this class was generated from the following file: