Functions | |
StatusInt | mdlDialog_comboBoxGetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, int *maxSizeP, WChar *formatToDisplayP, WChar *formatToInternalP, WChar *minimumP, WChar *maximumP, UInt32 *maskP, UShort *nRowsP, UShort *gapWidthP, UShort *listWidthP, UInt32 *attributesP, RawItemHdr *comboBP) |
Retrieves attributes of a ComboBox item. More... | |
StatusInt | mdlDialog_comboBoxSetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, int *maxSizeP, WCharCP formatToDisplayP, WCharCP formatToInternalP, WCharCP minimumP, WCharCP maximumP, UInt32 *maskP, UShort *nRowsP, UShort *gapWidthP, UShort *listWidthP, UInt32 *attributesP, bool redraw, RawItemHdr *comboBP) |
Sets attributes of a ComboBox item. More... | |
StringListP | mdlDialog_comboBoxGetStrListP (RawItemHdr *comboBP) |
Retrieves a pointer to the StringList used by the ComboBox. More... | |
RawItemHdr * | mdlDialog_comboBoxGetTextP (RawItemHdr *comboBP) |
Returns a RawItemHdr pointer of the Text item attached to the ComboBox item. More... | |
RawItemHdr * | mdlDialog_comboBoxGetListBoxP (RawItemHdr *comboBP) |
Returns a RawItemHdr pointer of the ListBox attached to the ComboBox item. More... | |
RawItemHdr * | mdlDialog_comboBoxGetTreeP (RawItemHdr *comboBP) |
Returns a RawItemHdr pointer of the Tree attached to the ComboBox item. More... | |
ErrorCode | mdlDialog_comboBoxSetStrListP (RawItemHdr *comboBP, StringListP strListP, int nColumns) |
Sets the StringList used by a ComboBox item. More... | |
StatusInt | mdlDialog_comboBoxSetPopupState (RawItemHdr *comboBP, bool bOpen) |
Opens or closes the popup ListBox. More... | |
StatusInt | mdlDialog_comboBoxGetAdditionalInfo (UShort *valueColIndexP, long *stringListIdP, RawItemHdr *comboBP) |
Gets information about a ComboBox dialog item in addition to what is returned by the mdlDialog_comboBoxGetInfo function. More... | |
StatusInt | mdlDialog_comboBoxSetAdditionalInfo (UShort *valueColIndexP, long *stringListIdP, RawItemHdr *comboBP) |
Sets information about a ComboBox dialog item that cannot be set with the mdlDialog_comboBoxSetInfo function. More... | |
ListModel * | mdlDialog_comboBoxGetListModelP (RawItemHdr *comboBP) |
Retrieves a pointer to the ListModel used by the ComboBox. More... | |
ErrorCode | mdlDialog_comboBoxSetListModelP (RawItemHdr *comboBP, ListModel *pListModel) |
Sets the ListModel pointer used by the the ComboBox. More... | |
GuiTreeModelP | mdlDialog_comboBoxGetTreeModelP (RawItemHdr *comboBP) |
Retrieves a pointer to the GuiTreeModel used by the ComboBox. More... | |
ErrorCode | mdlDialog_comboBoxSetTreeModelP (RawItemHdr *comboBP, GuiTreeModelP pTreeModel) |
Sets the GuiTreeModel pointer used by the the ComboBox. More... | |
StatusInt | mdlDialog_comboBoxGetIndex (long *indexP, RawItemHdr *comboBP) |
Gets the index of the specified ComboBox dialog item. More... | |
StatusInt | mdlDialog_comboBoxSetIndex (long index, RawItemHdr *comboBP) |
Sets the index of the specified comboBox dialog item. More... | |
StatusInt | mdlDialog_comboBoxSetSubEditor (RawItemHdr *comboBP, bool bSubEditor, RawItemHdr *ownerRiP) |
Notifies the ComboBox item of its SubEditor status. More... | |
StatusInt mdlDialog_comboBoxGetAdditionalInfo | ( | UShort * | valueColIndexP, |
long * | stringListIdP, | ||
RawItemHdr * | comboBP | ||
) |
Gets information about a ComboBox dialog item in addition to what is returned by the mdlDialog_comboBoxGetInfo function.
[out] | valueColIndexP | is the index of the value column. Pass NULL in this argument if you do not want this value returned by the function. |
[out] | stringListIdP | is the StringList of values for the ComboBox. Pass NULL in this argument if you do not want this value returned by the function. |
[in] | comboBP | ComboBox to get additional info for |
StatusInt mdlDialog_comboBoxGetIndex | ( | long * | indexP, |
RawItemHdr * | comboBP | ||
) |
Gets the index of the specified ComboBox dialog item.
[out] | indexP | specifies the index of the comboBox item. |
[in] | comboBP | points to the comboBox dialog item to get the index from. |
StatusInt mdlDialog_comboBoxGetInfo | ( | CommandNumber * | commandNumberP, |
UInt32 * | commandSourceP, | ||
int * | maxSizeP, | ||
WChar * | formatToDisplayP, | ||
WChar * | formatToInternalP, | ||
WChar * | minimumP, | ||
WChar * | maximumP, | ||
UInt32 * | maskP, | ||
UShort * | nRowsP, | ||
UShort * | gapWidthP, | ||
UShort * | listWidthP, | ||
UInt32 * | attributesP, | ||
RawItemHdr * | comboBP | ||
) |
Retrieves attributes of a ComboBox item.
For all of the pointer parameters, NULL indicates that the field is not desired.
[out] | commandNumberP | set NULL if don't want cmd number |
[out] | commandSourceP | set NULL if don't want cmd source |
[out] | maxSizeP | points to a variable that indicates the maximum allowable size of the text string that can be contained by the ComboBox item, the maximum is 32K characters. |
[out] | formatToDisplayP | points to a sprintf format string to convert the value of the variable associated with the ComboBox item into a displayable string. |
[out] | formatToInternalP | points to a sscanf format string to convert from the ComboBox item's string value to the format expected by the variable associated with the ComboBox item. |
[out] | minimumP | points to a string that contains the minimum value of the ComboBox item. |
[out] | maximumP | points to a string that contains the maximum value of the ComboBox item. |
[out] | maskP | points to a UInt32 that contains the value mask |
[out] | nRowsP | points to an int that contains the number of rows displayed when the proper ListBox appears. |
[out] | gapWidthP | points to an int that contains the width, in dialog coordinate units (dcoords), between the selection field and the popup list activation button. |
[out] | listWidthP | points to an int that contains the width, in dialog coordinate units (dcoords), of the popup ListBox. |
[out] | attributesP | points to an int that contains the ComboBox item's attributes. The bits that can be included are defined in dlogbox.r.h. |
[in] | comboBP | ComboBox item to get info on |
RawItemHdr* mdlDialog_comboBoxGetListBoxP | ( | RawItemHdr * | comboBP | ) |
Returns a RawItemHdr pointer of the ListBox attached to the ComboBox item.
[in] | comboBP | ComboBox to get ListBox RawItemHdr from |
ListModel* mdlDialog_comboBoxGetListModelP | ( | RawItemHdr * | comboBP | ) |
Retrieves a pointer to the ListModel used by the ComboBox.
[in] | comboBP | ComboBox item to get list model from |
StringListP mdlDialog_comboBoxGetStrListP | ( | RawItemHdr * | comboBP | ) |
Retrieves a pointer to the StringList used by the ComboBox.
[in] | comboBP | ComboBox to get strListP of. |
RawItemHdr* mdlDialog_comboBoxGetTextP | ( | RawItemHdr * | comboBP | ) |
Returns a RawItemHdr pointer of the Text item attached to the ComboBox item.
[in] | comboBP | ComboBox to get Text item RawItemHdr from |
GuiTreeModelP mdlDialog_comboBoxGetTreeModelP | ( | RawItemHdr * | comboBP | ) |
Retrieves a pointer to the GuiTreeModel used by the ComboBox.
[in] | comboBP | ComboBox item to get Tree model from |
RawItemHdr* mdlDialog_comboBoxGetTreeP | ( | RawItemHdr * | comboBP | ) |
Returns a RawItemHdr pointer of the Tree attached to the ComboBox item.
[in] | comboBP | ComboBox to get Tree RawItemHdr from |
StatusInt mdlDialog_comboBoxSetAdditionalInfo | ( | UShort * | valueColIndexP, |
long * | stringListIdP, | ||
RawItemHdr * | comboBP | ||
) |
Sets information about a ComboBox dialog item that cannot be set with the mdlDialog_comboBoxSetInfo function.
[in] | valueColIndexP | is the index of the value column. Pass NULL in this argument if you do not want to set this value. |
[in] | stringListIdP | is the StringList of values for the ComboBox. Pass NULL in this argument if you do not want to set this value. |
[in] | comboBP | ComboBox to set additional info for |
StatusInt mdlDialog_comboBoxSetIndex | ( | long | index, |
RawItemHdr * | comboBP | ||
) |
Sets the index of the specified comboBox dialog item.
[in] | index | specifies the index of the comboBox item. |
[in] | comboBP | points to the comboBox dialog item to set the index in. |
StatusInt mdlDialog_comboBoxSetInfo | ( | CommandNumber * | commandNumberP, |
UInt32 * | commandSourceP, | ||
int * | maxSizeP, | ||
WCharCP | formatToDisplayP, | ||
WCharCP | formatToInternalP, | ||
WCharCP | minimumP, | ||
WCharCP | maximumP, | ||
UInt32 * | maskP, | ||
UShort * | nRowsP, | ||
UShort * | gapWidthP, | ||
UShort * | listWidthP, | ||
UInt32 * | attributesP, | ||
bool | redraw, | ||
RawItemHdr * | comboBP | ||
) |
Sets attributes of a ComboBox item.
For all of the pointer parameters, NULL indicates that the field should not be modified.
[in] | commandNumberP | set NULL if not setting cmd number |
[in] | commandSourceP | set NULL if not setting cmd source |
[in] | maxSizeP | points to a variable that indicates the maximum allowable size of the text string that can be contained by the ComboBox item, the maximum is 32K characters. |
[in] | formatToDisplayP | points to a sprintf format string to convert the value of the variable associated with the ComboBox item into a displayable string. |
[in] | formatToInternalP | points to a sscanf format string to convert from the ComboBox item's string value to the format expected by the variable associated with the ComboBox item. |
[in] | minimumP | points to a string that contains the minimum value of the ComboBox item. |
[in] | maximumP | points to a string that contains the maximum value of the ComboBox item. |
[out] | maskP | points to a UInt32 that contains the value mask |
[in] | nRowsP | points to an int that contains the number of rows displayed when the proper ListBox appears. |
[in] | gapWidthP | points to an int that contains the width, in dialog coordinate units (dcoords), between the selection field and the popup list activation button. |
[in] | listWidthP | points to an int that contains the width, in dialog coordinate units (dcoords), of the popup ListBox. |
[in] | attributesP | points to an int that contains the ComboBox item's attributes. The bits that can be included are defined in dlogbox.r.h. |
[in] | redraw | is a boolean flag that indicates whether mdlDialog_comboBoxSetInfo should cause the ComboBox to be redrawn after the information is modified. |
[in] | comboBP | ComboBox item to get info on |
ErrorCode mdlDialog_comboBoxSetListModelP | ( | RawItemHdr * | comboBP, |
ListModel * | pListModel | ||
) |
Sets the ListModel pointer used by the the ComboBox.
ListModels and StringLists are mutually exclusive.
[in] | comboBP | points to the RawItemHdr for the ComboBox item |
[in] | pListModel | points to the ListModel to be used as the data source for the ComboBox |
StatusInt mdlDialog_comboBoxSetPopupState | ( | RawItemHdr * | comboBP, |
bool | bOpen | ||
) |
ErrorCode mdlDialog_comboBoxSetStrListP | ( | RawItemHdr * | comboBP, |
StringListP | strListP, | ||
int | nColumns | ||
) |
Sets the StringList used by a ComboBox item.
[in] | comboBP | ComboBox to set strList of |
[in] | strListP | list's StringList |
[in] | nColumns | is the number of columns per row in the ComboBox popup list. |
StatusInt mdlDialog_comboBoxSetSubEditor | ( | RawItemHdr * | comboBP, |
bool | bSubEditor, | ||
RawItemHdr * | ownerRiP | ||
) |
Notifies the ComboBox item of its SubEditor status.
SubEditors are used during cell editing and in IconPopup items.
[in] | comboBP | points to the comboBox dialog item to set the index in. |
[in] | bSubEditor | indicates whether the ComboBox item is a SubEditor. |
[in] | ownerRiP | if the ComboBox item is a SubEditor, this is the RawItemHdr pointer of the owning dialog item. |
ErrorCode mdlDialog_comboBoxSetTreeModelP | ( | RawItemHdr * | comboBP, |
GuiTreeModelP | pTreeModel | ||
) |
Sets the GuiTreeModel pointer used by the the ComboBox.
GuiTreeModels, ListModels and StringLists are all mutually exclusive. The COMBOATTR_TREE attribute should be added to the resource for the ComboBox when using a Tree item and a GuiTreeModel data source.
[in] | comboBP | points to the RawItemHdr for the ComboBox item |
[in] | pTreeModel | points to the GuiTreeModel to be used as the data source for the ComboBox |