Toolbar Query Methods

The following table provides the methods for querying information about the state of the Toolbar:

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryActionButtons          │Returns a pointer of array of │
│                              │ACTION data structures. Each  │
│                              │ACTION structure has the      │
│                              │following elements:           │
│                              │                              │
│                              │o Pointer to the text to be   │
│                              │  displayed                   │
│                              │o Handle to the icon to be    │
│                              │  displayed                   │
│                              │o Menu item number that is    │
│                              │  passed to the Desktop via   │
│                              │  wpMenuItemSelected, when    │
│                              │  the action button is        │
│                              │  pressed.                    │
│                              │                              │
│                              │The number of ACTION          │
│                              │structures in the array is    │
│                              │returned using parameters.    │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryActionButtonStyle      │Returns the current setting   │
│                              │for the action button style:  │
│                              │                              │
│                              │o ACTION_BUTTONS_MINI         │
│                              │o ACTION_BUTTONS_NORMAL       │
│                              │o ACTION_BUTTONS_OFF          │
│                              │o ACTION_BUTTONS_TEXT.        │
│                              │                              │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryCloseDrawer            │Returns TRUE if the drawer is │
│                              │closed after one of its       │
│                              │objects is opened. Otherwise, │
│                              │it returns FALSE.             │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDisplaySmallIcons      │Returns TRUE if objects' icons│
│                              │are displayed using small or  │
│                              │mini-icons. Otherwise, it     │
│                              │returns FALSE.                │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDisplayText            │Returns TRUE if titles of     │
│                              │objects located on the Toolbar│
│                              │are displayed. Otherwise, it  │
│                              │returns FALSE.                │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDisplayTextInDrawers   │Returns TRUE if text is       │
│                              │displayed for objects that are│
│                              │located in drawers. Otherwise,│
│                              │it returns FALSE.             │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDisplayVertical        │Returns TRUE if the Toolbar is│
│                              │displayed vertically.         │
│                              │Otherwise,  it returns FALSE. │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryFloatOnTop             │Returns TRUE if the Toolbar is│
│                              │set to float on top of all    │
│                              │other windows. Otherwise, it  │
│                              │returns FALSE.                │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryHideLaunchPadFrameCtls │Returns TRUE if the frame     │
│                              │controls (title bar and system│
│                              │menu) are hidden. Otherwise,  │
│                              │it returns FALSE.             │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryObjectList             │Returns a pointer to an array │
│                              │of HOBJECT that represents the│
│                              │list of objects in the drawer.│
│                              │The number of objects is      │
│                              │returned using parameters.    │
└──────────────────────────────┴──────────────────────────────┘


[Back: Toolbar Set Methods]
[Next: Using Workplace Shell Objects]