WebConvertParams Class Documentation

class WebConvertParams

Namespace:datalogics_interface

Detailed Description

Parameters controlling Document::from_web_url and Document::from_html_file. Plain value type. Safe to construct and pass by reference. On supported platforms, owns a WebToPDFParamsRec and bridges it to a pair of CWebProgressProc/CWebLogProc functors that the static C trampolines installed into the params dispatch through.

On platforms where the WebToPDF plugin is not supported, the same class compiles with a stub state that mirrors the public set/get surface using primitive fields. The stub never throws from the constructor or any setter failures only surface from the Document::from_web_url / from_html_file entry points (in CDocument.cpp). This keeps configuration code platform-portable.

Public signatures use plain int where the underlying plugin enum would otherwise leak through; numeric values match the plugin enums and the public api WebViewportPreset / WebPageSize / ... 1:1, so callers cast freely at either boundary.

Constructor & Destructor Documentation

WebConvertParams

WebConvertParams()

~WebConvertParams

~WebConvertParams()

Member Function Documentation

get_enable_verbose_logging

bool get_enable_verbose_logging()

Returns:

bool

Emit debug-level log messages.

get_generate_tagged_pdf

bool get_generate_tagged_pdf()

Returns:

bool

Produce a tagged (accessible) PDF.

get_margin_bottom_inches

double get_margin_bottom_inches()

Returns:

double

get_margin_left_inches

double get_margin_left_inches()

Returns:

double

get_margin_right_inches

double get_margin_right_inches()

Returns:

double

get_margin_top_inches

double get_margin_top_inches()

Returns:

double

get_page_height_points

double get_page_height_points()

Returns:

double

get_page_width_points

double get_page_width_points()

Returns:

double

Used when size == Custom. 1 pt = 1/72 in.

get_print_background

bool get_print_background()

Returns:

bool

Print CSS background colors and images.

get_scale

double get_scale()

Returns:

double

Content scale factor (1.0 = 100%).

get_timeout_seconds

int get_timeout_seconds()

Returns:

int

Conversion timeout. Sentinels match the plugin: 0 = use the plugin default (300s), -1 = infinite, positive values = explicit seconds.

get_viewport_height_px

int get_viewport_height_px()

Returns:

int

get_viewport_width_px

int get_viewport_width_px()

Returns:

int

Used when preset == Custom.

set_enable_verbose_logging

void set_enable_verbose_logging(bool value)

Parameters

value: bool

Returns:

void

set_generate_tagged_pdf

void set_generate_tagged_pdf(bool value)

Parameters

value: bool

Returns:

void

set_log_callback

void set_log_callback(LogCallback cb)

Parameters

cb: LogCallback

Returns:

void

set_margins_inches

void set_margins_inches(double top, double right, double bottom, double left)

Parameters

top: double
right: double
bottom: double
left: double

Returns:

void

set_page_height_points

void set_page_height_points(double h)

Parameters

h: double

Returns:

void

set_page_width_points

void set_page_width_points(double w)

Parameters

w: double

Returns:

void

set_prefer_css_page_size

void set_prefer_css_page_size(bool value)

Parameters

value: bool

Returns:

void

set_print_background

void set_print_background(bool value)

Parameters

value: bool

Returns:

void

set_progress_callback

void set_progress_callback(ProgressCallback cb)

Parameters

cb: ProgressCallback

Returns:

void

set_scale

void set_scale(double value)

Parameters

value: double

Returns:

void

set_timeout_seconds

void set_timeout_seconds(int seconds)

Parameters

seconds: int

Returns:

void

set_viewport_height_px

void set_viewport_height_px(int px)

Parameters

px: int

Returns:

void

set_viewport_width_px

void set_viewport_width_px(int px)

Parameters

px: int

Returns:

void