Jump to content

wpSetIconTextColor

From EDM2

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

This instance method sets the color to be used for the icon text for the specified view.

Syntax

wpSetIconTextColor(somSelf, ulColor, ulView, fRefreshViews)

Parameters

somSelf (WPFolder *) - input
Pointer to the object on which the method is being invoked.
Points to an object of class WPFolder.
ulColor (ULONG) - input
The **RGB** color value or **USE_GLOBAL_COLOR**.
The RGB value must be 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).
ulView (ULONG) - input
Specifies which view to query.
  • **OPEN_CONTENTS** Open contents view.
  • **OPEN_DEFAULT** Open default view (same as double-click).
  • **OPEN_DETAILS** Open details view.
  • **OPEN_HELP** Display HelpPanel.
  • **OPEN_RUNNING** Execute object.
  • **OPEN_SETTINGS** Open Settings notebook.
  • **OPEN_TREE** Open tree view.
  • **OPEN_USER** Class-specific views have a greater value than this.
fRefreshViews (BOOL) - input
Refresh open views flag.
  • **TRUE** Refreshes all open views.
  • **FALSE** Does not refresh the open views.

Returns

rc (none) - returns
There is no return value for this method.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to set the text color for the titles displayed for normal icons in **Icon**, **Tree**, or **Details View** of a folder.

Remarks

This method is not covered in the provided text.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG ulColor; /* The RGB color value or USE_GLOBAL_COLOR. */
ULONG ulView; /* Specifies which view to query. */
BOOL fRefreshViews; /* Refresh open views flag. */

wpSetIconTextColor(somSelf, ulColor, ulView,
        fRefreshViews);

/* Example code provided in the source: */
    _wpSetIconTextColor(somSelf,RGB_BLACK);

Related Methods