Functions
TabPageList Item

Functions

DialogItemmdlDialog_tabPageListGetPageById (RawItemHdr *tPListRiP, long tabPageId, int startingIndex)
 Gets a pointer to the requested TabPage item with the given ID. More...
 
DialogItemmdlDialog_tabPageListGetPageByIndex (RawItemHdr *tPListRiP, int index)
 Gets a pointer to the requested TabPage item with the given index within the TabPageList. More...
 
StatusInt mdlDialog_tabPageListGetInfo (int *numPagesP, int *firstPageIndexP, int *lastPageIndexP, CommandNumber *commandNumberP, UInt32 *commandSourceP, UInt32 *attributesP, RawItemHdr *tPListRiP)
 Retrieves information about a specific TabPageList. More...
 
StatusInt mdlDialog_tabPageListSetInfo (RawItemHdr *tPListRiP, CommandNumber *commandNumberP, UInt32 *commandSourceP, UInt32 *attributesP, bool redraw)
 Sets various options and attributes in a TabPageList. More...
 
StatusInt mdlDialog_tabPageListFreePages (RawItemHdr *tPListRiP, int startPageIndex, int maxPageIndex)
 Frees the specified pages from a TabPageList. More...
 
StatusInt mdlDialog_tabPageListLoadPages (RawItemHdr *tPListRiP, DialogItemListRsc *dilRP, RscFileHandle rFileH, MdlDesc *ownerMD, int beforePageIndex)
 Inserts pages into a TabPageList. More...
 
StatusInt mdlDialog_tabPageListSetButtonWidth (RawItemHdr *tPListRiP, int buttonWidth)
 Sets the width of the TabPage buttons in the specified TabPageList dialog item. More...
 
StatusInt mdlDialog_tabPageGetInfo (int *numItemsP, int *firstItemIndexP, int *lastItemIndexP, CommandNumber *commandNumberP, UInt32 *commandSourceP, RscType *iconTypeP, RscId *iconIdP, UInt32 *attributesP, RawItemHdr *tPageRiP)
 Retrieves information about a specific TabPage. More...
 
StatusInt mdlDialog_tabPageSetInfo (RawItemHdr *tPageRiP, CommandNumber *commandNumberP, UInt32 *commandSourceP, RscType *iconTypeP, RscId *iconIdP, UInt32 *attributesP, bool redraw)
 Sets various options in the TabPage. More...
 
DialogItemmdlDialog_tabPageGetItemByTypeAndId (RawItemHdr *tPageRiP, long type, long id)
 Gets a pointer to the requested dialog item with the given type and ID. More...
 
DialogItemmdlDialog_tabPageGetItemByIndex (RawItemHdr *tPageRiP, int index)
 Gets a pointer to the requested dialog item with the given index within the TabPage. More...
 
StatusInt mdlDialog_tabPageMoveItems (RawItemHdr *tPageRiP, Point2d *fromPtP, Point2d *toPtP, bool redraw)
 Moves all of the items contained within the specified TabPage from one location to another. More...
 
StatusInt mdlDialog_tabPageFreeItems (RawItemHdr *tPageRiP, int startItemIndex, int maxItemIndex)
 Free the specified items from the TabPage. More...
 
StatusInt mdlDialog_tabPageLoadItems (RawItemHdr *tPageRiP, DialogItemListRsc *dilRP, RscFileHandle rFileH, MdlDescP ownerMD, int beforeItemIndex, Point2dP originP, bool drawItems)
 Inserts pages into a TabPage. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_tabPageFreeItems ( RawItemHdr tPageRiP,
int  startItemIndex,
int  maxItemIndex 
)

Free the specified items from the TabPage.

Parameters
[in]tPageRiPpoints to the RawItemHdr of the TabPage to process.
[in]startItemIndexindicates the index of the first item to free from the page.
[in]maxItemIndexindicates the index of the last item to free.
Returns
SUCCESS, or a non-zero value if error occurs.
See also
mdlDialog_tabPageLoadItems
StatusInt mdlDialog_tabPageGetInfo ( int *  numItemsP,
int *  firstItemIndexP,
int *  lastItemIndexP,
CommandNumber *  commandNumberP,
UInt32 commandSourceP,
RscType iconTypeP,
RscId iconIdP,
UInt32 attributesP,
RawItemHdr tPageRiP 
)

Retrieves information about a specific TabPage.

