__WB_DIALOG_PROPLIST__ Struct Reference

Dialog Property List, container for WB_DIALOG_PROP. More...

#include <dialog_controls.h>

Data Fields
int	nProps
	current number of (contiguous) properties in 'aDlgProp'
int	nMaxProps
	maximum number of available WB_DIALOG_PROP structures in aDlgProp
WB_DIALOG_PROP	aDlgProp [1]
	Pre-allocated array of (contiguous) structures for property storage. More...

Detailed Description

Dialog Property List, container for WB_DIALOG_PROP.

Container structure for WB_DIALOG_PROP structures, pre-allocated to hold 'nMaxProps'. Can be re-allocated as necessary to increase the total number of properties so long as the pointer to this structure isn't being cached outside of the WBDialogControl

typedef struct __WB_DIALOG_PROPLIST__
{
  int nProps, nMaxProps;      // total number of active properties and maximum size of aDlgProp
  WB_DIALOG_PROP aDlgProp[1]; // Array of property definitions (contiguous, pre-allocated)
} WBDialogPropList;

See also

WB_DIALOG_PROP

Properties are maintained using the following X11 Work Bench Toolkit API functions:

• low-level functions: WBDialogControlSetDialogProp(), WBDialogControlDelDialogProp(), WBDialogControlGetDialogProp()
  
• mid-level functions: WBDialogControlSetProperty(), WBDialogControlSetProperty2(), WBDialogControlGetProperty(), WBDialogControlGetProperty2()
  
• high-level functions: WBDialogControlSetCaption(), WBDialogControlGetCaption(), WBDialogControlSetPixmap(), WBDialogControlGetPixmap() WBDialogControlSetIconPixmap(), WBDialogControlGetIconPixmap(), WBDialogControlSetText(), WBDialogControlGetText()
  
• simplified string property functions: DLGSetControlProperty(), DLGGetControlProperty()
  
• combined with dialog window: DLGSetControlCaption(), DLGGetControlCaption()
  

Definition at line 180 of file dialog_controls.h.

Field Documentation

aDlgProp

WB_DIALOG_PROP aDlgProp[1]

Pre-allocated array of (contiguous) structures for property storage.

This structure integrates the pre-allocated array of WB_DIALOG_PROP structures and provides access to them via the aDlgProp array. Whenever adding a new property causes the total number to exceed nMaxProps, the entire structure must be re-allocated to accomodate the new entries, with all existing members of the array copied to the re-allocated structure. This is handled properly by use of the X11 Work Bench Toolkit API functions for dialog control property management.

Definition at line 194 of file dialog_controls.h.

---

The documentation for this struct was generated from the following file:

• dialog_controls.h