Classes | |
struct | WindowInfo |
WindowInfo maintains low-level information about a Microstation/PowerPlatform desktop-based window, such as next/previous window pointers, the Windows graphics handle, and the screen number. More... | |
struct | BaseWindow |
BaseWindow maintains low-level information about the state of a Microstation/PowerPlatform desktop-based window, such as display/minimized/maximized status, the global and content rectangle, docking position and priority and the title. More... | |
struct | MSWindow |
MSWindow is a base class for Microstation/PowerPlatform desktop-based windows, view windows and dialog boxes. More... | |
struct | guiwattributes |
The flags that control view and window attributes. More... | |
Typedefs | |
typedef struct guiwattributes | GuiWAttributes |
The flags that control view and window attributes. More... | |
Functions | |
GuiWAttributes * | mdlWindow_attributesGet (MSWindowP windowP) |
Retrieves the GuiWAttributes for the Window. More... | |
StatusInt | mdlWindow_changeScreen (MSWindowP windowP, int oldScreen, int newScreen, Point2dCP newGlobalOriginP, Point2dCP newContentExtentP, int leaveAtCurrentPriority) |
Moves the window specified by windowP from the screen indicated by oldScreen to the location specified by newGlobalOriginP (in global coordinates (0, 0) is top left hand corner of screen) on screen newScreen. More... | |
StatusInt | mdlWindow_close (MSWindowP windowP, HideReasonCode reasonCode, bool bypassFocusOut) |
Closes the windows by hiding it then and deallocating it, invalidating windowP for any further mdlWindow_... More... | |
StatusInt | mdlWindow_contentRectGetGlobal (BSIRectP contentRectP, MSWindowP windowP) |
Gets the content rectangle for a window in global coordinates. More... | |
StatusInt | mdlWindow_contentRectGetLocal (BSIRectP contentRectP, MSWindowP windowP) |
Gets the content rectangle for a window in the window's local coordinates. More... | |
void | mdlWindow_cursorTurnOff () |
Turns off the cursor. More... | |
struct msDisplayDescr * | mdlWindow_displayDescrGet (MSWindowP windowP) |
Returns a pointer a display descriptor structure for a window. More... | |
StatusInt | mdlWindow_drawWindowsIcon (MSWindowP windowP, WCharCP icoFileNameP, BSIRectCP imageRectP, BSIRectCP clipRectP, int style) |
Draws a Windows Icon to a window. More... | |
void | mdlWindow_extentSet (MSWindowP windowP, int newWidth, int newHeight) |
Changes the window size specified in windowP. More... | |
void | mdlWindow_findUsableSpace (BSIRectP useRectP, int iScreen, int iPriority) |
Gets a rectangle that represents the usable area of the screen. More... | |
int | mdlWindow_float (MSWindowP windowP) |
Returns a window to its base priority. More... | |
void | mdlWindow_flush (MSWindowP windowP) |
Ensures all graphic output is displayed on the screen. More... | |
int | mdlWindow_getSelectedViewIndex () |
Returns the 0-based index of the selected view window. More... | |
MSWindowP | mdlWindow_getFirst () |
Returns a pointer to the first window in the window list. More... | |
MSWindowP | mdlWindow_getLast () |
Returns a pointer to the last window in the window list. More... | |
MSWindowP | mdlWindow_getNext (MSWindowP windowP) |
Returns a pointer to the next window in the window list, given a certain window pointer. More... | |
MSWindowP | mdlWindow_getPrevious (MSWindowP windowP) |
Returns a pointer to the previous window in the window list, given a certain window pointer. More... | |
int | mdlWindow_getState (void *outBufP, MSWindowP windowP, int paramNum) |
Retrieves different states of a window. More... | |
StatusInt | mdlWindow_globalRectGetGlobal (BSIRectP rP, MSWindowP windowP) |
Gets the global rectangle for windowP in global coordinates. More... | |
StatusInt | mdlWindow_globalRectGetLocal (BSIRectP rP, MSWindowP windowP) |
Gets the global rectangle for windowP in the window's local coordinates. More... | |
void | mdlWindow_globalToContentRect (BSIRectP contentRectP, BSIRectCP globalRectP, int screen, GuiWAttributes const *attributesP) |
Determines what the content rectangle of a window will be when the global rectangle is known. More... | |
StatusInt | mdlWindow_hide (MSWindowP windowP, HideReasonCode reasonCode, bool bypassFocusOut) |
Temporarily hides a window. More... | |
bool | mdlWindow_isDialogBox (MSWindowP windowP) |
Determines whether the designated window is a dialog box. More... | |
bool | mdlWindow_isNETDockable (MSWindowP windowP) |
Determines whether the designated window is has the .NET Dockable attribute. More... | |
bool | mdlWindow_isNETDockableParent (MSWindowP windowP) |
Determines whether the designated window is a .NET Dockable parent window. More... | |
bool | mdlWindow_isView (int *windowID, MSWindowP windowP) |
Determines whether the window specified by windowP is a MicroStation view window. More... | |
bool | mdlWindow_isVisible (MSWindowP windowP) |
Determines whether a window is visible. More... | |
bool | mdlWindow_isMinimized (MSWindowP windowP) |
Determines whether the specified window is minimized. More... | |
bool | mdlWindow_isMaximized (MSWindowP windowP) |
Determines whether the specified window is maximized. More... | |
bool | mdlWindow_isModal (MSWindowP windowP) |
Determines whether the specified window is modal. More... | |
int | mdlWindow_maximize (MSWindowP windowP) |
Increases the size of the indicated window to its largest possible size. More... | |
int | mdlWindow_minimize (MSWindowP windowP) |
Increases the size of the indicated window to its largest possible size. More... | |
void | mdlWindow_pointToGlobal (Point2dP globalPtP, MSWindowP windowP, Point2dCP localPtP) |
Converts a point in local coordinates to a point in the global coordinates for the window specified in windowP. More... | |
void | mdlWindow_screenPointToGlobal (Point2d *globalPtP, MSWindowP windowP, Point2dCP screenPtP) |
Converts a point in screen coordinates to a point in global coordinates for the screen number specified by windowP. More... | |
void | mdlWindow_globalPointToScreen (Point2d *screenPtP, MSWindowP windowP, Point2dCP globalPtP) |
Converts a point in global coordinates to a point in screen coordinates for the screen number specified by windowP. More... | |
void | mdlWindow_pointToLocal (Point2dP localPtP, MSWindowP windowP, Point2dCP globalPtP) |
Converts a point in global coordinates to a point in the local coordinates for the window specified in windowP. More... | |
StatusInt | mdlWindow_resize (MSWindowP windowP, int cornerNum, Point2dCP newPositionP) |
Changes the size of the window specified by windowP. More... | |
StatusInt | mdlWindow_restore (MSWindowP windowP) |
Returns the window to the size and position it occupied before a minimize or maximize operation. More... | |
int | mdlWindow_screenNumGet (MSWindowP windowP) |
Returns the screen number that windowP is on. More... | |
WindowModifyFunc | mdlWindow_setFunction (WindowModifyFunc function) |
Designates a function to be called whenever one of MicroStation's windows is modified. More... | |
StatusInt | mdlWindow_setInputFocus (MSWindowP windowP, int explicitRequest, bool bypassFocusOut) |
Attempts to set the input focus to windowP. More... | |
void | mdlWindow_setFocusToDefault () |
Sets focus to the "default" window. More... | |
StatusInt | mdlWindow_setSystemCursor (SYSTEMCURSOR systemCursor) |
Sets the mouse cursor to one of the system cursors defined in the SYSTEMCURSOR enum. More... | |
StatusInt | mdlWindow_setCursorPrevious () |
Sets the mouse cursor back to the cursor previous to when mdlWindow_setSystemCursor is called. More... | |
StatusInt | mdlWindow_getTransparencyPercentage (int *piPercentage, MSWindowP windowP) |
Gets the transparency percentage level for a window. More... | |
StatusInt | mdlWindow_setTransparencyPercentage (MSWindowP windowP, int iTransparency, bool bAllowComplete) |
Sets the transparency percentage level for a window. More... | |
MSWindowP | mdlWindow_getInputFocus () |
Finds a window which has input focus. More... | |
MSWindowP | mdlWindow_getCurrentPopup () |
Gets a pointer to the current popup window, if one is displayed. More... | |
StatusInt | mdlWindow_show (MSWindowP windowP, bool noInitialUpdate) |
Shows a window, initially or after a hide operation. More... | |
StatusInt | mdlWindow_showBalloonTooltip (WCharCP balloonText, DgnPlatform::OutputMessagePriority messageType, WCharCP titleText, Point2dCP pGlobalPoint, int screenNum, int closeDelay, bool bCloseButton, int iTransparency, RgbColorDefCP pTextColor, RgbColorDefCP pBgColor) |
Displays a Windows-style Balloon Tooltip window with an optional title and Close button. More... | |
StatusInt | mdlWindow_closeBalloonTooltip () |
Closes an open Windows-style Balloon Tooltip window. More... | |
StatusInt | mdlWindow_setBalloonTooltipLinkFunction (MdlDescP tooltipLinkMDP, PFTooltipLink tooltipLinkFuncP) |
Sets up a callback function to call when an anchor () link is clicked in a Balloon Tooltip. More... | |
StatusInt | mdlWindow_sink (MSWindowP windowP) |
Lowers a window's priority from its base to the lowest possible priority. More... | |
StatusInt | mdlWindow_titleCopy (WCharP titleP, int titleChars, MSWindowP windowP) |
Retrieves the window's title specified by windowP into titleP as Unicode. More... | |
StatusInt | mdlWindow_titleGet (WStringR title, MSWindowP windowP) |
Retrieves the window's title specified by windowP into a WString object. More... | |
StatusInt | mdlWindow_titleSet (MSWindowP windowP, WCharCP title) |
Sets the window's title specified by titleP. More... | |
StatusInt | mdlWindow_toBack (MSWindowP windowP) |
Moves the window to the back of its priority grouping. More... | |
StatusInt | mdlWindow_toFront (MSWindowP windowP) |
Moves the window to the front of its priority grouping. More... | |
void | mdlWindow_updateAllWindows (int systemOnly) |
Forces all open views and dialogs to be redrawn. More... | |
void | mdlWindow_updateAllWindowsEx (int systemOnly, bool updateTitleAndIcon) |
Forces all open views and dialogs to be redrawn. More... | |
MSDialog * | mdlWindow_viewWindowGet (int viewNum) |
Retrieves a window pointer for one of MicroStation's views. More... | |
void | mdlWindow_windowEventsProcessAll () |
Forces all outstanding window events to be processed. More... | |
int | mdlWindow_nativeWindowHandleGet (void *nativeHandleP, MSWindowP windowP, int type) |
Returns the native window identifier to the application. More... | |
void | mdlWindow_checkWindowPositionFromScreenEx (MSWindowP windowP, BSIRectP pGlobalRect, bool *pbOffTop, bool *pbOffBottom, bool *pbOffLeft, bool *pbOffRight, int *piPastTop, int *piPastBottom, int *piPastLeft, int *piPastRight) |
Given proposed window bounds in screen coordinates, determines if and by how much the bounds exceed the physical monitor in which the window is located. More... | |
void | mdlWindow_refreshRibbon () |
Refresh the Ribbon by reloading its cached definition from rsc, XML, and Dgnlib files and then reloading the Workflows, Tabs, and Groups in the Ribbon. More... | |
void | mdlWindow_refreshRibbonBackstage () |
Refresh the Ribbon's backstage contents. More... | |
int | mdlWindow_getStackingOrder (MSWindowP *windowPArray, int maxWindows, bool bViewsOnly, int screenNum) |
Returns the stacking order of windows on specified screen. More... | |
typedef struct guiwattributes GuiWAttributes |
The flags that control view and window attributes.
GuiWAttributes* mdlWindow_attributesGet | ( | MSWindowP | windowP | ) |
Retrieves the GuiWAttributes for the Window.
[in] | windowP | window whose GuiWAttributes we're retrieving |
StatusInt mdlWindow_changeScreen | ( | MSWindowP | windowP, |
int | oldScreen, | ||
int | newScreen, | ||
Point2dCP | newGlobalOriginP, | ||
Point2dCP | newContentExtentP, | ||
int | leaveAtCurrentPriority | ||
) |
Moves the window specified by windowP from the screen indicated by oldScreen to the location specified by newGlobalOriginP (in global coordinates (0, 0) is top left hand corner of screen) on screen newScreen.
The screen numbers used are indices into the graphConfig display descriptor table.
[in] | windowP | window to resize |
[in] | oldScreen | old screen number |
[in] | newScreen | new screen number |
[in] | newGlobalOriginP | new global origin |
[in] | newContentExtentP | defines the extents to be used in the dialog box when it is placed on the new screen. If this parameter is NULL, the same extents as are defined for the dialog box on the old screen are used. |
[in] | leaveAtCurrentPriority | is not currently used. |
void mdlWindow_checkWindowPositionFromScreenEx | ( | MSWindowP | windowP, |
BSIRectP | pGlobalRect, | ||
bool * | pbOffTop, | ||
bool * | pbOffBottom, | ||
bool * | pbOffLeft, | ||
bool * | pbOffRight, | ||
int * | piPastTop, | ||
int * | piPastBottom, | ||
int * | piPastLeft, | ||
int * | piPastRight | ||
) |
Given proposed window bounds in screen coordinates, determines if and by how much the bounds exceed the physical monitor in which the window is located.
[in] | windowP | Parent window |
[in] | pGlobalRect | Global rect of proposed window |
[out] | pbOffTop | Above the top |
[out] | pbOffBottom | Below the bottom |
[out] | pbOffLeft | Beyond the left |
[out] | pbOffRight | Beyond the right |
[out] | piPastTop | Amount past top |
[out] | piPastBottom | Amount past bottom |
[out] | piPastLeft | Amount past left |
[out] | piPastRight | Amount past right |
StatusInt mdlWindow_close | ( | MSWindowP | windowP, |
HideReasonCode | reasonCode, | ||
bool | bypassFocusOut | ||
) |
Closes the windows by hiding it then and deallocating it, invalidating windowP for any further mdlWindow_...
operations.
[in] | windowP | window to close |
[in] | reasonCode | A code from the HideReasonCode enum found in dlogitem.h. |
[in] | bypassFocusOut | bypass the focus out |
StatusInt mdlWindow_closeBalloonTooltip | ( | ) |
Closes an open Windows-style Balloon Tooltip window.
StatusInt mdlWindow_contentRectGetGlobal | ( | BSIRectP | contentRectP, |
MSWindowP | windowP | ||
) |
Gets the content rectangle for a window in global coordinates.
[out] | contentRectP | content rect in global coords |
[in] | windowP | window to get content rect for |
StatusInt mdlWindow_contentRectGetLocal | ( | BSIRectP | contentRectP, |
MSWindowP | windowP | ||
) |
Gets the content rectangle for a window in the window's local coordinates.
[out] | contentRectP | content rect in global coords |
[in] | windowP | window to get content rect for |
void mdlWindow_cursorTurnOff | ( | ) |
Turns off the cursor.
This must be done before you begin to draw in a window. You never need to turn the cursor back on, since MicroStation will do this the next time it undergoes its input loop.
struct msDisplayDescr* mdlWindow_displayDescrGet | ( | MSWindowP | windowP | ) |
Returns a pointer a display descriptor structure for a window.
[in] | windowP | window to display discriptor for |
StatusInt mdlWindow_drawWindowsIcon | ( | MSWindowP | windowP, |
WCharCP | icoFileNameP, | ||
BSIRectCP | imageRectP, | ||
BSIRectCP | clipRectP, | ||
int | style | ||
) |
Draws a Windows Icon to a window.
[in] | windowP | window to draw to |
[in] | icoFileNameP | name of the ICO to draw, without the path and the .ICO extension |
[in] | imageRectP | portion of the window to update, in local coordinates |
[in] | clipRectP | clipping rectangle |
[in] | style | One of the ICON_STYLE_ definitions |
void mdlWindow_extentSet | ( | MSWindowP | windowP, |
int | newWidth, | ||
int | newHeight | ||
) |
Changes the window size specified in windowP.
It lets you specify a new width and height for the window in newWidth and newHeight, respectively. Normally, the window resizes by moving its lower right corner. However, if the DIALOGATTR_RESIZESINWARD attribute is used, the appropriate corner will be moved to size the window toward the center of the screen.
[in] | windowP | window to resize |
[in] | newWidth | new window width |
[in] | newHeight | new window height |
void mdlWindow_findUsableSpace | ( | BSIRectP | useRectP, |
int | iScreen, | ||
int | iPriority | ||
) |
Gets a rectangle that represents the usable area of the screen.
[out] | useRectP | points to the usable area rectangle. |
[in] | iScreen | an integer indicating which screen to get the area of. |
[in] | iPriority | an integer indicating the minimum priority of windows to check |
int mdlWindow_float | ( | MSWindowP | windowP | ) |
Returns a window to its base priority.
The window is specified with windowP. Each MicroStation window has an associated base priority. All dialog boxes are grouped into the same priority, and their base priority is higher than the base priority of graphic windows.
[in] | windowP | window to float |
void mdlWindow_flush | ( | MSWindowP | windowP | ) |
Ensures all graphic output is displayed on the screen.
On some platforms, graphic output is buffered, rather than going to the screen immediately. To ensure that the screen is displaying all graphics that were drawn with the mdlWindow calls, the mdlWindow_flush function is used.
[in] | windowP | window to flush. To flush buffers for all windows, windowP can be NULL. |
MSWindowP mdlWindow_getCurrentPopup | ( | ) |
Gets a pointer to the current popup window, if one is displayed.
MSWindowP mdlWindow_getFirst | ( | ) |
Returns a pointer to the first window in the window list.
MSWindowP mdlWindow_getInputFocus | ( | ) |
Finds a window which has input focus.
MSWindowP mdlWindow_getLast | ( | ) |
Returns a pointer to the last window in the window list.
MSWindowP mdlWindow_getNext | ( | MSWindowP | windowP | ) |
Returns a pointer to the next window in the window list, given a certain window pointer.
[in] | windowP | window to get next |
MSWindowP mdlWindow_getPrevious | ( | MSWindowP | windowP | ) |
Returns a pointer to the previous window in the window list, given a certain window pointer.
[in] | windowP | current window |
int mdlWindow_getSelectedViewIndex | ( | ) |
Returns the 0-based index of the selected view window.
Clicking on the title bar of a view window or a data point or tentative point within a view window will select the view.
int mdlWindow_getStackingOrder | ( | MSWindowP * | windowPArray, |
int | maxWindows, | ||
bool | bViewsOnly, | ||
int | screenNum | ||
) |
Returns the stacking order of windows on specified screen.
[in] | windowPArray | list of windows from front to back; set to NULL to return count only |
[in] | maxWindows | max number of entries available in windowPArray |
[in] | bViewsOnly | true = consider view windows only |
[in] | screenNum | screen number |
int mdlWindow_getState | ( | void * | outBufP, |
MSWindowP | windowP, | ||
int | paramNum | ||
) |
Retrieves different states of a window.
[out] | outBufP | the buffer receiving the state of the window |
[in] | windowP | the window to process |
[in] | paramNum | the number of the state to retrieve. See ids beginning with WINDOWGETSTATE_ in MstnDefs.h for valid state numbers. |
StatusInt mdlWindow_getTransparencyPercentage | ( | int * | piPercentage, |
MSWindowP | windowP | ||
) |
Gets the transparency percentage level for a window.
[in] | piPercentage | Receives the transparency percentage level for the window. A value of 0 indicates no transparency (opaque), while a value of 100 indicates complete transparency. |
[in] | windowP | window to get transparency percentage for |
void mdlWindow_globalPointToScreen | ( | Point2d * | screenPtP, |
MSWindowP | windowP, | ||
Point2dCP | globalPtP | ||
) |
Converts a point in global coordinates to a point in screen coordinates for the screen number specified by windowP.
The input point in global coordinates is specified by globalPtP. The output point in screen coordinates is returned in screenPtP. When globalPtP is NULL, mdlWindow_globalPointToScreen converts the output argument in place, using screenPtP as both the input and output.
[in,out] | screenPtP | Point in screen coordinates. |
[in] | windowP | Window to get screen number from. |
[in] | globalPtP | Point in global coordinates. |
StatusInt mdlWindow_globalRectGetGlobal | ( | BSIRectP | rP, |
MSWindowP | windowP | ||
) |
Gets the global rectangle for windowP in global coordinates.
[out] | rP | content rect in global coords |
[in] | windowP | window to get content rect for |
StatusInt mdlWindow_globalRectGetLocal | ( | BSIRectP | rP, |
MSWindowP | windowP | ||
) |
Gets the global rectangle for windowP in the window's local coordinates.
[out] | rP | content rect in global coords |
[in] | windowP | window to get content rect for |
void mdlWindow_globalToContentRect | ( | BSIRectP | contentRectP, |
BSIRectCP | globalRectP, | ||
int | screen, | ||
GuiWAttributes const * | attributesP | ||
) |
Determines what the content rectangle of a window will be when the global rectangle is known.
[out] | contentRectP | points to a BSIRectangle structure that is used to hold the output, which is returned in global coordinates. |
[in] | globalRectP | points to a global rectangle that is used as an input. |
[in] | screen | indicates the screen that the window is on. It should be either 0 or 1. |
[in] | attributesP | points to a GuiWAttribute structure that defines window attributes for the window. The size difference between the global and content rectangles for a window is determined by whether or not the window is resizable, among other things. |
StatusInt mdlWindow_hide | ( | MSWindowP | windowP, |
HideReasonCode | reasonCode, | ||
bool | bypassFocusOut | ||
) |
Temporarily hides a window.
[in] | windowP | window to hide |
[in] | reasonCode | reason code for hiding the window - HideReasonCode found in dlogitem.h. |
[in] | bypassFocusOut | bypass the focus out, usu. false |
bool mdlWindow_isDialogBox | ( | MSWindowP | windowP | ) |
Determines whether the designated window is a dialog box.
[out] | windowP | is the window to test. |
bool mdlWindow_isMaximized | ( | MSWindowP | windowP | ) |
Determines whether the specified window is maximized.
[in] | windowP | points to the window to query. |
bool mdlWindow_isMinimized | ( | MSWindowP | windowP | ) |
Determines whether the specified window is minimized.
[in] | windowP | points to the window to query. |
bool mdlWindow_isModal | ( | MSWindowP | windowP | ) |
Determines whether the specified window is modal.
[in] | windowP | points to the window to query. |
bool mdlWindow_isNETDockable | ( | MSWindowP | windowP | ) |
Determines whether the designated window is has the .NET Dockable attribute.
[out] | windowP | is the window to test. |
bool mdlWindow_isNETDockableParent | ( | MSWindowP | windowP | ) |
Determines whether the designated window is a .NET Dockable parent window.
[out] | windowP | is the window to test. |
bool mdlWindow_isView | ( | int * | windowID, |
MSWindowP | windowP | ||
) |
Determines whether the window specified by windowP is a MicroStation view window.
If the window is a view, and viewIndexP is not NULL, then integer pointed to by viewIndexP is set to the view index (0 through 7).
[out] | windowID | view index |
[in] | windowP | window to test |
bool mdlWindow_isVisible | ( | MSWindowP | windowP | ) |
Determines whether a window is visible.
[in] | windowP | window to test for visibility |
int mdlWindow_maximize | ( | MSWindowP | windowP | ) |
Increases the size of the indicated window to its largest possible size.
Similarly, mdlWindow_minimize decreases the size of the indicated window to its smallest possible size. If a window has been minimized or maximized, mdlWindow_restore returns the window to the size and position it occupied before the size-changing operation.
[in] | windowP | parameter designates the window that is to be minimized, maximized or restored. |
int mdlWindow_minimize | ( | MSWindowP | windowP | ) |
Increases the size of the indicated window to its largest possible size.
Similarly, mdlWindow_minimize decreases the size of the indicated window to its smallest possible size. If a window has been minimized or maximized, mdlWindow_restore returns the window to the size and position it occupied before the size-changing operation.
[in] | windowP | parameter designates the window that is to be minimized, maximized or restored. |
int mdlWindow_nativeWindowHandleGet | ( | void * | nativeHandleP, |
MSWindowP | windowP, | ||
int | type | ||
) |
Returns the native window identifier to the application.
This value is never used as an argument to any MDL built-in function, but some DLMs will be able to use it.
[out] | nativeHandleP | points to memory in the application program that the function will fill in with the native window identifier. The type of handle returned by this function is determined by type as follows: Platform / Value of type / Type of handle returned; MSDOS 0 int; Environ V 0 int Macintosh 0 WindowPtr ; X Window HANDLETYPE_WINDOW HANDLETYPE_DISPLAY HANDLETYPE_XVISUALINFO Window Display * XVisualInfo; Windows NT HANDLETYPE_WINDOW HANDLETYPE_HDC HANDLETYPE_BSHDC HANDLETYPE_BSHBITMAP HWND HDC (onscreen window) HDC (for backstore) HBITMAP (for backstore) |
[in] | windowP | window to get handle for |
[in] | type | type of handle (NT only) |
void mdlWindow_pointToGlobal | ( | Point2dP | globalPtP, |
MSWindowP | windowP, | ||
Point2dCP | localPtP | ||
) |
Converts a point in local coordinates to a point in the global coordinates for the window specified in windowP.
The input point in local coordinates is specified by localPtP. The output point in global coordinates is returned in globalPtP. When localPtP is NULL, mdlWindow_pointToGlobal converts the output argument in place, using globalPtP as both the input and output. mdlWindow_pointToLocal is the inverse function.
[in,out] | globalPtP | Point in global coordinates. |
[in] | windowP | Window to get coords for. |
[in] | localPtP | Point in local coordinates. |
void mdlWindow_pointToLocal | ( | Point2dP | localPtP, |
MSWindowP | windowP, | ||
Point2dCP | globalPtP | ||
) |
Converts a point in global coordinates to a point in the local coordinates for the window specified in windowP.
The input point in global coordinates is specified by globalPtP. The output point in local coordinates is returned in localPtP. When globalPtP is NULL, mdlWindow_pointToLocal converts the output argument in place, using localPtP as both the input and output. mdlWindow_pointToGlobal is the inverse function.
[in,out] | localPtP | Point in local coordinates. |
[in] | windowP | Window to get coords for. |
[in] | globalPtP | Point in global coordinates. |
void mdlWindow_refreshRibbon | ( | ) |
Refresh the Ribbon by reloading its cached definition from rsc, XML, and Dgnlib files and then reloading the Workflows, Tabs, and Groups in the Ribbon.
void mdlWindow_refreshRibbonBackstage | ( | ) |
Refresh the Ribbon's backstage contents.
This does not reload the the ribbon definition cache.
StatusInt mdlWindow_resize | ( | MSWindowP | windowP, |
int | cornerNum, | ||
Point2dCP | newPositionP | ||
) |
Changes the size of the window specified by windowP.
[in] | windowP | window to resize |
[in] | cornerNum | corner to move |
[in] | newPositionP | new postion for corner |
StatusInt mdlWindow_restore | ( | MSWindowP | windowP | ) |
Returns the window to the size and position it occupied before a minimize or maximize operation.
[in] | windowP | parameter designates the window that is to be minimized, maximized or restored. |
int mdlWindow_screenNumGet | ( | MSWindowP | windowP | ) |
Returns the screen number that windowP is on.
[in] | windowP | window to get screen number for |
void mdlWindow_screenPointToGlobal | ( | Point2d * | globalPtP, |
MSWindowP | windowP, | ||
Point2dCP | screenPtP | ||
) |
Converts a point in screen coordinates to a point in global coordinates for the screen number specified by windowP.
The input point in screen coordinates is specified by screenPtP. The output point in global coordinates is returned in globalPtP. When screenPtP is NULL, mdlWindow_screenPointToGlobal converts the output argument in place, using globalPtP as both the input and output.
[in,out] | globalPtP | Point in global coordinates. |
[in] | windowP | Window to get screen number from. |
[in] | screenPtP | Point in screen coordinates. |
StatusInt mdlWindow_setBalloonTooltipLinkFunction | ( | MdlDescP | tooltipLinkMDP, |
PFTooltipLink | tooltipLinkFuncP | ||
) |
Sets up a callback function to call when an anchor () link is clicked in a Balloon Tooltip.
[in] | tooltipLinkMDP | MdlDesc of the call back function. NULL indicates the current task. |
[in] | tooltipLinkFuncP | The function to call |
StatusInt mdlWindow_setCursorPrevious | ( | ) |
Sets the mouse cursor back to the cursor previous to when mdlWindow_setSystemCursor is called.
void mdlWindow_setFocusToDefault | ( | ) |
Sets focus to the "default" window.
WindowModifyFunc mdlWindow_setFunction | ( | WindowModifyFunc | function | ) |
Designates a function to be called whenever one of MicroStation's windows is modified.
A common usage is to detect when a window is made smaller, since in cases where the contents do not need to be resized there is no update event and it is consequently impossible to catch such window size changes.
[in] | function | The functionP parameter designates the function that should be called when the window is modified. If functionP is NULL, modifications are no longer processed by the application. |
StatusInt mdlWindow_setInputFocus | ( | MSWindowP | windowP, |
int | explicitRequest, | ||
bool | bypassFocusOut | ||
) |
Attempts to set the input focus to windowP.
[in] | windowP | window to receive input focus |
[in] | explicitRequest | should always be set to true, because the call will not be in response to a user button event. |
[in] | bypassFocusOut | should only be set to true if the focus is to be changed to the specified window regardless of whether the current focus window wants to relinquish the focus. Dialog boxes, for example, refuse to relinquish the focus if the item focus is set to a text item, and the input currently in the text item is invalid. In general, MDL programs should set this argument to false, to make sure they are cooperative with other applications. |
StatusInt mdlWindow_setSystemCursor | ( | SYSTEMCURSOR | systemCursor | ) |
Sets the mouse cursor to one of the system cursors defined in the SYSTEMCURSOR enum.
[in] | systemCursor | one of the SYSTEMCURSOR enum values. |
StatusInt mdlWindow_setTransparencyPercentage | ( | MSWindowP | windowP, |
int | iTransparency, | ||
bool | bAllowComplete | ||
) |
Sets the transparency percentage level for a window.
[in] | windowP | window to set transparency percentage for |
[in] | iTransparency | transparency percentage level for the window. A value of 0 indicates no transparency (opaque), while a value of 100 indicates complete transparency. |
[in] | bAllowComplete | Indicates whether to allow complete transparency, even if 100% is specified. |
StatusInt mdlWindow_show | ( | MSWindowP | windowP, |
bool | noInitialUpdate | ||
) |
Shows a window, initially or after a hide operation.
[in] | windowP | window |
[in] | noInitialUpdate | for mdlWindow_show inhibits the first refresh message normally sent in a window when it is first displayed. Generally, this argument should be set to false. |
StatusInt mdlWindow_showBalloonTooltip | ( | WCharCP | balloonText, |
DgnPlatform::OutputMessagePriority | messageType, | ||
WCharCP | titleText, | ||
Point2dCP | pGlobalPoint, | ||
int | screenNum, | ||
int | closeDelay, | ||
bool | bCloseButton, | ||
int | iTransparency, | ||
RgbColorDefCP | pTextColor, | ||
RgbColorDefCP | pBgColor | ||
) |
Displays a Windows-style Balloon Tooltip window with an optional title and Close button.
[in] | balloonText | Text for the Balloon Tooltip |
[in] | messageType | Type and icon for message: 0 (no icon), MESSAGE_FO, MESSAGE_WARNG, OutputMessagePriority::Error |
[in] | titleText | Title text for the window; may be NULL for no title or icon |
[in] | pGlobalPoint | Point, in global coords, of pointer for the window |
[in] | screenNum | Number of application screen |
[in] | closeDelay | Time, in milliseconds, to display the window before auto-closing. A value of 0 turns off auto-close. |
[in] | bCloseButton | Indicates whether or not to include a Close button |
[in] | iTransparency | The amount of window transparency; 0 is opaque, 100 is fully transparent |
[in] | pTextColor | RGB value for the text color; specify NULL to use the Windows tooltip default |
[in] | pBgColor | RGB value for the background color; specify NULL to use the Windows tooltip default |
StatusInt mdlWindow_sink | ( | MSWindowP | windowP | ) |
Lowers a window's priority from its base to the lowest possible priority.
Each MicroStation window has an associated base priority. All dialog boxes are grouped into the same priority, and their base priority is higher than the base priority of graphic windows. The mdlWindow_float function returns to its base priority. The window is specified with windowP.
[in] | windowP | window to sink |
StatusInt mdlWindow_titleCopy | ( | WCharP | titleP, |
int | titleChars, | ||
MSWindowP | windowP | ||
) |
Retrieves the window's title specified by windowP into titleP as Unicode.
When retrieving the title, you must specify the number of characters in your string in titleChars.
[out] | titleP | title of window |
[in] | titleChars | size of title output buffer, as number of characters |
[in] | windowP | window to get title for |
StatusInt mdlWindow_titleGet | ( | WStringR | title, |
MSWindowP | windowP | ||
) |
Retrieves the window's title specified by windowP into a WString object.
[out] | title | title of window |
[in] | windowP | window to get title for |
StatusInt mdlWindow_titleSet | ( | MSWindowP | windowP, |
WCharCP | title | ||
) |
Sets the window's title specified by titleP.
[in] | windowP | window to set title for |
[in] | title | Unicode title to set |
StatusInt mdlWindow_toBack | ( | MSWindowP | windowP | ) |
Moves the window to the back of its priority grouping.
[in] | windowP | window to move to back |
StatusInt mdlWindow_toFront | ( | MSWindowP | windowP | ) |
Moves the window to the front of its priority grouping.
[in] | windowP | window to move to front |
void mdlWindow_updateAllWindows | ( | int | systemOnly | ) |
Forces all open views and dialogs to be redrawn.
[in] | systemOnly | is intended for system use and should usually be set to 0. |
void mdlWindow_updateAllWindowsEx | ( | int | systemOnly, |
bool | updateTitleAndIcon | ||
) |
Forces all open views and dialogs to be redrawn.
[in] | systemOnly | is intended for system use and should usually be set to 0. |
[in] | updateTitleAndIcon | is intended for system use and should usually be set to 0. |
MSDialog* mdlWindow_viewWindowGet | ( | int | viewNum | ) |
Retrieves a window pointer for one of MicroStation's views.
viewindex, of the value 0 to DgnPlatform::MAX_VIEWS - 1, inclusive, specifies the MicroStation view. If the specified view is out of range, the function returns NULL. Otherwise, it returns a pointer to the window structure (which may or may not be visible) for the view.
[in] | viewNum | view to get window pointer for |
void mdlWindow_windowEventsProcessAll | ( | ) |
Forces all outstanding window events to be processed.