Index

C/C++ Functions

txTextSetFilter

DT_SWORD txTextSetFilter(DT_TXDOC text_doc, DT_SWORD reserved, DT_ULONG filter)

Short Description: Set visibility filter

The txTextSetFilter function applies the visibility filter to any text output generated by D-Type Unicode Text Module. This filter disables the display of the shadow, body, outline and/or underline layers when D-Type Unicode Text Module renders text. By default, the visibility filter is off, meaning that all four layers (shadow, body, outline, underline) are visible when D-Type Unicode Text Module renders text.

This is a convenience function. It has the same effect as the following code:

DT_PDDOC power_doc; txTextGetPowerDoc(text_doc, &power_doc);
pdDocSetFilter(power_doc, reserved, filter);

Parameters

ParameterDescription

text_doc

Handle of the associated text document instance.

reserved

Reserved for future use. Must be set to 0.

filter

Visibility filter. This value is a combination of three independent bit values which indicate which of the four layers (shadow, body, outline, underline) will be suppressed when D-Type Unicode Text Module renders text.

  • Bit 0: If set (1), the shadow layer is not visible. If unset (0), the shadow layer is visible.
  • Bit 1: If set (1), the body layer is not visible. If unset (0), the body layer is visible.
  • Bit 2: If set (1), the outline layer is not visible. If unset (0), the outline layer is visible.
  • Bit 3: If set (1), the underline / strike-through layer is not visible. If unset (0), the underline / strike-through layer is visible.

Return Value

If successful, the return value is 1. Otherwise, the function returns 0.

Comments

The following table illustrates the effect of the visibility filter on text output.

Filter ValueResulting Output
(0) 0000 Filter=000
(1) 0001 Filter=001
(2) 0010 Filter=010
(3) 0011 Filter=011
(4) 0100 Filter=100
(5) 0101 Filter=101
(6) 0110 Filter=110
(7) 0111 Filter=111

Related Functions

txTextGetFilter

 

Index