Functions | |
StatusInt | mdlDialog_rItemAccessStringSet (RawItemHdrP riP, char *pNewVariable) |
Sets the variable name for the access string. More... | |
StatusInt | mdlDialog_rItemActivate (RawItemHdrP riP, int keystroke, int rawKeystroke, int qualifierMask, bool isAccelerator, CommandNumber commandNumber, WCharCP unparsedP, WCharCP commandTaskIdP) |
Activates an Item. More... | |
StatusInt | mdlDialog_rItemBackgroundDraw (RawItemHdrP riP, BSIRectCP rectP, BSIColorDescrCP bgColorP) |
Draws the background of an Item. More... | |
StatusInt | mdlDialog_rItemBalloonTextGet (WStringR wText, RawItemHdrP riP) |
Retrieves the information displayed in the balloon window. More... | |
StatusInt | mdlDialog_rItemBalloonTextSet (RawItemHdrP riP, WCharCP pwNewText, bool bSetPopupText) |
Sets the information displayed in the balloon window. More... | |
void | mdlDialog_rItemBalloonTextShow (RawItemHdrP riP, Point2dCP cursorPt, bool showBalloon, WCharCP balloonTextP, BSIRectCP childRectP) |
Shows or closes the balloon window associated with this dialog item. More... | |
void | mdlDialog_rItemBalloonTextShowEx (RawItemHdrP riP, Point2dCP cursorPt, bool showBalloon, WCharCP balloonTextP, BSIRectCP localItemRectP, Point2dCP originPtP, int fontIndex, BSIColorDescrCP textColorP) |
Shows or closes the balloon window associated with this dialog item. More... | |
DialogItem ** | mdlDialog_rItemBuildChildList (RawItemHdrP parentRiP, int iStartItem, int iEndItem) |
Builds a list of the child items. More... | |
StatusInt | mdlDialog_rItemChildAttach (RawItemHdrP parentRiP, int nToInsert, DialogItem **diPListPP, int beforeItemIndex, bool drawItems) |
Attaches a child item to a parent. More... | |
RawItemHdr * | mdlDialog_rItemChildCreateWithRFileOpt (DialogItemP diP, RawItemHdrP parentRiP, Utf8CP labelP, CharP auxInfoP, RscFileHandle rFileH, MdlDescP ownerMD, void *rdataP, bool noErrorAlert, bool rFileToChild) |
Creates a child dialog item. More... | |
RawItemHdr * | mdlDialog_rItemChildCreate (DialogItemP diP, RawItemHdrP parentRiP, Utf8CP labelP, CharP auxInfoP, RscFileHandle rFileH, MdlDescP ownerMD, void *rdataP, bool noErrorAlert) |
Creates a child dialog item. More... | |
RawItemHdr * | mdlDialog_rItemChildCreateWRscAndRFileOpt (DialogItemP diP, RawItemHdrP parentRiP, DialogItemRsc *diRP, RscFileHandle rFileH, MdlDescP ownerMD, Point2dP originP, void *rdataP, bool noErrorAlert, bool rFileToChild) |
Creates a child dialog item. More... | |
RawItemHdr * | mdlDialog_rItemChildCreateWResource (DialogItemP diP, RawItemHdrP parentRiP, DialogItemRsc *diRP, RscFileHandle rFileH, MdlDescP ownerMD, Point2dP originP, void *rdataP, bool noErrorAlert) |
Creates a child dialog item. More... | |
StatusInt | mdlDialog_rItemChildDetach (RawItemHdrP parentRiP, int iStartItem, int iEndItem, bool eraseItems) |
Detaches a child dialog item from a parent item. More... | |
StatusInt | mdlDialog_rItemChildDrawCovered (RawItemHdrP parentRiP, int nRects, BSIRect *rectListP, bool drawReverseOrder, bool eraseFirst) |
Draws an item that is covered by another item. More... | |
RawItemHdr * | mdlDialog_rItemChildFocusGet (RawItemHdrP parentRiP) |
Gets the current item that is in focus. More... | |
StatusInt | mdlDialog_rItemChildFocusSet (RawItemHdrP parentRiP, RawItemHdrP riP, bool ignoreFocusOutErrors) |
Sets the focus to a specific item. More... | |
StatusInt | mdlDialog_rItemChildFree (RawItemHdrP parentRiP, int startItemIndex, int maxItemIndex) |
Frees the dialog item. More... | |
StatusInt | mdlDialog_rItemChildFreeDirectional (RawItemHdrP parentRiP, int startItemIndex, int maxItemIndex, int highToLow) |
Frees the set of dialog items in a direction. More... | |
RawItemHdr * | mdlDialog_rItemChildGetByIndex (RawItemHdrP parentRiP, int iItem) |
Gets a child RawItemHdr based on the item index. More... | |
DialogItem * | mdlDialog_rItemChildGetDiPByIndex (RawItemHdrP parentRiP, int iItem) |
Gets a dialogitem from a list by index *. More... | |
RawItemHdr * | mdlDialog_rItemChildGetByMnemonic (RawItemHdrP parentRiP, int mnemonic, int currentIndex, bool ignoreEnabledStatus) |
Gets a child RawItemHdr by the mnemonic. More... | |
RawItemHdrP | mdlDialog_rItemChildGetByPt (RawItemHdrP parentRiP, Point2dCP ptP, bool ignoreEnabledStatus) |
Gets a child item based on the screen coordinates. More... | |
RawItemHdr * | mdlDialog_rItemChildGetByTypeAndId (RawItemHdrP parentRiP, RscType type, RscId id, MdlDescP ownerMD, int startingIndex, bool searchChildren) |
Gets a RawItemHdr by the type and ID number. More... | |
RawItemHdr * | mdlDialog_rItemChildGetByTypeAndIndex (RawItemHdrP parentRiP, RscType type, int iItem) |
Gets a RawItemHdr by the type and an index within the items of that type. More... | |
StatusInt | mdlDialog_rItemChildGetMaxIndex (int *maxItemIndexP, RawItemHdr *parentRiP) |
Gets the highest index value on this parent item. More... | |
int | mdlDialog_rItemChildGetCount (RawItemHdrP parentRiP) |
Gets the number of Items on this parent item. More... | |
RawItemHdr * | mdlDialog_rItemChildGetNextFocusable (RawItemHdrP parentRiP, int direction) |
Gets the next item in the focus list. More... | |
StatusInt | mdlDialog_rItemChildInsertDiPs (int *beforeItemIndexP, RawItemHdrP parentRiP, int nItemsToInsert) |
Adds a child item or items to a dialog. More... | |
RawItemHdr * | mdlDialog_rItemChildLoad (DialogItemP copyDiP, int diPSize, RawItemHdrP parentRiP, Utf8CP labelP, CharP auxInfoP, RscFileHandle rFileH, MdlDescP ownerMD, void *rdataP, int beforeItemIndex, bool drawItem, bool noErrorAlert) |
Loads child items onto a parent item. More... | |
StatusInt | mdlDialog_rItemChildLoadListWithRFileOpt (RawItemHdrP parentRiP, DialogItemListRsc *dilRP, RscFileHandle rFileH, MdlDescP ownerMD, int beforeItemIndex, Point2dP originP, bool drawItems, bool noErrorAlert, bool rFileToChild) |
Loads a list of child items onto a parent item. More... | |
StatusInt | mdlDialog_rItemChildLoadList (RawItemHdrP parentRiP, DialogItemListRsc *dilRP, RscFileHandle rFileH, MdlDescP ownerMD, int beforeItemIndex, Point2dP originP, bool drawItems, bool noErrorAlert) |
Loads a list of dialog items to a parent item. More... | |
RawItemHdr * | mdlDialog_rItemChildLoadWResource (RawItemHdrP parentRiP, DialogItemRsc *diRP, Point2dP originP, RscFileHandle rFileH, MdlDescP ownerMD, void *rdataP, int beforeItemIndex, bool drawItem, bool noErrorAlert) |
Loads a dialog item from a resource file. More... | |
StatusInt | mdlDialog_rItemChildMsgForward (RawItemHdr *parentRiP, DialogItemMessage *parentDimP, RawItemHdr *childRiP, DialogItemMessage *childDimP) |
Forwards a DialogItemMessage to a certain child of a parent dialog item. More... | |
StatusInt | mdlDialog_rItemColorSet (RawItemHdrP riP, int itemColorType, BSIColorDescr *colorP) |
Sets the color of a dialog item. More... | |
StatusInt | mdlDialog_rItemDisabledBalloonTextSet (RawItemHdrP riP, WCharCP pwNewText) |
Sets the text to be displayed in the balloon when then item is disabled. More... | |
StatusInt | mdlDialog_rItemDisabledBalloonTextGet (WStringR wText, RawItemHdrP riP) |
Retrieves the information displayed in the balloon window when disabled. More... | |
StatusInt | mdlDialog_rItemDraw (RawItemHdrP riP) |
Erases then draws a dialog item. More... | |
StatusInt | mdlDialog_rItemDrawEx (RawItemHdrP riP, bool eraseFirst) |
Draws an item with the option of erasing the item first or not. More... | |
StatusInt | mdlDialog_rItemDrawOverlapping (bool *othersDrawnP, RawItemHdrP riP) |
Draws the items that overlap this item. More... | |
StatusInt | mdlDialog_rItemEnabledStateSet (RawItemHdrP riP, bool enabled, bool ignoreFocusOutErrors) |
Sets the enable state of an item by using the rawitem. More... | |
StatusInt | mdlDialog_rItemExtentConvert (Sextent *sextentP, RawItemHdrP riP) |
Gets the sextent of an item. More... | |
StatusInt | mdlDialog_rItemExtentSet (RawItemHdrP riP, SextentCP sextentP, bool redraw) |
Sets the extents of a dialog item. More... | |
StatusInt | mdlDialog_rItemFlyoverTextGet (WStringR wText, RawItemHdrP riP) |
Retrieves the information displayed in the flyover field. More... | |
StatusInt | mdlDialog_rItemFlyoverTextSet (RawItemHdrP riP, WCharCP pwNewText) |
Sets the information displayed in the flyover field. More... | |
bool | mdlDialog_rItemHasBalloonText (RawItemHdrP riP) |
Returns whether the item has any Balloon text set. More... | |
bool | mdlDialog_rItemHasFlyoverText (RawItemHdrP riP) |
Returns whether the item has any Flyover text set. More... | |
bool | mdlDialog_rItemHasFocus (RawItemHdrP riP) |
Returns whether the item has focus. More... | |
bool | mdlDialog_rItemHasLabel (RawItemHdrP riP) |
Returns whether the item has any Label text set. More... | |
StatusInt | mdlDialog_rItemHide (RawItemHdrP riP, bool ignoreFocusOutErrors) |
Hides a dialog item. More... | |
bool | mdlDialog_rItemIsFocusable (RawItemHdrP riP) |
Determines if an item is focusable. More... | |
bool | mdlDialog_rItemIsDisplayable (RawItemHdrP riP) |
Determines if an item can be displayed. More... | |
bool | mdlDialog_rItemIsValid (RawItemHdrP riP) |
Determines if an item pointer is valid. More... | |
StatusInt | mdlDialog_rItemLabelDraw (RawItemHdrP riP, Point2dCP ptP, int fontIndex, BSIRectCP clipRectP, BSIColorDescrCP foregroundP, BSIColorDescrCP backgroundP, BSIColorDescrCP dimColorP) |
Draws the label for an item. More... | |
StatusInt | mdlDialog_rItemLabelDrawTransparent (RawItemHdrP riP, Point2dCP ptP, int fontIndex, BSIRectCP clipRectP, BSIColorDescrCP foregroundP, BSIColorDescrCP backgroundP, BSIColorDescrCP dimColorP) |
Draws the label for an item using transparency (no solid color painted behind text). More... | |
StatusInt | mdlDialog_rItemLabelFontSet (RawItemHdrP riP, int fontIndex) |
Sets the font used for the label of an item. More... | |
StatusInt | mdlDialog_rItemLabelGet (WStringR wLabel, RawItemHdrP riP) |
Retrieves the text displayed in the label for this item as a WString. More... | |
StatusInt | mdlDialog_rItemLabelCopy (RawItemHdrP riP, WChar *pwBuffer, int iBuffSize) |
Retrieves the text displayed in the label for this item into a buffer. More... | |
StatusInt | mdlDialog_rItemLabelSet (RawItemHdrP riP, WCharCP pwString) |
Sets the text to be displayed as a label. More... | |
int | mdlDialog_rItemLabelLengthGet (RawItemHdrP riP) |
Retrieves the length in characters of the label for this item. More... | |
int | mdlDialog_rItemLabelWidthGet (RawItemHdrP riP, int fontIndex) |
Retrieves the width in pixels of the label for this item. More... | |
StatusInt | mdlDialog_rItemPopupMenuLabelGet (WStringR wText, RawItemHdrP riP) |
Retrieves the label appropriate for a popup menu. More... | |
StatusInt | mdlDialog_rItemMove (RawItemHdrP riP, Point2dCP ptP, bool redraw) |
Moves a dialog item to a new location. More... | |
StatusInt | mdlDialog_rItemMoveEx (RawItemHdrP riP, Point2dCP ptP, bool redraw, BSIRectCP pParentRect) |
Moves a dialog item to a new location based on the parent item. More... | |
StatusInt | mdlDialog_rItemObscure (RawItemHdrP riP, bool doObscure) |
Obscures or unobscures and item based on the doObscure argument. More... | |
RawItemHdr * | mdlDialog_rItemOwnerItemGet (RawItemHdrP riP) |
Retrieves the pointer to the RawItemHdr of the owning dialog item, if any. More... | |
StatusInt | mdlDialog_rItemOwnerItemSet (RawItemHdrP riP, RawItemHdr *ownerRiP) |
Sets the owning dialog item for this item. More... | |
RawItemHdr * | mdlDialog_rItemTopOwnerItemGet (RawItemHdrP riP) |
Retrieves the pointer to the RawItemHdr of the top most owning dialog item, if any. More... | |
RawItemHdr * | mdlDialog_rItemGetOwnerItemOfType (RawItemHdrP riP, UInt32 type) |
Retrieves an owner of a certain type from an item. More... | |
RawItemHdr * | mdlDialog_rItemGetParentItemOfType (RawItemHdrP riP, UInt32 type) |
Retrieves a parent of a certain type from an item. More... | |
StatusInt | mdlDialog_rItemPopupClose (RawItemHdrP riP, bool bUpdate) |
Notifies the owner item to close its popup window. More... | |
StatusInt | mdlDialog_rItemPopupClosedSend (RawItemHdrP riP) |
Notifies the owner item that the popup window has been closed. More... | |
StatusInt | mdlDialog_rItemPopupMenuTextSet (RawItemHdrP riP, WCharCP pwNewText) |
Sets the information displayed in the activate/deactivate PopupMenu. More... | |
StatusInt | mdlDialog_rItemReloadData (RawItemHdrP riP, bool redraw) |
Reloads information related to htis item from its data source. More... | |
StatusInt | mdlDialog_rItemShow (RawItemHdrP riP) |
Shows this dialog item. More... | |
StatusInt | mdlDialog_rItemSizeFromChildren (Point2d *pCorner, RawItemHdrP parentRiP, int iStartItem, int iEndItem) |
Sizes a parent item based on the positions and sizes of its child items. More... | |
StatusInt | mdlDialog_rItemStateGet (MSValueDescrR valueDescr, RawItemHdrP riP) |
Gets the state information of this item in an MSValueDescr. More... | |
StatusInt | mdlDialog_rItemStateSet (bool *stateChangedP, RawItemHdrP riP, bool synchOthers) |
Sets the state information for this item. More... | |
StatusInt | mdlDialog_rItemSynch (RawItemHdrP riP) |
Synchronizes this item. More... | |
StatusInt | mdlDialog_rItemSynchOthers (RawItemHdrP riP) |
Synchronizes items on dialogs other than the one the item is on. More... | |
void | mdlDialog_rItemSynchR (RawItemHdrP riP) |
Synchronizes the child items of a given item. More... | |
StatusInt | mdlDialog_rItemTHighlightDraw (RawItemHdrP riP, bool highlightOn, bool dashed, bool clearWithItemBgColor, bool redrawOverlapping) |
Draws the traversal hilite rectangle on this item. More... | |
StatusInt | mdlDialog_rItemValueGet (MSValueDescrR valueDescr, RawItemHdrP riP) |
Gets the internal value of this item in an MSValueDescr. More... | |
StatusInt | mdlDialog_rItemStringValueGet (WStringR stringValue, RawItemHdrP riP) |
Gets the internal value of this item as a string in a WString. More... | |
StatusInt | mdlDialog_rItemValueSet (bool *valueChangedP, MSValueDescrCR valueDescr, RawItemHdrP riP) |
Sets the internal value of this item. More... | |
StatusInt | mdlDialog_rItemStringValueSet (bool *valueChangedP, WCharCP stringValueP, RawItemHdrP riP) |
Sets the internal value of this item to a string. More... | |
StatusInt | mdlDialog_drawRItem (RawItemHdrP riP, bool eraseFirst, int nRects, BSIRect *rectList) |
Redraws the item and optionally erases the area before. More... | |
StatusInt | mdlDialog_rItemDiPInitialize (DialogItemP diP, MSDialogP dbP, DialogItemRsc *diRP, Point2dCP originP) |
Initializes a dialogitem based on another item and the resource. More... | |
RawItemHdr * | mdlDialog_rItemBaseGetByIndex (MSDialogP dbP, int iItem) |
Gets the child RawItemHdr of the dialog based on the item index. More... | |
RawItemHdrP | mdlDialog_rItemBaseGetByPt (MSDialogP dbP, Point2dCP ptP, bool ignoreEnabledStatus) |
Gets the child RawItemHdr of the dialog based on a local point. More... | |
RawItemHdr * | mdlDialog_rItemBaseGetByTypeAndId (MSDialogP dbP, RscType type, RscId id, MdlDescP ownerMD, int startingIndex) |
Gets the child RawItemHdr of the dialog based on the type and id of the item. More... | |
StatusInt | mdlDialog_rItemChildDraw (RawItemHdrP parentRiP, int iStartItem, int iEndItem, bool drawReverseOrder, bool eraseFirst, MSDialog *overrideDbP) |
Draws the child items associated with an item. More... | |
StatusInt | mdlDialog_rItemChildObscure (RawItemHdrP parentRiP, int iStartItem, int iEndItem, bool doObscure, bool reverseOrder, MSDialog *overrideDbP) |
Obscures (temporarily hides) a set of child items associated with a parent item. More... | |
RawItemHdr * | mdlDialog_rItemCancelGet (MSDialogP dbP) |
Gets the Cancel item for this dialogbox. More... | |
StatusInt | mdlDialog_rItemCancelSet (MSDialogP dbP, RawItemHdrP riP) |
Sets a Cancel item to this dialogbox. More... | |
BSIColorDescrP | mdlDialog_rItemColorGet (RawItemHdrP riP, MSDialogP dbP, int itemColorType) |
Gets the color for this item. More... | |
RawItemHdrP | mdlDialog_rItemDefaultGet (MSDialogP dbP) |
Gets the default RawItemHdr for this dialog. More... | |
StatusInt | mdlDialog_rItemDefaultSet (MSDialogP dbP, RawItemHdrP riP) |
Sets the default RawItemHdr for this dialog. More... | |
StatusInt | mdlDialog_rItemMenuBarSet (MSDialogP dbP, RawItemHdrP riP) |
Sets a MenuBar item for this dialog box. More... | |
StatusInt | mdlDialog_rItemPopup (RawItemHdrP riP, bool bOpen, bool bGrabMouse, bool bUpdate, Point2dCP pPopupPt, MSDialog **popupDbPP) |
Opens a Popup dialog associated with this item. More... | |
StatusInt | mdlDialog_rItemPopupCreatedSend (RawItemHdrP riP, MSDialogP popupDbP) |
Notifies the owner item that the popup window has been created. More... | |
StatusInt | mdlDialog_rItemPopupOpen (RawItemHdrP riP, bool bGrabMouse, Point2dCP pPopupPt, MSDialog **popupDbPP) |
Opens a Popup dialog associated with this item. More... | |
RawItemHdr * | mdlDialog_rItemRootGet (MSDialogP dbP) |
Returns the RawItemHdr for the root item of this child. More... | |
StatusInt mdlDialog_drawRItem | ( | RawItemHdrP | riP, |
bool | eraseFirst, | ||
int | nRects, | ||
BSIRect * | rectList | ||
) |
Redraws the item and optionally erases the area before.
[in] | riP | item to draw |
[in] | eraseFirst | true erases item before drawing |
[in] | nRects | number of rects in rectList |
[in] | rectList | array of dirty rectangles |
StatusInt mdlDialog_rItemAccessStringSet | ( | RawItemHdrP | riP, |
char * | pNewVariable | ||
) |
Sets the variable name for the access string.
[in] | riP | item to set new variable for |
[in] | pNewVariable | new variable for the access string |
StatusInt mdlDialog_rItemActivate | ( | RawItemHdrP | riP, |
int | keystroke, | ||
int | rawKeystroke, | ||
int | qualifierMask, | ||
bool | isAccelerator, | ||
CommandNumber | commandNumber, | ||
WCharCP | unparsedP, | ||
WCharCP | commandTaskIdP | ||
) |
Activates an Item.
[in] | riP | item to activate |
[in] | keystroke | virtual keystroke |
[in] | rawKeystroke | raw keystroke |
[in] | qualifierMask | modifier keys status |
[in] | isAccelerator | key is accelerator |
[in] | commandNumber | accelerator key cmd |
[in] | unparsedP | accelerator key unparsed |
[in] | commandTaskIdP | accelerator key command taskid |
StatusInt mdlDialog_rItemBackgroundDraw | ( | RawItemHdrP | riP, |
BSIRectCP | rectP, | ||
BSIColorDescrCP | bgColorP | ||
) |
Draws the background of an Item.
[in] | riP | item to fill |
[in] | rectP | rectangle to fill |
[in] | bgColorP | default background color; can be NULL |
StatusInt mdlDialog_rItemBalloonTextGet | ( | WStringR | wText, |
RawItemHdrP | riP | ||
) |
Retrieves the information displayed in the balloon window.
[out] | wText | WString to receive the balloon text |
[in] | riP | item to get balloon text for |
StatusInt mdlDialog_rItemBalloonTextSet | ( | RawItemHdrP | riP, |
WCharCP | pwNewText, | ||
bool | bSetPopupText | ||
) |
Sets the information displayed in the balloon window.
[in] | riP | item to set new balloon text for |
[in] | pwNewText | Unicode text for the balloon tooltip |
[in] | bSetPopupText | indicates whether to also set the text displayed in a PopupMenu for this item |
void mdlDialog_rItemBalloonTextShow | ( | RawItemHdrP | riP, |
Point2dCP | cursorPt, | ||
bool | showBalloon, | ||
WCharCP | balloonTextP, | ||
BSIRectCP | childRectP | ||
) |
Shows or closes the balloon window associated with this dialog item.
[in] | riP | item to show balloon text for |
[in] | cursorPt | cursor location in local coordinates |
[in] | showBalloon | true means open, false to CLOSE |
[in] | balloonTextP | If NULL, use value in riP, only items with no hdr need this |
[in] | childRectP | Child's (caller) itemRect. Need b/c some children riPless |
void mdlDialog_rItemBalloonTextShowEx | ( | RawItemHdrP | riP, |
Point2dCP | cursorPt, | ||
bool | showBalloon, | ||
WCharCP | balloonTextP, | ||
BSIRectCP | localItemRectP, | ||
Point2dCP | originPtP, | ||
int | fontIndex, | ||
BSIColorDescrCP | textColorP | ||
) |
Shows or closes the balloon window associated with this dialog item.
[in] | riP | item to show balloon text for |
[in] | cursorPt | cursor location in local coordinates |
[in] | showBalloon | true means open, false to CLOSE |
[in] | balloonTextP | If NULL, use value in riP, only items with no hdr need this |
[in] | localItemRectP | Child's (caller) itemRect. Need b/c some children riPless |
[in] | originPtP | Specified Origin of the Balloon Popup |
[in] | fontIndex | font index to draw text with or -1 for current |
[in] | textColorP | text color, NULL means use default foreground color |
RawItemHdr* mdlDialog_rItemBaseGetByIndex | ( | MSDialogP | dbP, |
int | iItem | ||
) |
Gets the child RawItemHdr of the dialog based on the item index.
[in] | dbP | dialog whose child we're getting |
[in] | iItem | index of child to get |
RawItemHdrP mdlDialog_rItemBaseGetByPt | ( | MSDialogP | dbP, |
Point2dCP | ptP, | ||
bool | ignoreEnabledStatus | ||
) |
Gets the child RawItemHdr of the dialog based on a local point.
[in] | dbP | dialog whose child we're getting |
[in] | ptP | local point at which to find a child item |
[in] | ignoreEnabledStatus | ignore enabled status of items? |
RawItemHdr* mdlDialog_rItemBaseGetByTypeAndId | ( | MSDialogP | dbP, |
RscType | type, | ||
RscId | id, | ||
MdlDescP | ownerMD, | ||
int | startingIndex | ||
) |
Gets the child RawItemHdr of the dialog based on the type and id of the item.
[in] | dbP | dialog whose child we're getting |
[in] | type | type of the item to get |
[in] | id | resource id of the item to get |
[in] | ownerMD | owner of item, NULL means owner of parent |
[in] | startingIndex | item index to look from (usually 0) |
DialogItem** mdlDialog_rItemBuildChildList | ( | RawItemHdrP | parentRiP, |
int | iStartItem, | ||
int | iEndItem | ||
) |
Builds a list of the child items.
[in] | parentRiP | parent item to build diP list from |
[in] | iStartItem | index of item to start with |
[in] | iEndItem | index to end with, -1=all to end |
RawItemHdr* mdlDialog_rItemCancelGet | ( | MSDialogP | dbP | ) |
Gets the Cancel item for this dialogbox.
[in] | dbP | dialogBox |
StatusInt mdlDialog_rItemCancelSet | ( | MSDialogP | dbP, |
RawItemHdrP | riP | ||
) |
Sets a Cancel item to this dialogbox.
[in] | dbP | dialogBox that contains item |
[in] | riP | new cancel item, NULL=None |
StatusInt mdlDialog_rItemChildAttach | ( | RawItemHdrP | parentRiP, |
int | nToInsert, | ||
DialogItem ** | diPListPP, | ||
int | beforeItemIndex, | ||
bool | drawItems | ||
) |
Attaches a child item to a parent.
[in] | parentRiP | parent to whom we're attaching children to |
[in] | nToInsert | # of items to attach |
[in] | diPListPP | item list |
[in] | beforeItemIndex | item to load before,-1=append |
[in] | drawItems | true means draw items after attaching |
RawItemHdr* mdlDialog_rItemChildCreate | ( | DialogItemP | diP, |
RawItemHdrP | parentRiP, | ||
Utf8CP | labelP, | ||
CharP | auxInfoP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
void * | rdataP, | ||
bool | noErrorAlert | ||
) |
Creates a child dialog item.
[in,out] | diP | filled in correctly all of diP should already be setup except rawItemP |
[in] | parentRiP | parent item |
[in] | labelP | override label |
[in] | auxInfoP | auxInfo string |
[in] | rFileH | resource file to load item from |
[in] | ownerMD | NULL=owner of item is owner of db |
[in] | rdataP | if NULL load in resource using diRP |
[in] | noErrorAlert | don't show resource load error alert |
RawItemHdr* mdlDialog_rItemChildCreateWithRFileOpt | ( | DialogItemP | diP, |
RawItemHdrP | parentRiP, | ||
Utf8CP | labelP, | ||
CharP | auxInfoP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
void * | rdataP, | ||
bool | noErrorAlert, | ||
bool | rFileToChild | ||
) |
Creates a child dialog item.
[in,out] | diP | filled in correctly all of diP should already be setup except rawItemP * * |
[in] | parentRiP | parent item |
[in] | labelP | override label |
[in] | auxInfoP | auxInfo string |
[in] | rFileH | resource file to load item from |
[in] | ownerMD | NULL=owner of item is owner of db |
[in] | rdataP | if NULL load in resource using diRP |
[in] | noErrorAlert | don't show resource load error alert |
[in] | rFileToChild | if item has children, load them from file specified in rFileH |
RawItemHdr* mdlDialog_rItemChildCreateWResource | ( | DialogItemP | diP, |
RawItemHdrP | parentRiP, | ||
DialogItemRsc * | diRP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
Point2dP | originP, | ||
void * | rdataP, | ||
bool | noErrorAlert | ||
) |
Creates a child dialog item.
[in,out] | diP | filled in correctly, can't be NULL |
[in] | parentRiP | parent item, can't be NULL |
[in] | diRP | dialog item resource description of item |
[in] | rFileH | resource file to load item from |
[in] | ownerMD | NULL=owner of item is owner of db |
[in] | originP | (dcoord units) |
[in] | rdataP | if NULL load in resource using diRP |
[in] | noErrorAlert | don't show resource load error alert |
RawItemHdr* mdlDialog_rItemChildCreateWRscAndRFileOpt | ( | DialogItemP | diP, |
RawItemHdrP | parentRiP, | ||
DialogItemRsc * | diRP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
Point2dP | originP, | ||
void * | rdataP, | ||
bool | noErrorAlert, | ||
bool | rFileToChild | ||
) |
Creates a child dialog item.
[in,out] | diP | filled in correctly, can't be NULL |
[in] | parentRiP | parent item, can't be NULL |
[in] | diRP | dialog item resource description of item |
[in] | rFileH | resource file to load item from |
[in] | ownerMD | NULL=owner of item is owner of db |
[in] | originP | (dcoord units) |
[in] | rdataP | if NULL load in resource using diRP |
[in] | noErrorAlert | don't show resource load error alert |
[in] | rFileToChild | if item has children, load them from file specified in rFileH |
StatusInt mdlDialog_rItemChildDetach | ( | RawItemHdrP | parentRiP, |
int | iStartItem, | ||
int | iEndItem, | ||
bool | eraseItems | ||
) |
Detaches a child dialog item from a parent item.
[in] | parentRiP | item whose children we're detaching |
[in] | iStartItem | starting index of items to detach |
[in] | iEndItem | last index of items to detach |
[in] | eraseItems | erase items before detaching |
StatusInt mdlDialog_rItemChildDraw | ( | RawItemHdrP | parentRiP, |
int | iStartItem, | ||
int | iEndItem, | ||
bool | drawReverseOrder, | ||
bool | eraseFirst, | ||
MSDialog * | overrideDbP | ||
) |
Draws the child items associated with an item.
[in] | parentRiP | item whose CHILDREN we're drawing |
[in] | iStartItem | starting index of items to draw |
[in] | iEndItem | last index of items to draw |
[in] | drawReverseOrder | draw children in reverse order |
[in] | eraseFirst | children should erase themselves first |
[in] | overrideDbP | new ownerDialogP (usually NULL=dont change) |
StatusInt mdlDialog_rItemChildDrawCovered | ( | RawItemHdrP | parentRiP, |
int | nRects, | ||
BSIRect * | rectListP, | ||
bool | drawReverseOrder, | ||
bool | eraseFirst | ||
) |
Draws an item that is covered by another item.
[in] | parentRiP | item whose CHILDREN we're drawing |
[in] | nRects | # of rects pt'ed at by rectListP |
[in] | rectListP | array of rectangles, overlapped items are drawn |
[in] | drawReverseOrder | draw children in reverse order |
[in] | eraseFirst | children should erase themselves first |
RawItemHdr* mdlDialog_rItemChildFocusGet | ( | RawItemHdrP | parentRiP | ) |
Gets the current item that is in focus.
[in] | parentRiP | parent item whose child focus item we're getting |
StatusInt mdlDialog_rItemChildFocusSet | ( | RawItemHdrP | parentRiP, |
RawItemHdrP | riP, | ||
bool | ignoreFocusOutErrors | ||
) |
Sets the focus to a specific item.
[in] | parentRiP | parent item whose child's focus we're setting |
[in] | riP | new focus item or NULL |
[in] | ignoreFocusOutErrors | usually false |
StatusInt mdlDialog_rItemChildFree | ( | RawItemHdrP | parentRiP, |
int | startItemIndex, | ||
int | maxItemIndex | ||
) |
Frees the dialog item.
[in] | parentRiP | item whose children we're freeing |
[in] | startItemIndex | starting index of items to free |
[in] | maxItemIndex | last index of items to free |
StatusInt mdlDialog_rItemChildFreeDirectional | ( | RawItemHdrP | parentRiP, |
int | startItemIndex, | ||
int | maxItemIndex, | ||
int | highToLow | ||
) |
Frees the set of dialog items in a direction.
[in] | parentRiP | item whose children we're freeing |
[in] | startItemIndex | starting index of items to free |
[in] | maxItemIndex | last index of items to free |
[in] | highToLow | true = hToL, false = lToH |
RawItemHdr* mdlDialog_rItemChildGetByIndex | ( | RawItemHdrP | parentRiP, |
int | iItem | ||
) |
Gets a child RawItemHdr based on the item index.
[in] | parentRiP | item whose child we're getting |
[in] | iItem | index of child to get |
RawItemHdr* mdlDialog_rItemChildGetByMnemonic | ( | RawItemHdrP | parentRiP, |
int | mnemonic, | ||
int | currentIndex, | ||
bool | ignoreEnabledStatus | ||
) |
Gets a child RawItemHdr by the mnemonic.
[out] | parentRiP | item whose children we're searching |
[in] | mnemonic | mnemonic to search for |
[in] | currentIndex | item index to look after (usually -1) |
[in] | ignoreEnabledStatus | ignore enabled status of items? |
RawItemHdrP mdlDialog_rItemChildGetByPt | ( | RawItemHdrP | parentRiP, |
Point2dCP | ptP, | ||
bool | ignoreEnabledStatus | ||
) |
Gets a child item based on the screen coordinates.
[out] | parentRiP | item whose children we're checking |
[in] | ptP | in local coords |
[in] | ignoreEnabledStatus | ignore enabled status of items? |
RawItemHdr* mdlDialog_rItemChildGetByTypeAndId | ( | RawItemHdrP | parentRiP, |
RscType | type, | ||
RscId | id, | ||
MdlDescP | ownerMD, | ||
int | startingIndex, | ||
bool | searchChildren | ||
) |
Gets a RawItemHdr by the type and ID number.
[in] | parentRiP | item whose child we're getting |
[in] | type | type of the item to get |
[in] | id | resource id of the item to get |
[in] | ownerMD | owner of item, NULL means owner of parent |
[in] | startingIndex | item index to look from (usually 0) |
[in] | searchChildren | search children's children? |
RawItemHdr* mdlDialog_rItemChildGetByTypeAndIndex | ( | RawItemHdrP | parentRiP, |
RscType | type, | ||
int | iItem | ||
) |
Gets a RawItemHdr by the type and an index within the items of that type.
[in] | parentRiP | item whose child we're getting |
[in] | type | type of the item to get |
[in] | iItem | index within the items of that type |
int mdlDialog_rItemChildGetCount | ( | RawItemHdrP | parentRiP | ) |
Gets the number of Items on this parent item.
[in] | parentRiP | parent whose child count we're getting |
DialogItem* mdlDialog_rItemChildGetDiPByIndex | ( | RawItemHdrP | parentRiP, |
int | iItem | ||
) |
Gets a dialogitem from a list by index *.
[in] | parentRiP | item whose child we're getting |
[in] | iItem | index of child to get |
StatusInt mdlDialog_rItemChildGetMaxIndex | ( | int * | maxItemIndexP, |
RawItemHdr * | parentRiP | ||
) |
Gets the highest index value on this parent item.
[out] | maxItemIndexP | max child item index or -1 if error |
[in] | parentRiP | parent whose max child index we're getting |
RawItemHdr* mdlDialog_rItemChildGetNextFocusable | ( | RawItemHdrP | parentRiP, |
int | direction | ||
) |
Gets the next item in the focus list.
[in] | parentRiP | item to determine focusable child of |
[in] | direction | if < 0 means previous item |
StatusInt mdlDialog_rItemChildInsertDiPs | ( | int * | beforeItemIndexP, |
RawItemHdrP | parentRiP, | ||
int | nItemsToInsert | ||
) |
Adds a child item or items to a dialog.
[in,out] | beforeItemIndexP | item to load before, NULL means append |
[in] | parentRiP | parent item to contain new diPs, can't be NULL |
[in] | nItemsToInsert | # of items to insert |
RawItemHdr* mdlDialog_rItemChildLoad | ( | DialogItemP | copyDiP, |
int | diPSize, | ||
RawItemHdrP | parentRiP, | ||
Utf8CP | labelP, | ||
CharP | auxInfoP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
void * | rdataP, | ||
int | beforeItemIndex, | ||
bool | drawItem, | ||
bool | noErrorAlert | ||
) |
Loads child items onto a parent item.
[in] | copyDiP | item to load (Copy made, destroy after call) |
[in] | diPSize | sizeof (DialogItem) |
[in] | parentRiP | parent item to contain loaded item, can't be NULL |
[in] | labelP | override label |
[in] | auxInfoP | auxInfo string |
[in] | rFileH | NULL means use opened resource files |
[in] | ownerMD | NULL=owner of item is owner of db |
[in] | rdataP | if NULL load in resource using diRP |
[in] | beforeItemIndex | item to load before,-1=append |
[in] | drawItem | if true draw item |
[in] | noErrorAlert | don't display resource load error alert |
StatusInt mdlDialog_rItemChildLoadList | ( | RawItemHdrP | parentRiP, |
DialogItemListRsc * | dilRP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
int | beforeItemIndex, | ||
Point2dP | originP, | ||
bool | drawItems, | ||
bool | noErrorAlert | ||
) |
Loads a list of dialog items to a parent item.
[in] | parentRiP | parent item to contain loaded item, can't be NULL |
[in] | dilRP | list of items to load |
[in] | rFileH | NULL means use opened resource files |
[in] | ownerMD | NULL=owner items is owner of db |
[in] | beforeItemIndex | item to load before,-1=append |
[in] | originP | items loaded relative to this point; x,y > 0 in dcoord units else in pixels |
[in] | drawItems | true means draw items after loading |
[in] | noErrorAlert | don't display any resource load error alerts |
StatusInt mdlDialog_rItemChildLoadListWithRFileOpt | ( | RawItemHdrP | parentRiP, |
DialogItemListRsc * | dilRP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
int | beforeItemIndex, | ||
Point2dP | originP, | ||
bool | drawItems, | ||
bool | noErrorAlert, | ||
bool | rFileToChild | ||
) |
Loads a list of child items onto a parent item.
[in] | parentRiP | parent item to contain loaded item, can't be NULL |
[in] | dilRP | list of items to load |
[in] | rFileH | NULL means use opened resource files |
[in] | ownerMD | NULL=owner items is owner of db |
[in] | beforeItemIndex | item to load before,-1=append |
[in] | originP | items loaded relative to this point x,y > 0 in dcoord units else in pixels |
[in] | drawItems | true means draw items after loading |
[in] | noErrorAlert | don't display any resource load error alerts |
[in] | rFileToChild | if item has children, load them from file specified in rFileH |
RawItemHdr* mdlDialog_rItemChildLoadWResource | ( | RawItemHdrP | parentRiP, |
DialogItemRsc * | diRP, | ||
Point2dP | originP, | ||
RscFileHandle | rFileH, | ||
MdlDescP | ownerMD, | ||
void * | rdataP, | ||
int | beforeItemIndex, | ||
bool | drawItem, | ||
bool | noErrorAlert | ||
) |
Loads a dialog item from a resource file.
[in] | parentRiP | parent item |
[in] | diRP | item to load |
[in] | originP | items loaded relative to this point |
[in] | rFileH | NULL means use opened resource files |
[in] | ownerMD | NULL=owner of item is owner of db |
[in] | rdataP | if NULL load in resource using diRP |
[in] | beforeItemIndex | item to load before,-1=append |
[in] | drawItem | if true draw item |
[in] | noErrorAlert | don't display resource load error alert |
StatusInt mdlDialog_rItemChildMsgForward | ( | RawItemHdr * | parentRiP, |
DialogItemMessage * | parentDimP, | ||
RawItemHdr * | childRiP, | ||
DialogItemMessage * | childDimP | ||
) |
Forwards a DialogItemMessage to a certain child of a parent dialog item.
[in] | parentRiP | parent item |
[in] | parentDimP | message sent to the parent item |
[in] | childRiP | child item |
[in] | childDimP | message to be sent to the child item; must be allocated before call |
StatusInt mdlDialog_rItemChildObscure | ( | RawItemHdrP | parentRiP, |
int | iStartItem, | ||
int | iEndItem, | ||
bool | doObscure, | ||
bool | reverseOrder, | ||
MSDialog * | overrideDbP | ||
) |
Obscures (temporarily hides) a set of child items associated with a parent item.
Obscuring is used for child items on TabPages and Containers.
[in] | parentRiP | item whose CHILDREN we're drawing |
[in] | iStartItem | starting index of items to draw |
[in] | iEndItem | last index of items to draw |
[in] | doObscure | true = obscure, false = unobscure |
[in] | reverseOrder | obscure children in reverse order |
[in] | overrideDbP | new ownerDialogP (usually NULL=dont change) |
BSIColorDescrP mdlDialog_rItemColorGet | ( | RawItemHdrP | riP, |
MSDialogP | dbP, | ||
int | itemColorType | ||
) |
Gets the color for this item.
[in] | riP | item to get color for |
[in] | dbP | dialog box item is in |
[in] | itemColorType | item color type |
StatusInt mdlDialog_rItemColorSet | ( | RawItemHdrP | riP, |
int | itemColorType, | ||
BSIColorDescr * | colorP | ||
) |
Sets the color of a dialog item.
[in] | riP | item to set color of |
[in] | itemColorType | DITEM_COLORTYPE_BACKGROUND, etc. |
[in] | colorP | new color descriptor |
RawItemHdrP mdlDialog_rItemDefaultGet | ( | MSDialogP | dbP | ) |
Gets the default RawItemHdr for this dialog.
[in] | dbP | dialogBox |
StatusInt mdlDialog_rItemDefaultSet | ( | MSDialogP | dbP, |
RawItemHdrP | riP | ||
) |
Sets the default RawItemHdr for this dialog.
[in] | dbP | dialogBox that contains item |
[in] | riP | new default item, NULL=None |
StatusInt mdlDialog_rItemDiPInitialize | ( | DialogItemP | diP, |
MSDialogP | dbP, | ||
DialogItemRsc * | diRP, | ||
Point2dCP | originP | ||
) |
Initializes a dialogitem based on another item and the resource.
[in,out] | diP | item to initialize |
[in] | dbP | dialog that dip will be used in (for fontHeight) |
[in] | diRP | dialog item resource description of item |
[in] | originP | (dcoord units) |
StatusInt mdlDialog_rItemDisabledBalloonTextGet | ( | WStringR | wText, |
RawItemHdrP | riP | ||
) |
Retrieves the information displayed in the balloon window when disabled.
[out] | wText | WString to receive the balloon text when disabled |
[in] | riP | item to get balloon text for |
StatusInt mdlDialog_rItemDisabledBalloonTextSet | ( | RawItemHdrP | riP, |
WCharCP | pwNewText | ||
) |
Sets the text to be displayed in the balloon when then item is disabled.
[in] | riP | item to set new balloon text for |
[in] | pwNewText | Unicode text for the balloon tooltip |
StatusInt mdlDialog_rItemDraw | ( | RawItemHdrP | riP | ) |
Erases then draws a dialog item.
[in] | riP | item to draw |
StatusInt mdlDialog_rItemDrawEx | ( | RawItemHdrP | riP, |
bool | eraseFirst | ||
) |
Draws an item with the option of erasing the item first or not.
[in] | riP | item to draw |
[in] | eraseFirst | true erases item before drawing |
StatusInt mdlDialog_rItemDrawOverlapping | ( | bool * | othersDrawnP, |
RawItemHdrP | riP | ||
) |
Draws the items that overlap this item.
[out] | othersDrawnP | |
[in] | riP | item to draw overlapping items of |
StatusInt mdlDialog_rItemEnabledStateSet | ( | RawItemHdrP | riP, |
bool | enabled, | ||
bool | ignoreFocusOutErrors | ||
) |
Sets the enable state of an item by using the rawitem.
[in] | riP | item to set enabled |
[in] | enabled | false means disable item |
[in] | ignoreFocusOutErrors | usually false |
StatusInt mdlDialog_rItemExtentConvert | ( | Sextent * | sextentP, |
RawItemHdrP | riP | ||
) |
Gets the sextent of an item.
[out] | sextentP | extent usable in call to setExtent |
[in] | riP | item whose extent we're converting |
StatusInt mdlDialog_rItemExtentSet | ( | RawItemHdrP | riP, |
SextentCP | sextentP, | ||
bool | redraw | ||
) |
Sets the extents of a dialog item.
[in] | riP | item to set extent |
[in] | sextentP | new extent of item (dcoords) |
[in] | redraw | usually true, item redraw after resized |
StatusInt mdlDialog_rItemFlyoverTextGet | ( | WStringR | wText, |
RawItemHdrP | riP | ||
) |
Retrieves the information displayed in the flyover field.
[out] | wText | WString to receive the flyover text |
[in] | riP | item to get flyover text for |
StatusInt mdlDialog_rItemFlyoverTextSet | ( | RawItemHdrP | riP, |
WCharCP | pwNewText | ||
) |
Sets the information displayed in the flyover field.
[in] | riP | item to set new Flyover text for |
[in] | pwNewText | Unicode text for the Flyover tooltip |
RawItemHdr* mdlDialog_rItemGetOwnerItemOfType | ( | RawItemHdrP | riP, |
UInt32 | type | ||
) |
Retrieves an owner of a certain type from an item.
[in] | riP | item to get an owner from |
[in] | type | item type to check for |
RawItemHdr* mdlDialog_rItemGetParentItemOfType | ( | RawItemHdrP | riP, |
UInt32 | type | ||
) |
Retrieves a parent of a certain type from an item.
[in] | riP | item to get a parent from |
[in] | type | item type to check for |
bool mdlDialog_rItemHasBalloonText | ( | RawItemHdrP | riP | ) |
Returns whether the item has any Balloon text set.
[in] | riP | item to query for existence of BalloonText |
bool mdlDialog_rItemHasFlyoverText | ( | RawItemHdrP | riP | ) |
Returns whether the item has any Flyover text set.
[in] | riP | item to query for existence of FlyoverText |
bool mdlDialog_rItemHasFocus | ( | RawItemHdrP | riP | ) |
Returns whether the item has focus.
[in] | riP | item to query for focus |
bool mdlDialog_rItemHasLabel | ( | RawItemHdrP | riP | ) |
Returns whether the item has any Label text set.
[in] | riP | item to query for existence of Label text |
StatusInt mdlDialog_rItemHide | ( | RawItemHdrP | riP, |
bool | ignoreFocusOutErrors | ||
) |
Hides a dialog item.
[in] | riP | item to hide |
[in] | ignoreFocusOutErrors | usually false |
bool mdlDialog_rItemIsDisplayable | ( | RawItemHdrP | riP | ) |
Determines if an item can be displayed.
[in] | riP | item to determine if displayable * |
bool mdlDialog_rItemIsFocusable | ( | RawItemHdrP | riP | ) |
Determines if an item is focusable.
[in] | riP | item to determine focusability of * |
bool mdlDialog_rItemIsValid | ( | RawItemHdrP | riP | ) |
Determines if an item pointer is valid.
[in] | riP | item to validate |
StatusInt mdlDialog_rItemLabelCopy | ( | RawItemHdrP | riP, |
WChar * | pwBuffer, | ||
int | iBuffSize | ||
) |
Retrieves the text displayed in the label for this item into a buffer.
[in] | riP | item to get label text for |
[out] | pwBuffer | points to a WChar array receiving the Unicode label |
[in] | iBuffSize | maximum number of characters to receive, including the NULL terminator |
StatusInt mdlDialog_rItemLabelDraw | ( | RawItemHdrP | riP, |
Point2dCP | ptP, | ||
int | fontIndex, | ||
BSIRectCP | clipRectP, | ||
BSIColorDescrCP | foregroundP, | ||
BSIColorDescrCP | backgroundP, | ||
BSIColorDescrCP | dimColorP | ||
) |
Draws the label for an item.
[in] | riP | item to draw label of |
[in] | ptP | location of label or NULL use riP->labelPt |
[in] | fontIndex | font index to draw label with or -1 for current |
[in] | clipRectP | clip rectangle (local coords) |
[in] | foregroundP | label color, NULL means use default foreground |
[in] | backgroundP | background color descr, NULL=dialog background |
[in] | dimColorP | color if disabled, NULL means use grayText |
StatusInt mdlDialog_rItemLabelDrawTransparent | ( | RawItemHdrP | riP, |
Point2dCP | ptP, | ||
int | fontIndex, | ||
BSIRectCP | clipRectP, | ||
BSIColorDescrCP | foregroundP, | ||
BSIColorDescrCP | backgroundP, | ||
BSIColorDescrCP | dimColorP | ||
) |
Draws the label for an item using transparency (no solid color painted behind text).
[in] | riP | item to draw label of |
[in] | ptP | location of label or NULL use riP->labelPt |
[in] | fontIndex | font index to draw label with or -1 for current |
[in] | clipRectP | clip rectangle (local coords) |
[in] | foregroundP | label color, NULL means use default foreground |
[in] | backgroundP | background color descr, NULL=dialog background |
[in] | dimColorP | color if disabled, NULL means use grayText |
StatusInt mdlDialog_rItemLabelFontSet | ( | RawItemHdrP | riP, |
int | fontIndex | ||
) |
Sets the font used for the label of an item.
[in] | riP | item to set label of |
[in] | fontIndex | new font index for label |
StatusInt mdlDialog_rItemLabelGet | ( | WStringR | wLabel, |
RawItemHdrP | riP | ||
) |
Retrieves the text displayed in the label for this item as a WString.
[out] | wLabel | a WString to populate |
[in] | riP | item to get label text for |
int mdlDialog_rItemLabelLengthGet | ( | RawItemHdrP | riP | ) |
Retrieves the length in characters of the label for this item.
[in] | riP | item to get label length for |
StatusInt mdlDialog_rItemLabelSet | ( | RawItemHdrP | riP, |
WCharCP | pwString | ||
) |
Sets the text to be displayed as a label.
[in] | riP | item to set label of |
[in] | pwString | Unicode text for the new label |
int mdlDialog_rItemLabelWidthGet | ( | RawItemHdrP | riP, |
int | fontIndex | ||
) |
Retrieves the width in pixels of the label for this item.
[in] | riP | item to get label width for |
[in] | fontIndex | index of the font to use when determining the label width |
StatusInt mdlDialog_rItemMenuBarSet | ( | MSDialogP | dbP, |
RawItemHdrP | riP | ||
) |
Sets a MenuBar item for this dialog box.
[in] | dbP | dialogBox that contains item |
[in] | riP | new menuBar item, NULL=None |
StatusInt mdlDialog_rItemMove | ( | RawItemHdrP | riP, |
Point2dCP | ptP, | ||
bool | redraw | ||
) |
Moves a dialog item to a new location.
[in] | riP | item to move |
[in] | ptP | (dcoords) where to move item to |
[in] | redraw | true means redraw item after move |
StatusInt mdlDialog_rItemMoveEx | ( | RawItemHdrP | riP, |
Point2dCP | ptP, | ||
bool | redraw, | ||
BSIRectCP | pParentRect | ||
) |
Moves a dialog item to a new location based on the parent item.
[in] | riP | item to move |
[in] | ptP | (dcoords) where to move item to |
[in] | redraw | true means redraw item after move |
[in] | pParentRect | Rect of any parent item or NULL |
StatusInt mdlDialog_rItemObscure | ( | RawItemHdrP | riP, |
bool | doObscure | ||
) |
Obscures or unobscures and item based on the doObscure argument.
[in] | riP | item to process |
[in] | doObscure | true = obscure, false = unobscure |
RawItemHdr* mdlDialog_rItemOwnerItemGet | ( | RawItemHdrP | riP | ) |
Retrieves the pointer to the RawItemHdr of the owning dialog item, if any.
[in] | riP | item to get owner from |
StatusInt mdlDialog_rItemOwnerItemSet | ( | RawItemHdrP | riP, |
RawItemHdr * | ownerRiP | ||
) |
Sets the owning dialog item for this item.
[in] | riP | item to set owner in |
[in] | ownerRiP | owning item |
StatusInt mdlDialog_rItemPopup | ( | RawItemHdrP | riP, |
bool | bOpen, | ||
bool | bGrabMouse, | ||
bool | bUpdate, | ||
Point2dCP | pPopupPt, | ||
MSDialog ** | popupDbPP | ||
) |
Opens a Popup dialog associated with this item.
[in] | riP | item that has a popup to open |
[in] | bOpen | true = Open the popup, false = close the popup |
[in] | bGrabMouse | true = grab mouse after opening popup |
[in] | bUpdate | true = Update the value of the item on popup close |
[in] | pPopupPt | Placement of popup or NULL |
[in,out] | popupDbPP | MSDialog * of popup window |
StatusInt mdlDialog_rItemPopupClose | ( | RawItemHdrP | riP, |
bool | bUpdate | ||
) |
Notifies the owner item to close its popup window.
[in] | riP | item to close popup for |
[in] | bUpdate | indicates whether to update the state of the item on close |
StatusInt mdlDialog_rItemPopupClosedSend | ( | RawItemHdrP | riP | ) |
Notifies the owner item that the popup window has been closed.
[in] | riP | item to notify of popup closure |
StatusInt mdlDialog_rItemPopupCreatedSend | ( | RawItemHdrP | riP, |
MSDialogP | popupDbP | ||
) |
Notifies the owner item that the popup window has been created.
[in] | riP | item to notify of popup closure |
[in] | popupDbP | the popup MSDialog |
StatusInt mdlDialog_rItemPopupMenuLabelGet | ( | WStringR | wText, |
RawItemHdrP | riP | ||
) |
Retrieves the label appropriate for a popup menu.
[in] | wText | buffer of Unicode characters to receive the popup menu label |
[in] | riP | item to get label for |
StatusInt mdlDialog_rItemPopupMenuTextSet | ( | RawItemHdrP | riP, |
WCharCP | pwNewText | ||
) |
Sets the information displayed in the activate/deactivate PopupMenu.
[in] | riP | item to set new PopupMenu text for |
[in] | pwNewText | Unicode text for the PopupMenu text |
StatusInt mdlDialog_rItemPopupOpen | ( | RawItemHdrP | riP, |
bool | bGrabMouse, | ||
Point2dCP | pPopupPt, | ||
MSDialog ** | popupDbPP | ||
) |
Opens a Popup dialog associated with this item.
If the popup should have focus and the mouse then set the bGrabMouse to true.
[in] | riP | item that has a popup to open |
[in] | bGrabMouse | true = grab mouse after opening popup |
[in] | pPopupPt | Placement of popup or NULL |
[in,out] | popupDbPP | MSDialog * of popup window |
StatusInt mdlDialog_rItemReloadData | ( | RawItemHdrP | riP, |
bool | redraw | ||
) |
Reloads information related to htis item from its data source.
[in] | riP | item that needs to reload from its data source |
[in] | redraw | whether to redraw after reload |
RawItemHdr* mdlDialog_rItemRootGet | ( | MSDialogP | dbP | ) |
Returns the RawItemHdr for the root item of this child.
[in] | dbP | dialog box to get root item of |
StatusInt mdlDialog_rItemShow | ( | RawItemHdrP | riP | ) |
Shows this dialog item.
[in] | riP | item to show |
StatusInt mdlDialog_rItemSizeFromChildren | ( | Point2d * | pCorner, |
RawItemHdrP | parentRiP, | ||
int | iStartItem, | ||
int | iEndItem | ||
) |
Sizes a parent item based on the positions and sizes of its child items.
[in,out] | pCorner | point representing the new corner of the parent item |
[in] | parentRiP | parent item to resize |
[in] | iStartItem | 0-based index of the item to start with for resizing |
[in] | iEndItem | 0-based index of the item to end with for resizing; -1 to end |
StatusInt mdlDialog_rItemStateGet | ( | MSValueDescrR | valueDescr, |
RawItemHdrP | riP | ||
) |
Gets the state information of this item in an MSValueDescr.
[in,out] | valueDescr | MSValueDescr receiving the item's internal state |
[in] | riP | item to get value of |
StatusInt mdlDialog_rItemStateSet | ( | bool * | stateChangedP, |
RawItemHdrP | riP, | ||
bool | synchOthers | ||
) |
Sets the state information for this item.
[out] | stateChangedP | state changed, ignored if NULL |
[in] | riP | item to set state of |
[in] | synchOthers | synch other items in same dialog |
StatusInt mdlDialog_rItemStringValueGet | ( | WStringR | stringValue, |
RawItemHdrP | riP | ||
) |
Gets the internal value of this item as a string in a WString.
[out] | stringValue | WString receiving the item's internal value |
[in] | riP | item to get value of |
StatusInt mdlDialog_rItemStringValueSet | ( | bool * | valueChangedP, |
WCharCP | stringValueP, | ||
RawItemHdrP | riP | ||
) |
Sets the internal value of this item to a string.
[out] | valueChangedP | new value was different from current |
[in] | stringValueP | item's new Unicode string value |
[in] | riP | item to set value of |
StatusInt mdlDialog_rItemSynch | ( | RawItemHdrP | riP | ) |
Synchronizes this item.
[in] | riP | item to synch |
StatusInt mdlDialog_rItemSynchOthers | ( | RawItemHdrP | riP | ) |
Synchronizes items on dialogs other than the one the item is on.
The synonym list used is the one associated with the given item.
[in] | riP | item whose synonym list is used to synch items on other dialogs |
void mdlDialog_rItemSynchR | ( | RawItemHdrP | riP | ) |
Synchronizes the child items of a given item.
[in] | riP | parent item of the child items to synch |
StatusInt mdlDialog_rItemTHighlightDraw | ( | RawItemHdrP | riP, |
bool | highlightOn, | ||
bool | dashed, | ||
bool | clearWithItemBgColor, | ||
bool | redrawOverlapping | ||
) |
Draws the traversal hilite rectangle on this item.
[in] | riP | item to clear traversal rect of |
[in] | highlightOn | false means clear traversal highlight |
[in] | dashed | true means dashed traversal highlight |
[in] | clearWithItemBgColor | true means use item bgColor to clear highlight |
[in] | redrawOverlapping | when highlightOn=false, redraw overlapped |
RawItemHdr* mdlDialog_rItemTopOwnerItemGet | ( | RawItemHdrP | riP | ) |
Retrieves the pointer to the RawItemHdr of the top most owning dialog item, if any.
[in] | riP | item to get owner from |
StatusInt mdlDialog_rItemValueGet | ( | MSValueDescrR | valueDescr, |
RawItemHdrP | riP | ||
) |
Gets the internal value of this item in an MSValueDescr.
[out] | valueDescr | MSValueDescr receiving the item's internal value |
[in] | riP | item to get value of |
StatusInt mdlDialog_rItemValueSet | ( | bool * | valueChangedP, |
MSValueDescrCR | valueDescr, | ||
RawItemHdrP | riP | ||
) |
Sets the internal value of this item.
[out] | valueChangedP | new value was different from current |
[in] | valueDescr | item's new value |
[in] | riP | item to set value of |