WpQueryShadowTextColor: Difference between revisions

Latest revision as of 03:04, 25 November 2025

This method is specific to Version 4, or higher, of the OS/2 operating system.

This instance method returns the current color being used for the shadow text in the specified view.

Syntax

_wpQueryShadowTextColor(somSelf, ulView)

Parameters

somSelf (WPFolder *) - input: Pointer to the object on which the method is being invoked.; Points to an object of class WPFolder.

ulView (ULONG) - input

Specifies which view to query.

**OPEN_CONTENTS** Opens the Contents view.
**OPEN_DEFAULT** Opens the default view (same as double-clicking).
**OPEN_DETAILS** Opens the Details view.
**OPEN_HELP** Displays the Help panel.
**OPEN_RUNNING** Executes the object.
**OPEN_SETTINGS** Opens the Settings notebook.
**OPEN_TREE** Opens the Tree view.
**OPEN_USER** Class-specific views have a greater value than this.

Returns

rv (ULONG) - returns: The **RGB** color value of the current color being used for the shadow text.; The RGB value is presented as a 6-digit hex value in the format **0xRRGGBB** where RR, GG, and BB are the red, green, and blue values ranging between 0x00 and 0xFF (0-255).

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to determine the color used to display the title of a shadow icon in a view of the folder.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG ulView; /* Specifies which view to query. */
ULONG rv; /* The RGB color value of the current color being used for the icon text background. */

rv = _wpQueryShadowTextColor(somSelf, ulView);

/* Example code provided in the source: */
  ULONG ulTextColor;

  ulTextColor = _wpQueryShadowTextColor(somSelf,OPEN_CONTENTS);
  /* ulTextColor is an encoded RGB color value */

Related Methods