Functions | |
void | mdlDialog_mlTextGetBasicText (void **bTextPP, RawItemHdr *mlTextP) |
Gets the internal BasicText item from a MSDialog Multi-Line Text item. More... | |
StatusInt | mdlDialog_mlTextGetInfo (int *attributesP, int *displayRowsP, int *labelAboveP, RawItemHdr *mlTextP) |
Gets information on Multi-Line Text items. More... | |
StatusInt | mdlDialog_mlTextSetInfo (int *attributesP, int *displayRowsP, int *labelAboveP, bool redraw, RawItemHdr *mlTextP) |
Sets information on Multi-Line Text items. More... | |
StatusInt | mdlDialog_mlTextSetCursor (RawItemHdr *mlTextP, int lineNumber, UInt32 startCharPos, bool forceVisible) |
Sets the cursor position in a Multi-Line Text item. More... | |
StatusInt | mdlDialog_mlTextGetCursor (int *lineNumberP, UInt32 *startCharPosP, RawItemHdr *mlTextP) |
Retrieves the current cursor position for the Multi-Line Text item specified by mlTextP. More... | |
int | mdlDialog_mlTextTopRowNumber (RawItemHdr *mlTextP, int firstRow) |
Forces the specified row to be the first row in the Text item's display area. More... | |
StatusInt | mdlDialog_mlTextGetLineRange (UInt32 *startCharPosP, UInt32 *endCharPosP, RawItemHdr *mlTextP, int lineNumber) |
Retrieves the byte indices for the beginning and end of a line in the Multi-Line Text item. More... | |
StatusInt | mdlDialog_mlTextInsertString (RawItemHdr *mlTextP, WCharCP stringP, int charsToReplace, int offset) |
Inserts a string at the specified offset. More... | |
StatusInt | mdlDialog_mlTextGetLineCoords (int *lineP, int *offsetP, RawItemHdr *mlTextP, int byteOffset) |
Translates a byte offset into a line number and offset. More... | |
int | mdlDialog_mlTextGetTopRowNumber (RawItemHdr *mlTextP) |
Returns the row number of the first row in the Text item's display area. More... | |
StatusInt | mdlDialog_mlTextGetHighlightRange (int *startPosP, int *endPosP, RawItemHdr *mlTextP) |
Gets the highlight range of a Multi-Line Text dialog item. More... | |
StatusInt | mdlDialog_mlTextSetHighlightRange (UInt32 *startPosP, UInt32 *endPosP, RawItemHdr *mlTextP) |
Sets the highlight range in a Multi-Line Text dialog item. More... | |
void mdlDialog_mlTextGetBasicText | ( | void ** | bTextPP, |
RawItemHdr * | mlTextP | ||
) |
Gets the internal BasicText item from a MSDialog Multi-Line Text item.
[out] | bTextPP | is a memory location that will receive a pointer to the text from the dialog item. |
[in] | mlTextP | is a pointer to the dialog Multi-Line Text item that holds the text. |
StatusInt mdlDialog_mlTextGetCursor | ( | int * | lineNumberP, |
UInt32 * | startCharPosP, | ||
RawItemHdr * | mlTextP | ||
) |
Retrieves the current cursor position for the Multi-Line Text item specified by mlTextP.
[out] | lineNumberP | points to a word that receives the line number for the current cursor position. This line number is a logical line number relative to the start of the text, not relative to the display area. lineNumberP may be NULL. |
[in] | startCharPosP | points to an unsigned long that receives the byte position corresponding to the current cursor position. If lineNumberP is NULL, byte index is relative to the start of the string. If lineNumberP is not NULL, byte index is relative to the start of the line that contains the cursor. startCharPosP may be NULL. |
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item. |
StatusInt mdlDialog_mlTextGetHighlightRange | ( | int * | startPosP, |
int * | endPosP, | ||
RawItemHdr * | mlTextP | ||
) |
Gets the highlight range of a Multi-Line Text dialog item.
[in,out] | startPosP | receives the starting position of the highlight range. This starting position is the character index in the text buffer. |
[in,out] | endPosP | receives the ending position of the highlight range. This ending position is the character index in the text buffer. |
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item |
StatusInt mdlDialog_mlTextGetInfo | ( | int * | attributesP, |
int * | displayRowsP, | ||
int * | labelAboveP, | ||
RawItemHdr * | mlTextP | ||
) |
Gets information on Multi-Line Text items.
For each of the pointer variables below except mlTextP, NULL indicates the information is not desired.
[out] | attributesP | points to a variable indicating the attributes of the Multi-Line Text item. See the discussion of the Multi-Line Text item resource for details. |
[out] | displayRowsP | points to a variable indicating the number of rows of text that may be displayed at one time. |
[out] | labelAboveP | points to a flag indicating whether the label is above the Multi-Line Text item, or to the side. |
[in] | mlTextP | points to the RawItemHdr of the Multi-Line Text item in question. |
StatusInt mdlDialog_mlTextGetLineCoords | ( | int * | lineP, |
int * | offsetP, | ||
RawItemHdr * | mlTextP, | ||
int | byteOffset | ||
) |
Translates a byte offset into a line number and offset.
[out] | lineP | points to an integer than receives the line number of the line that contains the character indexed by byteOffset. lineP may be NULL. |
[out] | offsetP | points to an integer that receive the byte position relative to the start of the line. offsetP may be NULL. |
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item. |
[in] | byteOffset | is an index into the string associated with the Multi-Line Text item. |
StatusInt mdlDialog_mlTextGetLineRange | ( | UInt32 * | startCharPosP, |
UInt32 * | endCharPosP, | ||
RawItemHdr * | mlTextP, | ||
int | lineNumber | ||
) |
Retrieves the byte indices for the beginning and end of a line in the Multi-Line Text item.
[in] | startCharPosP | points to an integer that receives the byte index of the first character displayed on the specified line. |
[in] | endCharPosP | points to an integer that receives the byte index of the last character displayed on the specified line. It is assumed that both startCharPosP and endCharPosP are non-NULL. |
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item. |
[in] | lineNumber | specifies a logical line number. Both *startCharPosP and *endCharPosP will be set to -1 if lineNumber specifies a line beyond the end of the data. |
int mdlDialog_mlTextGetTopRowNumber | ( | RawItemHdr * | mlTextP | ) |
Returns the row number of the first row in the Text item's display area.
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item |
StatusInt mdlDialog_mlTextInsertString | ( | RawItemHdr * | mlTextP, |
WCharCP | stringP, | ||
int | charsToReplace, | ||
int | offset | ||
) |
Inserts a string at the specified offset.
It does not move the cursor or cause the Text item to scroll. mdlDialog_mlTextInsertStringA does display the string.
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item. |
[in] | stringP | points to the string to insert. |
[in] | charsToReplace | specifies the number of characters to replace. It may be 0. |
[in] | offset | is a byte offset that specifies where to insert stringP. |
StatusInt mdlDialog_mlTextSetCursor | ( | RawItemHdr * | mlTextP, |
int | lineNumber, | ||
UInt32 | startCharPos, | ||
bool | forceVisible | ||
) |
Sets the cursor position in a Multi-Line Text item.
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item. |
[in] | lineNumber | specifies the line to position the cursor on. This line number is relative to the start of the string, not to the start of the display area. If lineNumber is -1, it is ignored. |
[in] | startCharPos | specifies the byte index of the new cursor position. It is relative to the start of the line specified by lineNumber. If lineNumber is -1, it is relative to the start of the text. |
[in] | forceVisible | If forceVisible is non-zero and the cursor is positioned to an area that is not displayed, then MicroStation scrolls the text so that the cursor position is visible. |
StatusInt mdlDialog_mlTextSetHighlightRange | ( | UInt32 * | startPosP, |
UInt32 * | endPosP, | ||
RawItemHdr * | mlTextP | ||
) |
Sets the highlight range in a Multi-Line Text dialog item.
[in] | startPosP | points to the starting position of the new highlight range. This starting position is the character index in the text buffer. |
[in] | endPosP | points to the ending position of the new highlight range. This ending position is the character index in the text buffer. |
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item |
StatusInt mdlDialog_mlTextSetInfo | ( | int * | attributesP, |
int * | displayRowsP, | ||
int * | labelAboveP, | ||
bool | redraw, | ||
RawItemHdr * | mlTextP | ||
) |
Sets information on Multi-Line Text items.
For each of the pointer variables below except mlTextP, NULL indicates the information is not to be changed.
[in] | attributesP | points to a variable indicating the attributes of the Multi-Line Text item. See the discussion of the Multi-Line Text item resource for details. |
[in] | displayRowsP | points to a variable indicating the number of rows of text that may be displayed at one time. |
[in] | labelAboveP | points to a flag indicating whether the label is above the Multi-Line Text item, or to the side. |
[in] | redraw | If redraw is true, the Multi-Line Text item is redrawn after mdlDialog_mlTextSetInfo is finished. |
[in] | mlTextP | points to the RawItemHdr of the Multi-Line Text item in question. |
int mdlDialog_mlTextTopRowNumber | ( | RawItemHdr * | mlTextP, |
int | firstRow | ||
) |
Forces the specified row to be the first row in the Text item's display area.
[in] | mlTextP | points to the RawItemHdr for the Multi-Line Text item. |
[in] | firstRow | is a row number relative to the start of text string being processed by the Text item. |