Parameters
[out]numItemsPpoints to a variable to receive the number of items on the TabPage.
[out]firstItemIndexPpoints to a variable to receive the index of first item on page.
[out]lastItemIndexPpoints to a variable to receive the index of last item on page.
[out]commandNumberPset NULL if don't want cmd number
[out]commandSourcePset NULL if don't want cmd source
[out]iconTypePpoints to a variable to receive the type of icon on the tab.
[out]iconIdPpoints to a variable to receive the Id of the icon on the tab.
[out]attributesPpoints to a variable to receive the attributes of this page (not currently used).
[in]tPageRiPpoints to the RawItemHdr of the TabPage to process.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_tabPageSetInfo
DialogItem* mdlDialog_tabPageGetItemByIndex ( RawItemHdr tPageRiP,
int  index 
)

Gets a pointer to the requested dialog item with the given index within the TabPage.

Parameters
[in]tPageRiPpoints to the RawItemHdr of the TabPage to search.
[in]indexcontains the index, within the TabPage, of the dialog item to search for.
Returns
A pointer to a DialogItem structure, or NULL if the specified item is not found.
See also
mdlDialog_tabPageGetItemByTypeAndId
DialogItem* mdlDialog_tabPageGetItemByTypeAndId ( RawItemHdr tPageRiP,
long  type,
long  id 
)

Gets a pointer to the requested dialog item with the given type and ID.

Parameters
[in]tPageRiPpoints to the RawItemHdr of the TabPage to search.
[in]typeis the type of the dialog item to search for.
[in]idis the ID of the dialog item to search for.
Returns
A pointer to a DialogItem structure, or NULL if the specified item is not found.
See also
mdlDialog_tabPageGetItemByIndex
StatusInt mdlDialog_tabPageListFreePages ( RawItemHdr tPListRiP,
int  startPageIndex,
int  maxPageIndex 
)

Frees the specified pages from a TabPageList.

Parameters
[in]tPListRiPpoints to the RawItemHdr of the TabPageList to process.
[in]startPageIndexindicates the index of the first page within the list to free.
[in]maxPageIndexindicates the index of the last page to free.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_tabPageListLoadPages
StatusInt mdlDialog_tabPageListGetInfo ( int *  numPagesP,
int *  firstPageIndexP,
int *  lastPageIndexP,
CommandNumber *  commandNumberP,
UInt32 commandSourceP,
UInt32 attributesP,
RawItemHdr tPListRiP 
)

Retrieves information about a specific TabPageList.

Parameters
[out]numPagesPpoints to a variable to receive number of pages in the TabPageList.
[out]firstPageIndexPpoints to a variable to receive index of the first page in the list.
[out]lastPageIndexPpoints to a variable to receive index of the last page in the list.
[out]commandNumberPset NULL if don't want cmd number
[out]commandSourcePset NULL if don't want cmd source
[out]attributesPpoints to a variable to receive the attributes of this list, such as TABATTR_DEFAULT, TABATTR_TABSBOTTOM and TABATTR_MULTIROW.
[in]tPListRiPpoints to the RawItemHdr of the TabPageList to process.
Returns
SUCCESS, or a non-zero value if an error occurs
See also
mdlDialog_tabPageListSetInfo
DialogItem* mdlDialog_tabPageListGetPageById ( RawItemHdr tPListRiP,
long  tabPageId,
int  startingIndex 
)

Gets a pointer to the requested TabPage item with the given ID.

Parameters
[in]tPListRiPpoints to the RawItemHdr of the TabPageList to process.
[in]tabPageIdspecifies the ID of the TabPage to get.
[in]startingIndexindicates where to start looking for page within the TabPageList.
Returns
A pointer to a DialogItem structure, or NULL if the specified page is not found.
See also
mdlDialog_tabPageGetItemByIndex
DialogItem* mdlDialog_tabPageListGetPageByIndex ( RawItemHdr tPListRiP,
int  index 
)

Gets a pointer to the requested TabPage item with the given index within the TabPageList.

Parameters
[in]tPListRiPpoints to the RawItemHdr of the TabPageList to process.
[in]indexspecifies the index, within the TabPageList, of the tab page to retrieve.
Returns
A pointer to a DialogItem structure, or NULL if the specified page is not found.
See also
mdlDialog_tabPageListGetPageById
StatusInt mdlDialog_tabPageListLoadPages ( RawItemHdr tPListRiP,
DialogItemListRsc dilRP,
RscFileHandle  rFileH,
MdlDesc ownerMD,
int  beforePageIndex 
)

Inserts pages into a TabPageList.

