rtAllocRequest()
Synopsis
APTR rtAllocRequest(
ULONG type,
Tag tag1,
...)
Function
Allocate and initialize a ReqTools requester structure.
Result
Initialized requester structure, or NULL if allocation fails.
Notes
No allocation tags are currently defined. Release the structure
with rtFreeRequest().
rtChangeReqAttr()
Synopsis
LONG rtChangeReqAttr(
APTR req,
Tag tag1,
...)
Function
Change the attributes of an existing requester.
Result
Return value from rtChangeReqAttrA(). It is meaningful for tags
that explicitly define a result, including RTFI_AddEntry.
Notes
Attribute applicability, ordering constraints, and tag-specific
results are defined by rtChangeReqAttrA().
rtEZRequest()
Synopsis
ULONG rtEZRequest(
const char *bodyfmt,
const char *gadfmt,
struct rtReqInfo *reqinfo,
struct TagItem *taglist,
...)
Function
Display a formatted requester and obtain a user response.
Result
Response code from rtEZRequestA(); the rightmost choice returns
zero. Other choices return their assigned positive values, or
an IDCMP value may be returned.
Notes
Formatting uses RawDoFmt conventions. This wrapper counts percent
conversions in both format strings to collect formatting arguments;
'%%' is treated as a literal percent sign.
Bugs
If allocation of the temporary argument array fails, the wrapper
writes through the NULL pointer when formatting arguments exist.
rtFileRequest()
Synopsis
APTR rtFileRequest(
struct rtFileRequester * filereq,
char *file,
const char *title,
Tag tag1,
...)
Function
Request a filename, directory, or multiple file selections.
Result
Result from rtFileRequestA(): nonzero for an accepted single
selection, zero on cancellation, or an rtFileList pointer when
multiple selection is enabled.
Notes
The file list returned for multiple selection is released with
rtFreeFileList(). The requester requires a process with DOS access.
rtFontRequest()
Synopsis
ULONG rtFontRequest(
struct rtFontRequester *fontreq,
const char *title,
Tag tag1,
...)
Function
Request a font and optional font style.
Result
Nonzero when a font is selected; zero on cancellation.
Notes
The selected font attributes are stored in the requester.
This requester may use DOS and must be called from a process.
rtGetLong()
Synopsis
ULONG rtGetLong(
ULONG *longptr,
char *title,
struct rtReqInfo *reqinfo,
Tag tag1,
...)
Function
Request a signed 32-bit integer.
Result
Response code from rtGetLongA().
Notes
An empty numeric field can cause the leftmost gadget to return
zero without changing *longptr. See rtGetLongA() for the
complete response and validation contract.
rtGetString()
Synopsis
ULONG rtGetString(
UBYTE *buffer,
ULONG maxchars,
const char *title,
struct rtReqInfo *reqinfo,
Tag tag1,
...)
Function
Request a line of text.
Result
Response code from rtGetStringA().
Notes
The destination must accommodate maxchars characters and the
terminating NUL. Empty-input behavior depends on RTGS_AllowEmpty;
see rtGetStringA().
rtPaletteRequest()
Synopsis
LONG rtPaletteRequest(
const char *title,
struct rtReqInfo *reqinfo,
Tag tag1,
...)
Function
Display a requester for editing or choosing a screen color.
Result
Selected palette index, or -1 on cancellation.
Notes
The requester changes colors in the selected screen's viewport.
rtReqHandler()
Synopsis
IPTR rtReqHandler(
struct rtHandlerInfo *handlerinfo,
ULONG sigs,
Tag tag1,
...)
Function
Continue processing a requester started with RT_ReqHandler.
Result
CALL_HANDLER while additional handling is required; otherwise
the requester's normal completion result.
Notes
Check handlerinfo->DoNotWait and handlerinfo->WaitMask before
waiting for signals. Continue calling this function while it
returns CALL_HANDLER.
rtScreenModeRequest()
Synopsis
ULONG rtScreenModeRequest(
struct rtScreenModeRequester *screenmodereq,
char *title,
Tag tag1,
...)
Function
Request a screen mode and its display parameters.
Result
Nonzero when the user accepts the selection; zero on cancellation.
Notes
The chosen display mode, dimensions, and depth are stored in
the requester structure.
Docutils System Messages
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 67); backlink
Unknown target name: "rtallocrequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 67); backlink
Unknown target name: "rtfreerequest()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 119); backlink
Unknown target name: "rtchangereqattra()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 186); backlink
Unknown target name: "rtezrequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 243); backlink
Unknown target name: "rtezrequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 301); backlink
Unknown target name: "rtfilerequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 301); backlink
Unknown target name: "rtfreefilelist()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 354); backlink
Unknown target name: "rtfontrequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 410); backlink
Unknown target name: "rtgetlonga()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 468); backlink
Unknown target name: "rtgetstringa()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 520); backlink
Unknown target name: "rtpaletterequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 575); backlink
Unknown target name: "rtreqhandlera()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 575); backlink
Unknown target name: "rtezrequesta()".
System Message: ERROR/3 (/home/runner/work/1/b/documentation/web/documentation/developers/autodocs/reqtools-stubs.en.rst, line 629); backlink
Unknown target name: "rtscreenmoderequesta()".