WebConvertParams Class Documentation
classWebConvertParamsNamespace: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. Parameters that control web/HTML-to-PDF conversion. Configure the target page geometry, viewport, image handling, and behavior on this object, then pass it to a web-to-PDF conversion call. The enum-valued settings (viewport preset, page size, page orientation, image compression, and downsampling resolution) take named values rather than raw integers. Safe to construct and configure on any platform; conversion itself runs only where the WebToPDF plugin is supported.
Constructor & Destructor Documentation
WebConvertParams
WebConvertParams()WebConvertParams
WebConvertParams(const WebConvertParams &)Parameters
WebConvertParams
WebConvertParams(WebConvertParams &&)Parameters
~WebConvertParams
~WebConvertParams()Member Function Documentation
get_display_header_footer
boolget_display_header_footer()Returns:
boolShow default browser-style header/footer.
get_downsampling_dpi
WebDownsamplingDPIget_downsampling_dpi()Returns:
WebDownsamplingDPIget_enable_verbose_logging
boolget_enable_verbose_logging()Returns:
boolEmit debug-level log messages.
get_generate_tagged_pdf
boolget_generate_tagged_pdf()Returns:
boolProduce a tagged (accessible) PDF.
get_image_compression
WebImageCompressionget_image_compression()Returns:
WebImageCompressionget_margin_bottom_inches
doubleget_margin_bottom_inches()Returns:
doubleget_margin_left_inches
doubleget_margin_left_inches()Returns:
doubleget_margin_right_inches
doubleget_margin_right_inches()Returns:
doubleget_margin_top_inches
doubleget_margin_top_inches()Returns:
doubleget_page_height_points
doubleget_page_height_points()Returns:
doubleget_page_orientation
WebPageOrientationget_page_orientation()Returns:
WebPageOrientationget_page_size
WebPageSizeget_page_size()Returns:
WebPageSizeget_page_width_points
doubleget_page_width_points()Returns:
doubleUsed when size == Custom. 1 pt = 1/72 in.
get_print_background
boolget_print_background()Returns:
boolPrint CSS background colors and images.
get_scale
doubleget_scale()Returns:
doubleContent scale factor (1.0 = 100%).
get_timeout_seconds
intget_timeout_seconds()Returns:
intConversion timeout. Sentinels match the plugin: 0 = use the plugin default (300s), -1 = infinite, positive values = explicit seconds.
get_viewport_height_px
intget_viewport_height_px()Returns:
intget_viewport_preset
WebViewportPresetget_viewport_preset()Returns:
WebViewportPresetget_viewport_width_px
intget_viewport_width_px()Returns:
intUsed when preset == Custom.
operator=
WebConvertParams &operator=(const WebConvertParams &)Parameters
Returns:
WebConvertParams &operator=
WebConvertParams &operator=(WebConvertParams &&)Parameters
Returns:
WebConvertParams &set_display_header_footer
voidset_display_header_footer(boolvalue)Parameters
value: bool
Returns:
voidset_downsampling_dpi
voidset_downsampling_dpi(WebDownsamplingDPIdpi)Parameters
dpi: WebDownsamplingDPI
Returns:
voidset_enable_verbose_logging
voidset_enable_verbose_logging(boolvalue)Parameters
value: bool
Returns:
voidset_generate_tagged_pdf
voidset_generate_tagged_pdf(boolvalue)Parameters
value: bool
Returns:
voidset_image_compression
voidset_image_compression(WebImageCompressionc)Parameters
Returns:
voidset_log_callback
voidset_log_callback(LogCallbackcb)Parameters
cb: LogCallback
Returns:
voidset_margins_inches
voidset_margins_inches(doubletop, doubleright, doublebottom, doubleleft)Parameters
top: doubleright: doublebottom: doubleleft: double
Returns:
voidset_page_height_points
voidset_page_height_points(doubleh)Parameters
h: double
Returns:
voidset_page_orientation
voidset_page_orientation(WebPageOrientationo)Parameters
Returns:
voidset_page_size
voidset_page_size(WebPageSizesize)Parameters
size: WebPageSize
Returns:
voidset_page_width_points
voidset_page_width_points(doublew)Parameters
w: double
Returns:
voidset_prefer_css_page_size
voidset_prefer_css_page_size(boolvalue)Parameters
value: bool
Returns:
voidset_print_background
voidset_print_background(boolvalue)Parameters
value: bool
Returns:
voidset_progress_callback
voidset_progress_callback(ProgressCallbackcb)Parameters
cb: ProgressCallback
Returns:
voidset_scale
voidset_scale(doublevalue)Parameters
value: double
Returns:
voidset_timeout_seconds
voidset_timeout_seconds(intseconds)Parameters
seconds: int
Returns:
voidset_viewport_height_px
voidset_viewport_height_px(intpx)Parameters
px: int
Returns:
voidset_viewport_preset
voidset_viewport_preset(WebViewportPresetpreset)Parameters
preset: WebViewportPreset
Returns:
voidset_viewport_width_px
voidset_viewport_width_px(intpx)Parameters
px: int
Returns:
void