Toolbar Set Methods

In addition to setup strings, methods shown in the following table provide the same functionality:

┌───────────────────────────┬─────────────────────┬────────────────────┐
│Method Name                │Value                │Description         │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetActionButtonStyle     │ACTION_BUTTONS_MINI  │Displays the actions│
│                           │                     │buttons as          │
│                           │                     │mini-icons.         │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │ACTION_BUTTONS_NORMAL│Displays the action │
│                           │                     │buttons as normal or│
│                           │                     │large icons.        │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │ACTION_BUTTONS_OFF   │Turns off the       │
│                           │                     │display of action   │
│                           │                     │buttons.            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │ACTION_BUTTONS_TEXT  │Displays the action │
│                           │                     │buttons as text.    │
│                           │                     │This is the default.│
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetCloseDrawer           │TRUE                 │Closes the Toolbar  │
│                           │                     │drawer after opening│
│                           │                     │an object.          │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Leaves the Toolbar  │
│                           │                     │drawer open after   │
│                           │                     │opening an object.  │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetDisplaySmallIcons     │TRUE                 │Displays objects    │
│                           │                     │using small icons.  │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Displays objects    │
│                           │                     │using large icons.  │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetDisplayText           │TRUE                 │Displays titles of  │
│                           │                     │objects located on  │
│                           │                     │the Toolbar. This   │
│                           │                     │has no effect on    │
│                           │                     │objects located in  │
│                           │                     │drawers.            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Hides titles of     │
│                           │                     │objects located on  │
│                           │                     │the Toolbar. This   │
│                           │                     │has no effect on    │
│                           │                     │objects located in  │
│                           │                     │drawers.            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetDisplayTextInDrawers  │TRUE                 │Displays titles of  │
│                           │                     │objects located in  │
│                           │                     │drawers. This has no│
│                           │                     │effect on objects   │
│                           │                     │located on the      │
│                           │                     │Toolbar.            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Hides titles of     │
│                           │                     │objects located in  │
│                           │                     │drawers. This has no│
│                           │                     │effect on objects   │
│                           │                     │located on the      │
│                           │                     │Toolbar.            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetDisplayVertical       │TRUE                 │Displays the Toolbar│
│                           │                     │vertically.         │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Displays the Toolbar│
│                           │                     │horizontally. This  │
│                           │                     │is the default.     │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetFloatOnTop            │TRUE                 │Keeps the Toolbar   │
│                           │                     │floating on top of  │
│                           │                     │all other windows.  │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Does not keep the   │
│                           │                     │Toolbar floating on │
│                           │                     │top of all other    │
│                           │                     │windows.            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetHideLaunchPadFrameCtls│TRUE                 │Hides the frame     │
│                           │                     │controls (title bar │
│                           │                     │and system menu).   │
│                           │                     │This is the default.│
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │FALSE                │Displays the frame  │
│                           │                     │controls (title bar │
│                           │                     │and system menu).   │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetObjectListFromHObjects│A drawer number.     │Adds the objects to │
│                           │                     │the numbered drawer │
│                           │                     │of the Toolbar.     │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │The number of objects│                    │
│                           │to be added.         │                    │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │An array of HOBJECTS.│                    │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │A position within the│0=Toolbar,          │
│                           │drawer.              │1=left-most drawer, │
│                           │                     │and so on. Use      │
│                           │                     │ADD_OBJECT_FIRST to │
│                           │                     │add the objects at  │
│                           │                     │the beginning of the│
│                           │                     │drawer. Use         │
│                           │                     │ADD_OBJECT_LAST to  │
│                           │                     │add the objects at  │
│                           │                     │the end of the      │
│                           │                     │drawer. Use a       │
│                           │                     │position number to  │
│                           │                     │state which objects │
│                           │                     │the new objects     │
│                           │                     │should be inserted  │
│                           │                     │after (0=first      │
│                           │                     │object).            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetObjectListFromObjects │A drawer number.     │Adds the objects to │
│                           │                     │the specified       │
│                           │                     │Toolbar drawer.     │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │The number of objects│                    │
│                           │to be added.         │                    │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │An array of          │                    │
│                           │WPObject*.           │                    │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │A position with the  │0=Toolbar,          │
│                           │drawer.              │1=left-most drawer, │
│                           │                     │and so on. Use      │
│                           │                     │ADD_OBJECT_FIRST to │
│                           │                     │add the objects at  │
│                           │                     │the beginning of the│
│                           │                     │drawer. Use         │
│                           │                     │ADD_OBJECT_LAST to  │
│                           │                     │add the objects at  │
│                           │                     │the end of the      │
│                           │                     │drawer. Use a       │
│                           │                     │position number to  │
│                           │                     │state which objects │
│                           │                     │the new objects     │
│                           │                     │should be inserted  │
│                           │                     │after (0=first      │
│                           │                     │object).            │
├───────────────────────────┼─────────────────────┼────────────────────┤
│wpSetObjectListFromStrings │A drawer number.     │Adds the objects to │
│                           │                     │the specified       │
│                           │                     │Toolbar drawer.     │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │A NULL delimited set │                    │
│                           │of object IDs or path│                    │
│                           │and file names       │                    │
│                           │terminated by a      │                    │
│                           │double NULL.         │                    │
├───────────────────────────┼─────────────────────┼────────────────────┤
│                           │A position with the  │0=Toolbar,          │
│                           │drawer.              │1=left-most drawer, │
│                           │                     │and so on. Use      │
│                           │                     │ADD_OBJECT_FIRST to │
│                           │                     │add the objects at  │
│                           │                     │the beginning of the│
│                           │                     │drawer. Use         │
│                           │                     │ADD_OBJECT_LAST to  │
│                           │                     │add the objects at  │
│                           │                     │the end of the      │
│                           │                     │drawer. Use a       │
│                           │                     │position number to  │
│                           │                     │state which objects │
│                           │                     │the new objects     │
│                           │                     │should be inserted  │
│                           │                     │after (0=first      │
│                           │                     │object).            │
└───────────────────────────┴─────────────────────┴────────────────────┘

The following example adds two objects to the first drawer in the Toolbar:

PSZ pszObjectList = "C:\\README.TXT\0<WP_MINDEX>\0";
_wpSetObjectListFromStrings(somSelf,
                            1,
                            pszObjectList,
                            ADD_OBJECT_LAST);

The following example causes the Toolbar to float on top:

_wpSetFloatOnTop(somSelf,TRUE);


[Back: Toolbar Setup Strings]
[Next: Toolbar Query Methods]