wpQueryIconTextVisibility

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

This instance method returns the current state of icon text visibility for the specified view.

Syntax

_wpQueryIconTextVisibility(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

rc (ULONG) - returns

The current state of icon text visibility.

Byte 1 Has the following values:

- 0x00** Icon text is not visible.
- 0x01** Icon text is visible (**ICON_TEXT_VISIBLE**).

Byte 4 Has the following values:

- 0x00** Instance setting.
- 0x40** Global setting (**USE_GLOBAL_VISIBILITY**).

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to determine whether or not the titles are displayed 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 rc; /* The current state of icon text visibility. */

rc = _wpQueryIconTextVisibility(somSelf, ulView);

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

  ulTextVisibility = _wpQueryIconTextVisibility(somSelf,OPEN_CONTENTS);
  /* ulTextVisibility can contain the following flag values:
   * USE_GLOBAL_VISIBILITY = the folder is using the global system value
   * ICON_TEXT_VISIBLE     = titles are displayed in Icon View of the folder
   */

Related Methods

wpSetIconTextVisibility