Parameters
[in]tPListRiPpoints to the RawItemHdr of the TabPageList to process.
[in]dilRPpoints to a DialogItemListRsc structure that specifies the pages to load. A DialogItemListRsc structure (defined in dlogbox.r.h) contains the number of pages to load and an array of DialogItemRsc structures.
[in]rFileHspecifies the resource file to search for the TabPage item resources. If NULL is specified, all the calling application's open resource files will be searched, followed by MicroStation's open resource files.
[in]ownerMDshould be set to NULL.
[in]beforePageIndexspecifies the index of the page before which the new pages will be loaded. Specify -1 to indicate that the pages should be appended at the end of the TabPageList.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_tabPageListFreePages mdlResource_load
StatusInt mdlDialog_tabPageListSetButtonWidth ( RawItemHdr tPListRiP,
int  buttonWidth 
)

Sets the width of the TabPage buttons in the specified TabPageList dialog item.

Parameters
[in]tPListRiPpoints to the TabPage item to process.
[in]buttonWidthis the desired width of the of TabPage buttons in dcoords.
Returns
SUCCESS, or a non-zero value if an error occurs.
StatusInt mdlDialog_tabPageListSetInfo ( RawItemHdr tPListRiP,
CommandNumber *  commandNumberP,
UInt32 commandSourceP,
UInt32 attributesP,
bool  redraw 
)

Sets various options and attributes in a TabPageList.

Parameters
[in]tPListRiPpoints to the RawItemHdr of the TabPageList to process.
[in]commandNumberPset NULL if not setting cmd number
[in]commandSourcePset NULL if not setting cmd source
[in]attributesPpoints to a variable containing the new attributes for this list. The variable is constructed by combining the constants from the TabPageList attributes table.
[in]redrawIf redraw is true, the TabPage display area, including tabs and TabPage items, will be redrawn after the attributes are set.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_tabPageListGetPageById
StatusInt mdlDialog_tabPageLoadItems ( RawItemHdr tPageRiP,
DialogItemListRsc dilRP,
RscFileHandle  rFileH,
MdlDescP  ownerMD,
int  beforeItemIndex,
Point2dP  originP,
bool  drawItems 
)

Inserts pages into a TabPage.

Parameters
[in]tPageRiPpoints to the RawItemHdr of the TabPage to process.
[in]dilRPpoints to a DialogItemListRsc structure that specifies the items to load. A DialogItemListRsc structure (defined in dlogbox.r.h) contains the number of items to load and an array of DialogItemRsc structures.
[in]rFileHspecifies the resource file to search for the dialog item resources. If NULL, all the calling application's open resource files will be searched, followed by MicroStation's open resource files.
[in]ownerMDshould be set to NULL.
[in]beforeItemIndexspecifies the index of the item before which the new items will be loaded. Specify -1 to indicate that the items should be appended to the end of the TabPage's item list.
[in]originPspecifies the origin used when loading the dialog items. If units of the point are greater than 0, they will be interpreted as dialog coordinate units; otherwise, they will be interpreted as pixel units. NULL sets the origin at (0, 0), the upper left corner of the TabPage display area.
[in]drawItemstrue means draw items after loading
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_tabPageFreeItems mdlResource_load
StatusInt mdlDialog_tabPageMoveItems ( RawItemHdr tPageRiP,
Point2d *  fromPtP,
Point2d *  toPtP,
bool  redraw 
)

Moves all of the items contained within the specified TabPage from one location to another.

Parameters
[in]tPageRiPpoints to the TabPage dialog containing the items to move.
[in]fromPtPis a location within the TabPage in dcoords that the items are moving from.
[in]toPtPis the location within the TabPage that the items are moving to.
[in]redrawindicates whether the items should be redraw after moving.
Returns
SUCCESS, or a non-zero value if an error occurs.
StatusInt mdlDialog_tabPageSetInfo ( RawItemHdr tPageRiP,
CommandNumber *  commandNumberP,
UInt32 commandSourceP,
RscType iconTypeP,
RscId iconIdP,
UInt32 attributesP,
bool  redraw 
)

Sets various options in the TabPage.

Parameters
[in]tPageRiPpoints to the RawItemHdr of the TabPage.
[in]commandNumberPset NULL if not setting cmd number
[in]commandSourcePset NULL if not setting cmd source
[in]iconTypePpoints to a variable containing the updated type of the icon on tab.
[in]iconIdPpoints to a variable containing the updated ID of the icon on the tab.
[in]attributesPis not currently used. Set this to NULL.
[in]redrawIf redraw is true, the TabPage display area, including tabs and TabPage items, will be redrawn after the options are set.
Returns
SUCCESS, or a non-zero value if an error occurs.
See also
mdlDialog_tabPageListGetInfo

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.