Initial import of the CDE 2.1.30 sources from the Open Group.
This commit is contained in:
Peter Howkins
254
cde/doc/C/guides/man/m3_Dt/ActionCa.sgm
Normal file
254
cde/doc/C/guides/man/m3_Dt/ActionCa.sgm
Normal file
@@ -0,0 +1,254 @@
|
||||
<!-- $XConsortium: ActionCa.sgm /main/10 1996/09/08 20:02:03 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN8.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN8.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtActionCallbackProc</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><StructName Role="typedef">DtActionCallbackProc</StructName></RefName>
|
||||
<RefPurpose>notify application that the status of an application has changed
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<Synopsis>#include <Dt/Action.h>
|
||||
</Synopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Filename Role="Header">Dt/Action.h</Filename> header defines the
|
||||
<Function>DtActionCallbackProc</Function> callback prototype as follows:
|
||||
</Para>
|
||||
<Synopsis>typedef void (*DtActionCallbackProc)(DtActionInvocationID <Emphasis>id</Emphasis>,
|
||||
XtPointer <Symbol Role="Variable">client_data</Symbol>,
|
||||
DtActionArg *<Symbol Role="Variable">args</Symbol>,
|
||||
int <Emphasis>argCount</Emphasis>,
|
||||
DtActionStatus <Symbol Role="Variable">status</Symbol>);
|
||||
</Synopsis>
|
||||
<Para>If registered when invoking an action with
|
||||
&cdeman.DtActionInvoke;, a
|
||||
<Function>DtActionCallbackProc</Function> procedure is called
|
||||
whenever an action has a status update, such as action termination.
|
||||
Depending on
|
||||
<Symbol Role="Variable">status</Symbol>, modified action arguments may be returned using
|
||||
<Symbol Role="Variable">args</Symbol>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>id</Emphasis> argument specifies an invocation ID as returned by
|
||||
&cdeman.DtActionInvoke;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">client_data</Symbol> argument specifies the client data that was
|
||||
registered with
|
||||
&cdeman.DtActionInvoke;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">args</Symbol> argument is an array of updated action argument structures, if there are any.
|
||||
Individual arguments have their
|
||||
<Emphasis>argClass</Emphasis> set to one of the standard argument classes, or
|
||||
<SystemItem Class="Constant">DtACTION_NULLARG</SystemItem>, to indicate that the current
|
||||
status update is not providing an update for the given argument.
|
||||
If the object has been removed (for example, dropped on the trash), the
|
||||
return
|
||||
<Emphasis>argClass</Emphasis> is set to
|
||||
<SystemItem Class="Constant">DtACTION_NULLARG</SystemItem> to indicate that it no longer exists.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">args</Symbol> array has been allocated by
|
||||
<Function>XtMalloc</Function>(3), as have any of the
|
||||
<StructName Role="typedef">char*</StructName> or
|
||||
<StructName Role="typedef">void*</StructName> elements contained in each of the
|
||||
<Symbol Role="Variable">args</Symbol>. The application is responsible for calling
|
||||
<Function>XtFree</Function>(3) on all elements contained in each of the
|
||||
<Symbol Role="Variable">args</Symbol>, and then calling
|
||||
<Function>XtFree</Function>(3) on
|
||||
<Symbol Role="Variable">args</Symbol>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>argCount</Emphasis> argument specifies the total number of arguments
|
||||
in
|
||||
<Symbol Role="Variable">args</Symbol>. This number equals the number of arguments originally provided to
|
||||
&cdeman.DtActionInvoke;</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">n</Symbol>th argument in the original action
|
||||
argument array corresponds to the
|
||||
<Symbol Role="Variable">n</Symbol>th argument in an updated action argument array.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">status</Symbol> argument specifies the purpose of the status update.
|
||||
The status codes listed here and in
|
||||
&cdeman.Dt.Action.h;, may be returned in a
|
||||
<Function>DtActionCallbackProc</Function>:</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtACTION_INVOKED</Term>
|
||||
<ListItem>
|
||||
<Para>The corresponding
|
||||
&cdeman.DtActionInvoke; which is asynchronous and does not block when starting actions,
|
||||
has finished starting the requested actions.
|
||||
For all
|
||||
&cdeman.DtActionInvoke; calls that include a
|
||||
<Function>DtactionCallbackProc</Function>, this status code is guaranteed to be returned.
|
||||
When returned, no additional prompts for data will appear
|
||||
from the action service.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtACTION_DONE</Term>
|
||||
<ListItem>
|
||||
<Para>The actions that were the result of the original
|
||||
&cdeman.DtActionInvoke; call have terminated normally.
|
||||
Once this status value is returned, all registered callbacks are invalidated,
|
||||
and
|
||||
<Emphasis>id</Emphasis> can no longer be used in subsequent action service calls.
|
||||
Returned
|
||||
<Symbol Role="Variable">args</Symbol> data may accompany the
|
||||
<SystemItem Class="Constant">DtACTION_DONE</SystemItem> status code.
|
||||
For all
|
||||
&cdeman.DtActionInvoke; calls that include a
|
||||
<Function>DtActionCallbackProc</Function>, this status code or an equivalent status code (for example,
|
||||
<SystemItem Class="Constant">DtACTION_CANCELED</SystemItem> or
|
||||
<SystemItem Class="Constant">DtACTION_FAILED</SystemItem>) is guaranteed to be returned.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtACTION_CANCELED</Term>
|
||||
<ListItem>
|
||||
<Para>The actions that were the result of the original
|
||||
&cdeman.DtActionInvoke; call were canceled and have terminated normally.
|
||||
Once this status value is returned, all registered callbacks are
|
||||
invalidated, and
|
||||
<Emphasis>id</Emphasis> can no longer be used in subsequent
|
||||
action service calls.
|
||||
No
|
||||
<Symbol Role="Variable">args</Symbol> data will accompany the
|
||||
<SystemItem Class="Constant">DtACTION_CANCELED</SystemItem> status code.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtACTION_FAILED</Term>
|
||||
<ListItem>
|
||||
<Para>An error occured and a normal termination is no longer possible.
|
||||
The action service may have failed to start the
|
||||
action or lost contact with and abandoned the action.
|
||||
Once this status value is returned, an error dialog may be
|
||||
posted by the action service, all registered callbacks are
|
||||
invalidated, and
|
||||
<Emphasis>id</Emphasis> can no longer be used in subsequent action service calls.
|
||||
No
|
||||
<Symbol Role="Variable">args</Symbol> data will accompany the
|
||||
<SystemItem Class="Constant">DtACTION_FAILED</SystemItem> status code.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtACTION_STATUS_UPDATE</Term>
|
||||
<ListItem>
|
||||
<Para>The actions associated with
|
||||
<Emphasis>id</Emphasis> have generated a status update, such as returning modified
|
||||
<Symbol Role="Variable">args</Symbol>. Updates occur in several ways.
|
||||
</Para>
|
||||
<Para>If several actions were started from a single
|
||||
&cdeman.DtActionInvoke;, then as each individual action terminates, a
|
||||
<SystemItem Class="Constant">DtACTION_STATUS_UPDATE</SystemItem> with return
|
||||
<Symbol Role="Variable">args</Symbol> is returned, and when the final action
|
||||
terminates, a
|
||||
<SystemItem Class="Constant">DtACTION_DONE</SystemItem> or equivalent status code is returned, possibly with return arguments.
|
||||
</Para>
|
||||
<Para>Other actions may have the capability to generate updates
|
||||
(for example, Tooltalk-based actions doing a Media Exchange
|
||||
Deposit (Request)).
|
||||
</Para>
|
||||
<Para>In most cases, a
|
||||
<StructName Role="typedef">DtActionArg</StructName> argument array accompanying a
|
||||
<SystemItem Class="Constant">DtACTION_STATUS_UPDATE</SystemItem> only has updated data for a few of the arguments; the remaining arguments
|
||||
are set to
|
||||
<SystemItem Class="Constant">DtACTION_NULLARG</SystemItem>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following shows how a
|
||||
<Function>DtActionCallbackProc</Function> might be coded.
|
||||
</Para>
|
||||
<InformalExample>
|
||||
<ProgramListing>DtActionCallbackProc myCallback(
|
||||
DtActionInvocationID id,
|
||||
XtPointer client_data,
|
||||
DtActionArg *actionArgPtr,
|
||||
int actionArgCount,
|
||||
DtActionStatus status);
|
||||
{
|
||||
extern DtActionArg *myUpdatedArgs; /* global hook for new data */
|
||||
extern int myDoneFlag; /* global done flag */
|
||||
switch (status) {
|
||||
case DtACTION_INVOKED:
|
||||
/*
|
||||
* All the arguments to the original DtActionInvoke
|
||||
* have been consumed by actions, and the actions have
|
||||
* been started. Among other things, we will not see
|
||||
* any more prompts for user input.
|
||||
*/
|
||||
break;
|
||||
case DtACTION_DONE:
|
||||
myUpdatedArgs = (DtActionArg *) actionArgPtr;
|
||||
myDoneFlag = TRUE;
|
||||
break;
|
||||
case DtACTION_CANCELED:
|
||||
case DtACTION_FAILED:
|
||||
if ((actionArgCount != 0) && actionArgPtr) {
|
||||
/*
|
||||
* If not a normal shutdown, throw away returned
|
||||
* information.
|
||||
*/
|
||||
for (i=0; i < actionArgCount; i++) {
|
||||
if (actionArgPtr[i].argClass == DtACTION_FILE) {
|
||||
XtFree(actionArgPtr[i].u.file.name);
|
||||
} else if (actionArgPtr[i].argClass ==
|
||||
DtACTION_BUFFER) {
|
||||
XtFree(actionArgPtr[i].u.buffer.bp);
|
||||
XtFree(actionArgPtr[i].u.buffer.type);
|
||||
XtFree(actionArgPtr[i].u.buffer.name);
|
||||
}
|
||||
}
|
||||
XtFree(actionArgPtr);
|
||||
}
|
||||
myUpdatedArgs = (DtActionArg *) NULL;
|
||||
myDoneFlag = FALSE;
|
||||
break;
|
||||
case DtACTION_STATUS_UPDATE:
|
||||
myUpdatedArgs = (DtActionArg *) actionArgPtr;
|
||||
myDoneFlag = FALSE;
|
||||
break;
|
||||
default:
|
||||
/* ignore */
|
||||
break;
|
||||
}
|
||||
}
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, &cdeman.DtDbLoad;, &cdeman.DtActionLabel;, &cdeman.DtActionDescription;, &cdeman.DtActionExists;, &cdeman.DtActionInvoke;, <![ %CDE.C.CDE; [<Function>XtMalloc</Function>(3), <Function>XtFree</Function>(3), &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<Function>XtMalloc</Function>(3), <Function>XtFree</Function>(3) in the &str-Zt;;
|
||||
<XRef Linkend="XCDI.ACTI.anch.3" Role="2">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
75
cde/doc/C/guides/man/m3_Dt/ActionDe.sgm
Normal file
75
cde/doc/C/guides/man/m3_Dt/ActionDe.sgm
Normal file
@@ -0,0 +1,75 @@
|
||||
<!-- $XConsortium: ActionDe.sgm /main/6 1996/08/30 12:53:02 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN9.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN9.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtActionDescription</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtActionDescription</Function></RefName>
|
||||
<RefPurpose>obtain the descriptive text for a given action
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Action.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>char <Function>*DtActionDescription</Function></FuncDef>
|
||||
<ParamDef>char *<Parameter>actionName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtActionDescription</Function> function looks up and returns the descriptive text associated
|
||||
with the
|
||||
<Emphasis>actionName</Emphasis> action.
|
||||
The
|
||||
<Emphasis>actionName</Emphasis> argument is the name of the action.
|
||||
If there are multiple
|
||||
<Emphasis>actionName</Emphasis> actions,
|
||||
the string returned is the description of the most general.
|
||||
The most general action is the one with the lowest precedence,
|
||||
as described in
|
||||
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
|
||||
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtActionDescription</Function> function returns a newly allocated copy of the description string
|
||||
associated with the action; otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The
|
||||
<Function>DtActionDescription</Function> function is useful for applications that wish to present information
|
||||
to the user about a particular action.
|
||||
</Para>
|
||||
<Para>The application should use
|
||||
<Function>XtFree</Function>(3) to free the description string returned by
|
||||
<Function>DtActionDescription</Function>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [<Function>XtFree</Function>(3), &cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3) in the &str-Zt;;
|
||||
<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
66
cde/doc/C/guides/man/m3_Dt/ActionEx.sgm
Normal file
66
cde/doc/C/guides/man/m3_Dt/ActionEx.sgm
Normal file
@@ -0,0 +1,66 @@
|
||||
<!-- $XConsortium: ActionEx.sgm /main/6 1996/08/30 12:53:11 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN10.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN10.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtActionExists</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtActionExists</Function></RefName>
|
||||
<RefPurpose>determine if a string corresponds to an action name
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Action.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtActionExists</Function></FuncDef>
|
||||
<ParamDef>char *<Parameter>name</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtActionExists</Function> function checks whether a given name corresponds to an action name.
|
||||
The
|
||||
<Symbol Role="Variable">name</Symbol> argument is the name of the action.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtActionExists</Function> function returns
|
||||
True
|
||||
if
|
||||
<Symbol Role="Variable">name</Symbol> corresponds to an existing action name;
|
||||
otherwise, it returns
|
||||
<SystemItem Class="Constant">False</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The
|
||||
<Function>DtActionExists</Function> function is useful for applications that need to verify that an
|
||||
action name is valid before attempting to invoke it.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
87
cde/doc/C/guides/man/m3_Dt/ActionIc.sgm
Normal file
87
cde/doc/C/guides/man/m3_Dt/ActionIc.sgm
Normal file
@@ -0,0 +1,87 @@
|
||||
<!-- $XConsortium: ActionIc.sgm /main/6 1996/08/30 12:53:36 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN11.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN11.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtActionIcon</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtActionIcon</Function></RefName>
|
||||
<RefPurpose>get the icon information for an action
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Unix System Labs, Inc.,-->
|
||||
<!-- ** a subsidiary of Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Action.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>char <Function>*DtActionIcon</Function></FuncDef>
|
||||
<ParamDef>char *<Parameter>actionName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtActionIcon</Function> function gets the icon information for an action.
|
||||
The
|
||||
<Emphasis>actionName</Emphasis> argument is the name of the action.
|
||||
<Function>DtActionIcon</Function> returns the name of the icon associated with an
|
||||
<Emphasis>actionName</Emphasis> action.
|
||||
If the action definition does not explicitly identify an icon
|
||||
name, this function returns the default action icon name,
|
||||
as described in
|
||||
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
|
||||
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]>The default action icon name can be customized using the
|
||||
<Literal>actionIcon</Literal> X resource.
|
||||
</Para>
|
||||
<Para>If there are multiple
|
||||
<Emphasis>actionName</Emphasis> actions, the string returned is the
|
||||
icon associated with the most general action.
|
||||
The most general action is the one with the lowest precedence,
|
||||
as described in
|
||||
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
|
||||
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtActionIcon</Function> function returns a
|
||||
newly allocated copy of the icon name string
|
||||
(
|
||||
<SystemItem Class="Constant">ICON</SystemItem> field) associated with the action;
|
||||
otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The
|
||||
<Function>DtActionIcon</Function> function is useful for applications that provide a graphical interface
|
||||
to actions.
|
||||
</Para>
|
||||
<Para>The application should use
|
||||
<Function>XtFree</Function>(3) to free the icon name string returned by the
|
||||
<Function>DtActionIcon</Function> function.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [<Function>XtFree</Function>(3) &cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3) in the &str-Zt;;
|
||||
<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
381
cde/doc/C/guides/man/m3_Dt/ActionIn.sgm
Normal file
381
cde/doc/C/guides/man/m3_Dt/ActionIn.sgm
Normal file
@@ -0,0 +1,381 @@
|
||||
<!-- $XConsortium: ActionIn.sgm /main/10 1996/09/08 20:02:14 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDEMX.XCDI.MAN12.rsml.1">]]><![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN12.rsml.1">]]><refmeta>
|
||||
<refentrytitle>DtActionInvoke</refentrytitle><manvolnum>library call</manvolnum>
|
||||
</refmeta><refnamediv><refname><function>DtActionInvoke</function></refname>
|
||||
<refpurpose>invoke a &str-XZ; action</refpurpose></refnamediv><!-- CDE Common
|
||||
Source Format, Version 1.0.0--><!-- *************************************************************************--><!--
|
||||
** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company--><!-- ** (c)
|
||||
Copyright 1993, 1994, 1995 International Business Machines Corp.--><!-- **
|
||||
(c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.--><!-- ** (c) Copyright
|
||||
1993, 1994, 1995 Novell, Inc.--><!-- *************************************************************************--><refsynopsisdiv>
|
||||
<funcsynopsis remap="ANSI">
|
||||
<funcsynopsisinfo>#include <Dt/Action.h></funcsynopsisinfo>
|
||||
<funcdef>DtActionInvocationID <function>DtActionInvoke</function></funcdef>
|
||||
<paramdef>Widget <parameter>w</parameter></paramdef>
|
||||
<paramdef>char *<parameter>action</parameter></paramdef>
|
||||
<paramdef>DtActionArg *<parameter>args</parameter></paramdef>
|
||||
<paramdef>int <parameter>argCount</parameter></paramdef>
|
||||
<paramdef>char *<parameter>termOpts</parameter></paramdef>
|
||||
<paramdef>char *<parameter>execHost</parameter></paramdef>
|
||||
<paramdef>char *<parameter>contextDir</parameter></paramdef>
|
||||
<paramdef>int <parameter>useIndicator</parameter></paramdef>
|
||||
<paramdef>DtActionCallbackProc <parameter>statusUpdateCb</parameter></paramdef>
|
||||
<paramdef>XtPointer <parameter>client_data</parameter></paramdef>
|
||||
</funcsynopsis></refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtActionInvoke</function> function provides a way for
|
||||
applications to invoke desktop actions on file or buffer arguments. Applications
|
||||
can register a callback for receiving action-done status and return arguments.
|
||||
</para>
|
||||
<para>The actions and data types databases must be initialized and loaded
|
||||
(using &cdeman.DtInitialize; and &cdeman.DtDbLoad;)
|
||||
before <function>DtActionInvoke</function> can run successfully.</para>
|
||||
<para>The <symbol role="Variable">w</symbol> argument is a widget that becomes
|
||||
the parent of any dialogs or error messages resulting from action invocation.
|
||||
This widget should be a top-level application shell widget that continues
|
||||
to exist for the action's expected lifetime. This argument must have a non-<systemitem class="Constant">NULL</systemitem> value.</para>
|
||||
<para>The <symbol role="Variable">action</symbol> argument is the name of
|
||||
the action to be invoked. The action database may define more than one action
|
||||
with the same name. The action selected for a particular invocation depends
|
||||
on the class, type, and number of arguments provided (as described in <![ %CDE.C.CDE; [ &cdeman.dtactionfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">). ]]>This
|
||||
argument must have a non-<systemitem class="Constant">NULL</systemitem> value.
|
||||
</para>
|
||||
<para>The <symbol role="Variable">args</symbol> argument is an array of action
|
||||
argument structures containing information about the arguments for this action
|
||||
invocation. If there are no arguments, the value of <symbol role="Variable">args</symbol> must be <systemitem class="Constant">NULL</systemitem>. The
|
||||
items in this array are assigned to the option argument keywords referenced
|
||||
in the action definition (see <![ %CDE.C.CDE; [&cdeman.dtactionfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">). ]]>The
|
||||
<symbol role="Variable">n</symbol>th item is assigned to keyword %Arg_ <symbol role="Variable">n</symbol>%. For example, the second item is assigned to %Arg_<emphasis>2</emphasis>%.</para>
|
||||
<para>The <emphasis>argCount</emphasis> argument is the number of action arguments
|
||||
provided in the array <symbol role="Variable">args</symbol> references.</para>
|
||||
<para>The <emphasis>termOpts</emphasis> argument is a string providing special
|
||||
execution information for the terminal emulator used for <systemitem class="Constant">COMMAND</systemitem> actions of <systemitem class="Constant">WINDOW_TYPE</systemitem> <systemitem class="Constant">TERMINAL</systemitem> or <systemitem class="Constant">PERM_TERMINAL</systemitem>. (See <![ %CDE.C.CDE; [&cdeman.dtactionfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">). ]]>This
|
||||
string must be quoted if it contains embedded blanks. The application uses
|
||||
this string to pass on title, geometry, color and font information to the
|
||||
terminal emulator. This information must be in a form the expected terminal
|
||||
emulator recognizes. This argument can be <systemitem class="Constant">NULL</systemitem>.</para>
|
||||
<para>The <emphasis>execHost</emphasis> argument is a string identifying a
|
||||
preferred execution host for this action. The <emphasis>execHost</emphasis>
|
||||
specified here, supersedes the list of execution hosts defined in the action
|
||||
definition. If <emphasis>execHost</emphasis> is <systemitem class="Constant">NULL</systemitem>, the execution host for the action is obtained from the
|
||||
action definition as described in <![ %CDE.C.CDE; [&cdeman.dtactionfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">. ]]></para>
|
||||
<para>The <emphasis>contextDir</emphasis> argument is a string identifying
|
||||
a fallback working directory for the action. File name arguments are interpreted
|
||||
relative to this directory, which must reside in the local file name space
|
||||
(for example, <Filename>/usr/tmp</Filename> or <Filename>/net/hostb/tmp</Filename>).
|
||||
This value is only used if the action definition does not explicitly specify
|
||||
a working directory in the <systemitem class="Constant">CWD</systemitem> field
|
||||
of the action definition. If <emphasis>contextDir</emphasis> is <systemitem class="Constant">NULL</systemitem>, the current working directory of the action
|
||||
is obtained from the action definition, as described in <![ %CDE.C.CDE; [ &cdeman.dtactionfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">. ]]></para>
|
||||
<para>If the <emphasis>useIndicator</emphasis> flag is zero, <function>DtActionInvoke</function> does not provide any direct indication to the user that an action
|
||||
has been invoked. If the <emphasis>useIndicator</emphasis> flag is non-zero,
|
||||
the user is notified via some activity indicator (for example, a flashing
|
||||
light in the front panel) that an action has been invoked. This indication
|
||||
persists only until the invocation of the action completes (in other words,
|
||||
until the action begins running).</para>
|
||||
<para>The <emphasis>statusUpdateCb</emphasis> callback may be activated if
|
||||
the invoked actions have returnable status (for example, a <systemitem class="Constant">TT_MSG(TT_REQUEST)</systemitem> returning <systemitem class="Constant">DtACTION_DONE</systemitem> ). At a minimum, a <systemitem class="Constant">DtACTION_INVOKED</systemitem> status is returned when <function>DtActionInvoked</function>
|
||||
has finished processing and has completely invoked any resulting actions,
|
||||
and a <systemitem class="Constant">DtACTION_DONE</systemitem> or equivalent
|
||||
done status is returned when all actions terminate. If <emphasis>statusUpdateCb</emphasis> is set to <systemitem class="Constant">NULL</systemitem>, subsequent
|
||||
action status is not returned. (See &cdeman.Dt.Action.h;
|
||||
for a list of all <structname role="typedef">DtActionStatus</structname> codes,
|
||||
and see &cdeman.DtActionCallbackProc; for details on <emphasis>statusUpdateCb</emphasis> and a list of specific <structname role="typedef">DtActionStatus</structname> codes it can return.)</para>
|
||||
<para>The <symbol role="Variable">client_data</symbol> argument is optional
|
||||
data to be passed to the <emphasis>statusUpdateCb</emphasis> callback when
|
||||
invoked.</para>
|
||||
<para>The <function>DtActionInvoke</function> function searches the action
|
||||
database for an entry that matches the specified action name, and accepts
|
||||
arguments of the class, type and count provided.</para>
|
||||
<para>If <function>DtActionInvoke</function> finds a matching action, the
|
||||
supplied arguments are inserted into the indicated action fields. If any missing
|
||||
action arguments have an associated prompt string, then a dialog box prompts
|
||||
the user to supply the arguments; otherwise, missing arguments are ignored.
|
||||
If too many arguments are supplied to an action requiring more than a single
|
||||
argument, a warning dialog is posted, allowing the action to be cancelled
|
||||
or continued, ignoring the extra arguments. If too many arguments are supplied
|
||||
to an action requiring zero or one arguments, then that action is invoked
|
||||
once for each of the supplied arguments. Arguments in the <structname role="typedef">DtActionArg</structname> structure that may have been modified by the action
|
||||
are returned by the callback if a <emphasis>statusUpdateCb</emphasis> callback
|
||||
is provided. For <structname role="typedef">DtActionBuffer</structname> arguments,
|
||||
the writable flag acts as a hint that the buffer is allowed to be modified
|
||||
and returned.</para>
|
||||
<para>The <structname role="typedef">DtActionBuffer</structname> structure
|
||||
contains at least the following members:</para>
|
||||
<informaltable remap="center" orient="Port">
|
||||
<tgroup cols="3">
|
||||
<colspec align="Left" colname="1">
|
||||
<colspec align="Left" colname="2">
|
||||
<colspec align="Left" colname="3">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><computeroutput>void</computeroutput></entry>
|
||||
<entry><computeroutput>*bp</computeroutput></entry>
|
||||
<entry>location of buffer</entry></row>
|
||||
<row>
|
||||
<entry><computeroutput>int</computeroutput></entry>
|
||||
<entry><computeroutput>size</computeroutput></entry>
|
||||
<entry>size of buffer in bytes</entry></row>
|
||||
<row>
|
||||
<entry><computeroutput>char</computeroutput></entry>
|
||||
<entry><computeroutput>*type</computeroutput></entry>
|
||||
<entry>optional type of buffer</entry></row>
|
||||
<row>
|
||||
<entry><computeroutput>char</computeroutput></entry>
|
||||
<entry><computeroutput>*name</computeroutput></entry>
|
||||
<entry>optional name of buffer</entry></row>
|
||||
<row>
|
||||
<entry><computeroutput>Boolean</computeroutput></entry>
|
||||
<entry><computeroutput>writable</computeroutput></entry>
|
||||
<entry>action is allowed to modify and return the buffer</entry></row></tbody>
|
||||
</tgroup></informaltable>
|
||||
<para>The <structname role="typedef">DtActionFile</structname> structure contains
|
||||
at least the following member:</para>
|
||||
<informaltable remap="center" orient="Port">
|
||||
<tgroup cols="3">
|
||||
<colspec align="Left" colname="1">
|
||||
<colspec align="Left" colname="2">
|
||||
<colspec align="Left" colname="3">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><computeroutput>char</computeroutput></entry>
|
||||
<entry><computeroutput>*name</computeroutput></entry>
|
||||
<entry>name of file</entry></row></tbody></tgroup></informaltable>
|
||||
<para>The <structname role="typedef">DtActionArg</structname> structure contains
|
||||
at least the following members:</para>
|
||||
<informaltable remap="center" orient="Port">
|
||||
<tgroup cols="3">
|
||||
<colspec align="Left" colname="1">
|
||||
<colspec align="Left" colname="2">
|
||||
<colspec align="Left" colname="3">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><computeroutput>int</computeroutput></entry>
|
||||
<entry><computeroutput>argClass</computeroutput></entry>
|
||||
<entry>see argument class types ( <systemitem class="Constant">ARG_CLASS</systemitem>
|
||||
field)</entry></row>
|
||||
<row>
|
||||
<entry><computeroutput>DtActionFile</computeroutput></entry>
|
||||
<entry><computeroutput>u.file</computeroutput></entry>
|
||||
<entry>union to a DtActionFile structure</entry></row>
|
||||
<row>
|
||||
<entry><computeroutput>DtActionBuffer</computeroutput></entry>
|
||||
<entry><computeroutput>u.buffer</computeroutput></entry>
|
||||
<entry>union to a DtActionBuffer structure</entry></row></tbody></tgroup>
|
||||
</informaltable>
|
||||
<para>where <emphasis>argClass</emphasis> is <systemitem class="Constant">DtACTION_FILE</systemitem> or <systemitem class="Constant">DtACTION_BUFFER</systemitem>. The action service may set <emphasis>argClass</emphasis> to <systemitem class="Constant">DtACTION_NULLARG</systemitem> for action arguments returned
|
||||
by a <emphasis>statusUpdateCb</emphasis> to indicate that the argument is
|
||||
not being updated or has been removed. <systemitem class="Constant">DtACTION_NULLARG</systemitem> cannot be present in action arguments passed to <function>DtActionInvoke</function>.</para>
|
||||
<para>The <function>DtActionInvoke</function> function accepts a pointer to
|
||||
an array of <structname role="typedef">DtActionArg</structname> structures
|
||||
describing the objects to be provided as arguments to the action. The
|
||||
<symbol role="Variable">args</symbol> structure can be modified or freed after <function>DtActionInvoke</function> returns.</para>
|
||||
<para>A single call to <function>DtActionInvoke</function> may initiate several
|
||||
actions or messages. For example, if an action is given three files, but only
|
||||
needs one, three instances of the action are started, one for each file. As
|
||||
a result, a single returned <structname role="typedef">DtActionInvocationID</structname> may represent a group of running actions, and subsequent execution
|
||||
management services <![ %CDE.C.CDE; [(DtAction) ]]>calls operate on that group
|
||||
of actions.</para>
|
||||
<para>For <systemitem class="Constant">DtACTION_BUFFER</systemitem> arguments,
|
||||
the action service first tries to type the buffer <emphasis>*bp</emphasis>
|
||||
using the <symbol role="Variable">name</symbol> field (see <![ %CDE.C.CDE; [ &cdeman.dtdtsfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.DATAT.anch.3" Role="2">). ]]>The
|
||||
<symbol role="Variable">name</symbol> field would typically contain a value resembling
|
||||
a file name with an optional extension describing its type. If the
|
||||
<symbol role="Variable">name</symbol> field is <systemitem class="Constant">NULL</systemitem>,
|
||||
then the action service uses the type specified in the <symbol role="Variable">type</symbol> field. If the <symbol role="Variable">type</symbol> field is <systemitem class="Constant">NULL</systemitem>, then the action service types the buffer <emphasis>*bp</emphasis> by content (see <![ %CDE.C.CDE; [&cdeman.dtdtsfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.DATAT.anch.3" Role="2">). ]]>If
|
||||
the <symbol role="Variable">name</symbol> and <symbol role="Variable">type</symbol>
|
||||
fields are both non-<systemitem class="Constant">NULL</systemitem>,
|
||||
then the action service uses the <symbol role="Variable">name</symbol> field
|
||||
for typing and ignores the <symbol role="Variable">type</symbol> field. If
|
||||
the buffer pointer <emphasis>bp</emphasis> is <systemitem class="Constant">NULL</systemitem> or <symbol role="Variable">size</symbol> is equal to zero,
|
||||
a buffer with no contents is used in the resulting action. If returned, the
|
||||
buffer pointer <emphasis>bp</emphasis> is defined, and <symbol role="Variable">size</symbol> is equal to or greater than zero.</para>
|
||||
<para>When necessary, <systemitem class="Constant">DtACTION_BUFFER</systemitem>
|
||||
arguments are automatically converted to temporary files prior to actual action
|
||||
invocation, and reconverted back to buffers after action termination (this
|
||||
is transparent to the caller). If a non-<systemitem class="Constant">NULL</systemitem> <symbol role="Variable">name</symbol> field is given, it is
|
||||
used in the construction of the temporary file name (for example, <Filename>/myhome/.dt/tmp/name</Filename>). If the use of <symbol role="Variable">name</symbol>
|
||||
would cause a conflict with an existing file, or <symbol role="Variable">name</symbol> is <systemitem class="Constant">NULL</systemitem>, the action
|
||||
service generates a temporary file name. The permission bits on the temporary
|
||||
file are set according to the <emphasis>writable</emphasis> field and the <systemitem class="Constant">IS_EXECUTABLE</systemitem> attribute from the action service
|
||||
associated with the <symbol role="Variable">type</symbol> field.</para>
|
||||
<para>For <systemitem class="Constant">DtACTION_FILE</systemitem> arguments,
|
||||
<symbol role="Variable">name</symbol> is required.</para>
|
||||
<para>For <systemitem class="Constant">DtACTION_BUFFER</systemitem> arguments,
|
||||
<symbol role="Variable">name</symbol> cannot contain slash characters.</para>
|
||||
<para>Errors encountered are either displayed to the user in a dialog box
|
||||
or reported in the desktop errorlog file (<Filename>$HOME/.dt/errorlog</Filename>,
|
||||
unless configured otherwise).</para>
|
||||
</refsect1><refsect1><?Pub Caret1>
|
||||
<title>RESOURCES</title>
|
||||
<para>This section describes the X11 resources the <function>DtActionInvoke</function> function recognizes. The resource class string always begins with
|
||||
an upper-case letter. The corresponding resource name string begins with the
|
||||
lower case of the same letter. These resources can be defined for all clients
|
||||
using the Action Library API by specifying <literal>*resourceName: value</literal>. <![ %CDE.C.CDE; [For
|
||||
example, to set the terminal emulator to <command>xterm</command>(1) for all
|
||||
clients, the application can use <literal>*localTerminal: xterm</literal>.
|
||||
The resources can also be defined on a per client basis. For example, it can
|
||||
use <literal>Dtfile*localTerminal: xterm</literal> to set the terminal emulator
|
||||
to <command>xterm</command>(1) for the <command>dtfile</command> client only.
|
||||
(See <![ %CDE.C.CDE; [&cdeman.dtactionfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">). ]]>]]></para>
|
||||
<informaltable remap="center" orient="port">
|
||||
<tgroup cols="4" colsep="0" rowsep="0">
|
||||
<colspec align="left" colwidth="155*">
|
||||
<colspec align="left" colwidth="147*">
|
||||
<colspec align="left" colwidth="74*">
|
||||
<colspec align="left" colwidth="81*">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry></entry>
|
||||
<entry align="center" valign="top"><literal>X11 Resources</literal></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Value Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>localterminal</literal></entry>
|
||||
<entry align="left" valign="top"><literal>LocalTerminal</literal></entry>
|
||||
<entry align="left" valign="top"><literal>string</literal></entry>
|
||||
<entry align="left" valign="top">``Dtterm''</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>remoteTerminals</literal></entry>
|
||||
<entry align="left" valign="top"><literal>RemoteTerminals</literal></entry>
|
||||
<entry align="left" valign="top"><literal>string</literal></entry>
|
||||
<entry align="left" valign="top">``Dtterm''</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>waitTime</literal></entry>
|
||||
<entry align="left" valign="top"><literal>WaitTime</literal></entry>
|
||||
<entry align="left" valign="top"><literal>number</literal></entry>
|
||||
<entry align="left" valign="top">3</entry></row></tbody></tgroup></informaltable>
|
||||
<variablelist>
|
||||
<varlistentry><term><literal>LocalTerminal</literal></term>
|
||||
<listitem>
|
||||
<para>Defines an alternative local terminal emulator for Command actions of <systemitem class="Constant">WINDOW_TYPE</systemitem> <systemitem class="Constant">TERMINAL</systemitem> or <systemitem class="Constant">PERM_TERMINAL</systemitem> to
|
||||
use. The default terminal emulator is &cdeman.dtterm;.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>RemoteTerminals</literal></term>
|
||||
<listitem>
|
||||
<para>Defines a comma-separated list of host and terminal emulator pairs.
|
||||
When a remote <systemitem class="Constant">COMMAND</systemitem> action is
|
||||
executed on one of the hosts in the list, the terminal emulator associated
|
||||
with that host is used for that command. The list is passed to the terminal
|
||||
emulator using the <literal>−e</literal> argument. (Thus, if another
|
||||
terminal emulator than <command>dtterm</command> is used, it must support
|
||||
the <literal>−e</literal> argument. <![ %CDE.C.CDE; [See <command>xterm</command>(1). ]]></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>WaitTime</literal></term>
|
||||
<listitem>
|
||||
<para>Used to assign an alternative integer value, in seconds, to the threshold
|
||||
successful return time interval. If a <systemitem class="Constant">COMMAND</systemitem> action of <systemitem class="Constant">WINDOW_TYPE</systemitem> <systemitem class="Constant">TERMINAL</systemitem> fails, the terminal emulator may be
|
||||
unmapped before the user has a chance to read the standard error from the
|
||||
failed command. This resource provides a workaround to this problem. If a <systemitem class="Constant">TERMINAL</systemitem> window command exits before <literal>WaitTime</literal> seconds have elapsed, the terminal emulator window is forced
|
||||
to remain open, as if it were of <systemitem class="Constant">TYPE</systemitem> <systemitem class="Constant">PERM_TERMINAL</systemitem>. The default value of <literal>WaitTime</literal> is 3 seconds.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>Upon successful completion, the <function>DtActionInvoke</function>
|
||||
function returns a <structname role="typedef">DtActionInvocationID</structname>.
|
||||
The ID can be used in subsequent execution management services <![ %CDE.C.CDE; [(DtAction) ]]>calls
|
||||
to manipulate the actions while they are running. <structname role="typedef">DtActionInvocationID</structname>s are only recycled after many have been
|
||||
generated.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>APPLICATION USAGE</title>
|
||||
<para>The caller should allocate space for the array of structures describing
|
||||
the objects to be provided as arguments to the action. The caller can free
|
||||
the memory after <function>DtActionInvoke</function> returns.</para>
|
||||
<para>Since <function>DtActionInvoke</function> spawns subprocesses to start
|
||||
local actions, the caller should use <function>waitpid</function>(2) instead
|
||||
of <function>wait</function>(2) to distinguish between processes started by
|
||||
the action service and those the caller starts.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLES</title>
|
||||
<para>Given the following action definition:</para>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>ACTION Edit
|
||||
{
|
||||
LABEL "Text Edit Action"
|
||||
ARG_CLASS BUFFER, FILE
|
||||
ARG_TYPE TEXT
|
||||
TYPE COMMAND
|
||||
WINDOW_TYPE TERMINAL
|
||||
EXEC_STRING "textedit %Args%"
|
||||
DESCRIPTION This action invokes the "textedit" command on
|
||||
an arbitrary number of arguments. A terminal
|
||||
emulator is provided for this action's I/O.
|
||||
EXEC_HOST and CWD are not specified so the
|
||||
defaults are used for both quantities.
|
||||
}</programlisting>
|
||||
</informalexample>
|
||||
<para>The following call invokes the action
|
||||
<symbol role="Message">Edit</symbol> on the arguments
|
||||
<emphasis>aap</emphasis> supplies:</para>
|
||||
<informalexample remap="indent">
|
||||
<programlisting> DtActionInvoke(w, "Edit", aap, 3, NULL, NULL, NULL, 1,
|
||||
myCallback, myClientData);</programlisting>
|
||||
</informalexample>
|
||||
<para>The working directory for the action defaults to the current working
|
||||
directory.
|
||||
The execution host is the default execution host.</para>
|
||||
<para>If the variable
|
||||
<emphasis>aap</emphasis> points to an array of
|
||||
<literal>ActionArg</literal> data structures
|
||||
containing the following information:</para>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>{
|
||||
argClass = DtACTION_FILE;
|
||||
struct {
|
||||
name="/myhome/file1.txt";
|
||||
} file;
|
||||
}</programlisting>
|
||||
</informalexample>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>{
|
||||
argClass = DtACTION_FILE;
|
||||
struct {
|
||||
name="file2.txt";
|
||||
} file;
|
||||
}</programlisting>
|
||||
</informalexample>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>{
|
||||
argClass = DtACTION_BUFFER;
|
||||
struct {
|
||||
bp=(void *) myEditBuffer;
|
||||
size=lengthOfMyEditBuffer;
|
||||
type=NULL;
|
||||
name="Doc1.txt"
|
||||
writable=TRUE;
|
||||
} buffer;
|
||||
}</programlisting>
|
||||
</informalexample>
|
||||
<para>and the current working directory is
|
||||
<Filename>/cwd</Filename>, then the
|
||||
<symbol role="Message">Edit</symbol> action results in the execution string:
|
||||
</para>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>textedit /myhome/file1.txt /cwd/file2.txt /myhome/.dt/tmp/Doc1.txt
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
<para>When the action completes,
|
||||
<emphasis>myCallback</emphasis> is called and
|
||||
the callback returns the buffer argument.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [ <command>xterm</command>(1), <function>XtFree</function>(3), <function>XtMalloc</function>(3), ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3), <Function>XtMalloc</Function>(3) in the &str-Zt;;
|
||||
]]>&cdeman.DtDbLoad;, &cdeman.DtInitialize;, &cdeman.DtActionCallbackProc;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;, &cdeman.dtdtsfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">, <XRef Linkend="XCDI.DATAT.anch.3" Role="2">. ]]></para>
|
||||
</refsect1></refentry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
<?Pub *0000053895>
|
||||
83
cde/doc/C/guides/man/m3_Dt/ActionLa.sgm
Normal file
83
cde/doc/C/guides/man/m3_Dt/ActionLa.sgm
Normal file
@@ -0,0 +1,83 @@
|
||||
<!-- $XConsortium: ActionLa.sgm /main/6 1996/08/30 12:53:56 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN13.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN13.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtActionLabel</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtActionLabel</Function></RefName>
|
||||
<RefPurpose>get the localizable label string for an action
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Action.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>char <Function>*DtActionLabel</Function></FuncDef>
|
||||
<ParamDef>char *<Parameter>actionName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtActionLabel</Function> function provides access to the localizable label string associated with an
|
||||
action named
|
||||
<Emphasis>actionName</Emphasis>. The
|
||||
<Emphasis>actionName</Emphasis> argument is the name of the action.
|
||||
The localizable label string is the string that all components
|
||||
should display to identify the action.
|
||||
If the action definition does not specify a label string,
|
||||
the action name itself is returned.
|
||||
</Para>
|
||||
<Para>The label string associated with an action is localizable, but the
|
||||
action name is not.
|
||||
</Para>
|
||||
<Para>If there are multiple
|
||||
<Emphasis>actionName</Emphasis> actions, the label string returned
|
||||
is the label associated with the most general action.
|
||||
The most general action is the one with the lowest precedence,
|
||||
as described in
|
||||
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
|
||||
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtActionLabel</Function> function returns a newly allocated
|
||||
copy of the localizable
|
||||
label string associated with the action if an action named
|
||||
<Emphasis>actionName</Emphasis> is found;
|
||||
otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. It is up to the caller to free the memory associated with
|
||||
this new copy of the label.
|
||||
The default value for an action label is the action name itself.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>All applications displaying action names should use
|
||||
the action label to identify an action.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
84
cde/doc/C/guides/man/m3_Dt/ComboAdd.sgm
Normal file
84
cde/doc/C/guides/man/m3_Dt/ComboAdd.sgm
Normal file
@@ -0,0 +1,84 @@
|
||||
<!-- $XConsortium: ComboAdd.sgm /main/10 1996/08/30 12:54:06 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN15.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN15.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtComboBoxAddItem</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtComboBoxAddItem</Function></RefName>
|
||||
<RefPurpose>add an item to the ComboBox widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/ComboBox.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtComboBoxAddItem</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>w</Parameter></ParamDef>
|
||||
<ParamDef>XmString <Parameter>item</Parameter></ParamDef>
|
||||
<ParamDef>int <Parameter>pos</Parameter></ParamDef>
|
||||
<ParamDef>Boolean <Parameter>unique</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<note><para>This function has been superseded by the equivalent
|
||||
Motif function, <function>XmComboBoxAddItem</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<Para>The
|
||||
<Function>DtComboBoxAddItem</Function> function adds the given item to the DtComboBox at the given position.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">w</Symbol> argument specifies the DtComboBox widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">item</Symbol> argument specifies the
|
||||
<StructName Role="typedef">XmString</StructName> for the new item.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>pos</Emphasis> argument specifies the position of the new item.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>unique</Emphasis> argument specifies if this item should duplicate an identical item or not.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtComboBoxAddItem</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The functions
|
||||
<Function>DtComboBoxAddItem</Function> and
|
||||
<Function>DtComboBoxDeletePos</Function> have different naming conventions (Item versus Pos)
|
||||
because of the objects they are manipulating.
|
||||
The Item is a string to be added,
|
||||
the Pos is a numeric position number.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.DtComboBox;,
|
||||
&cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSetItem;, &cdeman.DtComboBoxSelectItem;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
479
cde/doc/C/guides/man/m3_Dt/ComboBox.sgm
Normal file
479
cde/doc/C/guides/man/m3_Dt/ComboBox.sgm
Normal file
@@ -0,0 +1,479 @@
|
||||
<!-- $XConsortium: ComboBox.sgm /main/16 1996/09/08 20:02:24 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN14.rsml.1">]]><![ %CDE.C.XO; [<refentry
|
||||
id="XCDI.MAN14.rsml.1">]]><refmeta><refentrytitle>DtComboBox</refentrytitle>
|
||||
<manvolnum>library call</manvolnum></refmeta><refnamediv><refname><classname>DtComboBox</classname></refname><refpurpose>the ComboBox widget class</refpurpose>
|
||||
</refnamediv><!-- CDE Common Source Format, Version 1.0.0--><!-- (c) Copyright
|
||||
1993, 1994, 1995 Hewlett-Packard Company--><!-- (c) Copyright 1993, 1994,
|
||||
1995 International Business Machines Corp.--><!-- (c) Copyright 1993, 1994,
|
||||
1995 Sun Microsystems, Inc.--><!-- (c) Copyright 1993, 1994, 1995 Novell,
|
||||
Inc.--><!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.--><refsynopsisdiv>
|
||||
<synopsis>#include <Dt/ComboBox.h></synopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<note><para>This function has been superseded by the equivalent
|
||||
Motif function <function>XmComboBox</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<para>The DtComboBox widget is a combination of a TextField and a List widget
|
||||
that provides a list of valid choices for the TextField. Selecting an item
|
||||
from this list automatically fills in the TextField with that list item.</para>
|
||||
<para>Widget subclassing is not supported for the DtComboBox widget class.
|
||||
</para>
|
||||
<para>The resources for the XmList and XmTextField widgets that are created
|
||||
by the DtComboBox are accessible by using the <function>XtNameToWidget</function>(3)
|
||||
function. The names of these widgets are <literal>*List</literal> and <literal>Text</literal>, respectively. (The <literal>*List</literal> notation is required
|
||||
because the List widget is not an immediate descendant of the DtComboBox.
|
||||
See <![ %CDE.C.CDE; [<Function>XtNameToWidget</Function>(3)]]><![ %CDE.C.XO; [<function>XtNameToWidget</function> in the &str-Zt;]]>.)</para>
|
||||
<refsect2>
|
||||
<title>Classes</title>
|
||||
<para>The DtComboBox widget inherits behavior and resources from the <classname>Core</classname>, <classname>Composite</classname> and <classname>XmManager</classname> classes.</para>
|
||||
<para>The class pointer is <Symbol>dtComboBoxWidgetClass</Symbol>.</para>
|
||||
<para>The class name is <structname role="typedef">DtComboBoxWidget</structname>.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect2>
|
||||
<title>New Resources</title>
|
||||
<para>The following table defines a set of widget resources used by the application
|
||||
to specify data. The application can also set the resource values for the
|
||||
inherited classes to set attributes for this widget. To reference a resource
|
||||
by name or by class in a <Filename>.Xdefaults</Filename> file, the application
|
||||
must remove the <Symbol>DtN</Symbol> or <Symbol>DtC</Symbol> prefix and
|
||||
use the remaining letters. To specify one of the defined values for a resource
|
||||
in a <Filename>.Xdefaults</Filename> file, the application must remove the <symbol>Dt</symbol> prefix and use the remaining letters (in either lower case or
|
||||
upper case, but including any underscores between words). The codes in the
|
||||
access column indicate if the given resource can be set at creation time (C),
|
||||
set by using <function>XtSetValues</function> (S), retrieved by using <function>XtGetValues</function> (G), or is not applicable (N/A).</para>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.46in">
|
||||
<colspec align="left" colname="col1" colwidth="196*">
|
||||
<colspec align="left" colname="col2" colwidth="193*">
|
||||
<colspec align="left" colwidth="88*">
|
||||
<colspec align="left" colwidth="77*">
|
||||
<colspec align="left" colwidth="62*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>DtComboBox Resource
|
||||
Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNmarginHeight</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCMarginHeight</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">2</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNmarginWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCMarginWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">2</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNselectedItem</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCSelectedItem</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmString</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNselectedPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCSelectedPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">int</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNselectionCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtCallbackList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNcomboBoxType</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCComboBoxType</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">unsigned int</StructName></entry>
|
||||
<entry align="left" valign="top">DtDROP_DOWN_LIST</entry>
|
||||
<entry align="left" valign="top">C</entry></row></tbody></tgroup></informaltable>
|
||||
<variablelist>
|
||||
<varlistentry><term><systemitem class="Resource">DtNmarginHeight</systemitem></term>
|
||||
<listitem>
|
||||
<para>Specifies the number of pixels added between the top and bottom of the
|
||||
text widget and the start of the shadow.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNmarginWidth</systemitem></term>
|
||||
<listitem>
|
||||
<para>Specifies the number of pixels added between the right and left sides
|
||||
of the text widget and the start of the shadow.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNselectedItem</systemitem></term>
|
||||
<listitem>
|
||||
<para>This resource is passed through to the XmList to set the <systemitem class="Resource">XmNselectedItemCount</systemitem> and <systemitem class="Resource">XmNselectedItems</systemitem> as the single item in the <systemitem class="Resource">XmNitems</systemitem> that matches this specified <structname role="typedef">XmString</structname> in the List. Setting both <systemitem class="Resource">DtNselectedItem</systemitem> and <systemitem class="Resource">DtNselectedPosition</systemitem> in the same argument list produces undefined behavior.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNselectedPosition</systemitem></term>
|
||||
<listitem>
|
||||
<para>This resource is passed through to the XmList to set the <systemitem class="Resource">XmNselectedItemCount</systemitem> and <systemitem class="Resource">XmNselectedItems</systemitem> as the single item at this specified position
|
||||
in the List. Setting both <systemitem class="Resource">DtNselectedItem</systemitem>
|
||||
and <systemitem class="Resource">DtNselectedPosition</systemitem> in the same
|
||||
argument list produces undefined behavior.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNselectionCallback</systemitem></term>
|
||||
<listitem>
|
||||
<para>This callback list is issued when an item is selected from the DtComboBox
|
||||
widget's List. The <symbol role="Variable">call_data</symbol> structure contains
|
||||
a <structname role="typedef">DtComboBoxCallbackStruct</structname> with the
|
||||
reason <systemitem class="Constant">DtCR_SELECT</systemitem>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNcomboBoxType</systemitem></term>
|
||||
<listitem>
|
||||
<para>This resource determines the style of the DtComboBox. There are two
|
||||
choices:</para>
|
||||
<variablelist>
|
||||
<varlistentry><term>DtDROP_DOWN_COMBO_BOX</term>
|
||||
<listitem>
|
||||
<para>Provides an editable text area.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term>DtDROP_DOWN_LIST</term>
|
||||
<listitem>
|
||||
<para>Provides a static text area.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect2>
|
||||
<refsect2>
|
||||
<title>Inherited Resources</title>
|
||||
<para>The DtComboBox widget inherits behavior and resources from the following
|
||||
named superclasses. For a complete description of each resource, see the <![ %CDE.C.CDE; [man page
|
||||
]]><![ %CDE.C.XO; [entry in &str-ZM; ]]>for that superclass.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.73in">
|
||||
<colspec align="left" colname="col1" colwidth="182*">
|
||||
<colspec align="left" colname="col2" colwidth="186*">
|
||||
<colspec align="left" colwidth="109*">
|
||||
<colspec align="left" colwidth="91*">
|
||||
<colspec align="left" colwidth="70*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>XmManager Resource
|
||||
Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbottomShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBottomShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbottomShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBottomShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNforeground</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCForeground</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhelpCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtCallbackList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhighlightColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHighlightColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhighlightPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHighlightPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNinitialFocus</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCInitialFocus</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Widget</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNnavigationType</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCNavigationType</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmNavigationType</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNshadowThickness</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCShadowThickness</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNstringDirection</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCStringDirection</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmStringDirection</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtopShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTopShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtopShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTopShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtraversalOn</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTraversalOn</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNunitType</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCUnitType</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">unsigned char</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNuserData</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCUserData</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtPointer</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row></tbody></tgroup></informaltable>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.46in">
|
||||
<colspec align="left" colname="col1" colwidth="176*">
|
||||
<colspec align="left" colname="col2" colwidth="178*">
|
||||
<colspec align="left" colwidth="90*">
|
||||
<colspec align="left" colwidth="95*">
|
||||
<colspec align="left" colwidth="77*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>Composite Resource
|
||||
Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNchildren</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCReadOnly</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">WidgetList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">G</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNinsertPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCInsertPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtOrderProc</structname></entry>
|
||||
<entry align="left" valign="top">default procedure</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNnumChildren</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCReadOnly</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Cardinal</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">G</entry></row></tbody></tgroup></informaltable>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.85in">
|
||||
<colspec align="left" colname="col1" colwidth="196*">
|
||||
<colspec align="left" colname="col2" colwidth="193*">
|
||||
<colspec align="left" colwidth="90*">
|
||||
<colspec align="left" colwidth="99*">
|
||||
<colspec align="left" colwidth="70*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>Core Resource Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNaccelerators</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCAccelerators</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtAccelerators</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNancestorSensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCSensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">G</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbackground</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBackground</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbackgroundPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNborderColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBorderColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">XtDefaultForeground</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNborderPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNborderWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBorderWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNcolormap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCColormap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Colormap</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNdepth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCDepth</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">int</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNdestroyCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtCallbackList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNheight</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHeight</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNinitialResourcesPersistent</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCInitialResourcesPersistent</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmappedWhenManaged</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMappedWhenManaged</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<?PubTbl row rht="0.39in" >
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNscreen</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCScreen</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">Screen *</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNsensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCSensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtranslations</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTranslations</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtTranslations</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNwidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNx</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Position</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNy</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Position</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row></tbody></tgroup><?Pub Caret>
|
||||
</informaltable>
|
||||
</refsect2>
|
||||
<refsect2>
|
||||
<title>Callback Information</title>
|
||||
<para>A pointer to the following structure is passed to each DtComboBox callback:
|
||||
</para>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>typedef struct {
|
||||
int <symbol role="Variable">reason</symbol>;
|
||||
XEvent *<symbol role="Variable">event</symbol>;
|
||||
XmString <symbol role="Variable">item_or_text</symbol>;
|
||||
int <symbol role="Variable">item_position</symbol>;
|
||||
} DtComboBoxCallbackStruct;</programlisting>
|
||||
</informalexample>
|
||||
<para>The <symbol role="Variable">reason</symbol> argument indicates why the
|
||||
callback was invoked; it is always <systemitem class="Constant">DtCR_SELECT</systemitem>.</para>
|
||||
<para>The <symbol role="Variable">event</symbol> argument points to the <structname role="typedef">XEvent</structname> that triggered the callback, or <systemitem class="Constant">NULL</systemitem> if the callback was not triggered by an <structname role="typedef">XEvent</structname>.</para>
|
||||
<para>The <symbol role="Variable">item_or_text</symbol> argument is the contents
|
||||
of the Text widget at the time the event caused the callback to be invoked.
|
||||
This data is only valid within the scope of the <symbol role="Variable">call_data</symbol>
|
||||
structure, so the application must copy it when it is used outside
|
||||
of this scope.</para>
|
||||
<para>The <symbol role="Variable">item_position</symbol> argument is the new
|
||||
value of the <systemitem class="Resource">DtNselectedPosition</systemitem>
|
||||
resource in the DtComboBox's List. If this is zero, it means the user entered
|
||||
a value in the XmTextField widget.</para>
|
||||
</refsect2>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtComboBoxAddItem;, &cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSelectItem;, &cdeman.DtComboBoxSetItem;, <![ %CDE.C.CDE; [&cdeman.DtCreateComboBox;, &cdeman.Composite;, &cdeman.Constraint;, &cdeman.Core;, &cdeman.XmList;, &cdeman.XmManager;, &cdeman.XmText;, &cdeman.XmTextField;, <Function>XtGetValues</Function>(3), <Function>XtSetValues</Function>(3). ]]><![ %CDE.C.XO; [&cdeman.DtCreateComboBox;; <classname>Composite</classname>, <classname>Constraint</classname>, <classname>Core</classname>, <classname>XmList</classname>, <classname>XmManager</classname>, <classname>XmText</classname>, <classname>XmTextField</classname> in the &str-ZM;, <function>XtGetValues</function>, <function>XtSetValues</function> in the &str-Zt;. ]]></para>
|
||||
</refsect1></refentry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
<?Pub *0000058803>
|
||||
75
cde/doc/C/guides/man/m3_Dt/ComboDel.sgm
Normal file
75
cde/doc/C/guides/man/m3_Dt/ComboDel.sgm
Normal file
@@ -0,0 +1,75 @@
|
||||
<!-- $XConsortium: ComboDel.sgm /main/10 1996/08/30 12:54:28 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN16.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN16.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtComboBoxDeletePos</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtComboBoxDeletePos</Function></RefName>
|
||||
<RefPurpose>delete a DtComboBox item
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/ComboBox.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtComboBoxDeletePos</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>w</Parameter></ParamDef>
|
||||
<ParamDef>int <Parameter>pos</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<note><para>This function has been superseded by the equivalent
|
||||
Motif function, <function>XmComboBoxDeletePos</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<Para>The
|
||||
<Function>DtComboBoxDeletePos</Function> function deletes a specified item from a DtComboBox widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">w</Symbol> argument specifies the DtComboBox widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>pos</Emphasis> argument specifies the position of the item to be deleted.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtComboBoxDeletePos</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The functions
|
||||
<Function>DtComboBoxAddItem</Function> and
|
||||
<Function>DtComboBoxDeletePos</Function> have different naming conventions (Item versus Pos)
|
||||
because of the objects they are manipulating.
|
||||
The Item is a string to be added,
|
||||
the Pos is a numeric position number.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.DtComboBox;,
|
||||
&cdeman.DtComboBoxAddItem;, &cdeman.DtComboBoxSetItem;, &cdeman.DtComboBoxSelectItem;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
71
cde/doc/C/guides/man/m3_Dt/ComboSel.sgm
Normal file
71
cde/doc/C/guides/man/m3_Dt/ComboSel.sgm
Normal file
@@ -0,0 +1,71 @@
|
||||
<!-- $XConsortium: ComboSel.sgm /main/10 1996/08/30 12:54:37 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN17.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN17.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtComboBoxSelectItem</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtComboBoxSelectItem</Function></RefName>
|
||||
<RefPurpose>select a DtComboBox item
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/ComboBox.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtComboBoxSelectItem</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>w</Parameter></ParamDef>
|
||||
<ParamDef>XmString <Parameter>item</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<note><para>This function has been superseded by the equivalent
|
||||
Motif function, <function>XmComboBoxSelectItem</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<Para>The
|
||||
<Function>DtComboBoxSelectItem</Function> function selects an item in the XmList of the DtComboBox
|
||||
widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">w</Symbol> argument specifies the DtComboBox widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">item</Symbol> argument specifies the
|
||||
<StructName Role="typedef">XmString</StructName> of the item to be selected.
|
||||
If the
|
||||
<Symbol Role="Variable">item</Symbol> is not found on the list,
|
||||
<Function>DtComboBoxSelectItem</Function> notifies the user via the
|
||||
<Function>XtWarning</Function> function.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtComboBoxSelectItem</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.DtComboBox;,
|
||||
&cdeman.DtComboBoxAddItem;, &cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSetItem;, <![ %CDE.C.CDE; [<Function>XtWarning</Function>(3).]]><![ %CDE.C.XO; [<Function>XtWarning</Function> in the &str-Zt;.]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
71
cde/doc/C/guides/man/m3_Dt/ComboSet.sgm
Normal file
71
cde/doc/C/guides/man/m3_Dt/ComboSet.sgm
Normal file
@@ -0,0 +1,71 @@
|
||||
<!-- $XConsortium: ComboSet.sgm /main/10 1996/08/30 12:54:48 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN18.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN18.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtComboBoxSetItem</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtComboBoxSetItem</Function></RefName>
|
||||
<RefPurpose>set an item in the DtComboBox list
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/ComboBox.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtComboBoxSetItem</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>w</Parameter></ParamDef>
|
||||
<ParamDef>XmString <Parameter>item</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<note><para>This function has been superseded by the equivalent
|
||||
Motif function, <function>XmComboBoxSetItem</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<Para>The
|
||||
<Function>DtComboBoxSetItem</Function> function selects an item in the XmList of the given DtComboBox
|
||||
widget and makes it the first visible item in the list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">w</Symbol> argument specifies the DtComboBox widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">item</Symbol> argument specifies the
|
||||
<StructName Role="typedef">XmString</StructName> for the item to be set in the DtComboBox.
|
||||
If the
|
||||
<Symbol Role="Variable">item</Symbol> is not found on the list,
|
||||
<Function>DtComboBoxSetItem</Function> notifies the user via the
|
||||
<Function>XtWarning</Function> function.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtComboBoxSetItem</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.DtComboBox;,
|
||||
&cdeman.DtComboBoxAddItem;, &cdeman.DtComboBoxDeletePos;, &cdeman.DtComboBoxSelectItem;, <![ %CDE.C.CDE; [<Function>XtWarning</Function>(3).]]><![ %CDE.C.XO; [<Function>XtWarning</Function> in the &str-Zt;.]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
78
cde/doc/C/guides/man/m3_Dt/CreCombo.sgm
Normal file
78
cde/doc/C/guides/man/m3_Dt/CreCombo.sgm
Normal file
@@ -0,0 +1,78 @@
|
||||
<!-- $XConsortium: CreCombo.sgm /main/9 1996/08/30 12:54:57 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN19.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN19.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateComboBox</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateComboBox</Function></RefName>
|
||||
<RefPurpose>the ComboBox widget creation function
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/ComboBox.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateComboBox</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<note><para>This function has been superseded by the equivalent
|
||||
Motif function, <function>XmCreateComboBox</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<Para>The
|
||||
<Function>DtCreateComboBox</Function> function creates an instance of a ComboBox
|
||||
widget and returns the associated widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute/value pairs in the argument list.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtCreateComboBox</Function> function returns the ComboBox widget ID.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>&cdeman.DtComboBox;.</Para>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para><Classname>DtComboBox</Classname>.</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
74
cde/doc/C/guides/man/m3_Dt/CreEdito.sgm
Normal file
74
cde/doc/C/guides/man/m3_Dt/CreEdito.sgm
Normal file
@@ -0,0 +1,74 @@
|
||||
<!-- $XConsortium: CreEdito.sgm /main/5 1996/08/30 12:55:06 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN9.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN9.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateEditor</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateEditor</Function></RefName>
|
||||
<RefPurpose>create a new instance of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateEditor</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorCreate</Function> function creates an instance of a DtEditor
|
||||
widget and returns the associated widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute and value pairs in the argument list
|
||||
(
|
||||
<Symbol Role="Variable">arglist</Symbol>). <![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorCreate</Function> function
|
||||
returns the DtEditor widget ID; otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
81
cde/doc/C/guides/man/m3_Dt/CreHelpD.sgm
Normal file
81
cde/doc/C/guides/man/m3_Dt/CreHelpD.sgm
Normal file
@@ -0,0 +1,81 @@
|
||||
<!-- $XConsortium: CreHelpD.sgm /main/6 1996/08/30 12:55:16 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN10.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN10.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateHelpDialog</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateHelpDialog</Function></RefName>
|
||||
<RefPurpose>create a general DtHelpDialog widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/HelpDialog.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateHelpDialog</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtCreateHelpDialog</Function> function is a convenience function that creates a
|
||||
DtHelpDialog
|
||||
widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute and value pairs in
|
||||
the argument list
|
||||
(<Symbol Role="Variable">arglist</Symbol>).</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtCreateHelpDialog</Function> function returns an
|
||||
XmBulletinBoard
|
||||
widget whose parent is a dialog shell widget; otherwise, it returns
|
||||
an undefined widget value.
|
||||
The dialog shell is the
|
||||
DtHelpDialog
|
||||
widget's top level.
|
||||
<![ %CDE.C.CDE; [Refer to the
|
||||
Motif documentation for more information on the dialog shell widget and
|
||||
applicable resources.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.HelpDialog.h;, &cdeman.Dt.Help.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtHelpSetCatalogName;, <![ %CDE.C.CDE; [&cdeman.XmBulletinBoard;. ]]><![ %CDE.C.XO; [<Classname>XmBulletinBoard</Classname> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
81
cde/doc/C/guides/man/m3_Dt/CreHelpQ.sgm
Normal file
81
cde/doc/C/guides/man/m3_Dt/CreHelpQ.sgm
Normal file
@@ -0,0 +1,81 @@
|
||||
<!-- $XConsortium: CreHelpQ.sgm /main/6 1996/08/30 12:55:26 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN11.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN11.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateHelpQuickDialog</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateHelpQuickDialog</Function></RefName>
|
||||
<RefPurpose>create a DtHelpQuickDialog widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/HelpQuickD.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateHelpQuickDialog</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtCreateHelpQuickDialog</Function> function is a convenience function that creates a
|
||||
DtHelpQuickDialog
|
||||
widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute and value pairs
|
||||
in the argument list
|
||||
(<Symbol Role="Variable">arglist</Symbol>).</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtCreateHelpQuickDialog</Function> function returns an
|
||||
XmBulletinBoard
|
||||
widget whose parent is a dialog shell widget; otherwise, it returns an
|
||||
undefined widget value.
|
||||
The dialog shell is the
|
||||
DtHelpQuickDialog
|
||||
widget's top level.
|
||||
<![ %CDE.C.CDE; [Refer to the
|
||||
Motif documentation for more information on the dialog shell widget and
|
||||
applicable resources.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.HelpDialog.h;, &cdeman.Dt.Help.h;, &cdeman.DtCreateHelpDialog;, &cdeman.DtHelpSetCatalogName;, &cdeman.DtHelpQuickDialogGetChild;, <![ %CDE.C.CDE; [&cdeman.XmBulletinBoard;. ]]><![ %CDE.C.XO; [<Classname>XmBulletinBoard</Classname> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
72
cde/doc/C/guides/man/m3_Dt/CreMenuB.sgm
Normal file
72
cde/doc/C/guides/man/m3_Dt/CreMenuB.sgm
Normal file
@@ -0,0 +1,72 @@
|
||||
<!-- $XConsortium: CreMenuB.sgm /main/5 1996/08/30 12:55:36 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN20.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN20.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateMenuButton</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateMenuButton</Function></RefName>
|
||||
<RefPurpose>the MenuButton widget creation function
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/MenuButton.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateMenuButton</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtCreateMenuButton</Function> function creates an instance of a MenuButton
|
||||
widget and returns the associated widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute/value pairs in the argument list.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtCreateMenuButton</Function> function returns the MenuButton widget ID.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>&cdeman.DtMenuButton;.</Para>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para><Classname>DtMenuButton</Classname>.</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
129
cde/doc/C/guides/man/m3_Dt/CrePrntD.sgm
Normal file
129
cde/doc/C/guides/man/m3_Dt/CrePrntD.sgm
Normal file
@@ -0,0 +1,129 @@
|
||||
<!-- $XConsortium: xprncpsb.sgm 1996 $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.XPRINT.DtCreatePrintSetupDialog">]]>
|
||||
<refmeta>
|
||||
<refentrytitle>
|
||||
DtCreatePrintSetupDialog
|
||||
</refentrytitle>
|
||||
<manvolnum>library call</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname><function>DtCreatePrintSetupDialog</function></refname>
|
||||
<refpurpose>
|
||||
creates an instance of a dialog containing a <function>DtPrintSetupBox</function> widget
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>
|
||||
#include <Print.h>
|
||||
</funcsynopsisinfo>
|
||||
|
||||
<funcdef>Widget <function>DtCreatePrintSetupDialog</function></funcdef>
|
||||
<paramdef>Widget <parameter>parent</parameter></paramdef>
|
||||
<paramdef>const String <parameter>name</parameter></paramdef>
|
||||
<paramdef>ArgList <parameter>arglist</parameter></paramdef>
|
||||
<paramdef>Cardinal <parameter>argcount</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para><function>DtCreatePrintSetupDialog</function> is a convenience function
|
||||
that creates a <classname>DialogShell</classname> and an
|
||||
unmanaged <classname>DtPrintSetupBox</classname> child of the
|
||||
<classname>DialogShell</classname>.
|
||||
Use <function>XtManageChild</function> to pop up the
|
||||
print set up dialog (passing the <classname>DtPrintSetupBox</classname>
|
||||
as the widget parameter); use <function>XtUnmanageChild</function> to pop it down.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">parent</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the parent widget ID.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">name</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the name of the created widget.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">arglist</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the argument list.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">argcount</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the number of attribute/value pairs in
|
||||
<symbol role="Variable">arglist</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtCreatePrintSetupDialog</function> completes
|
||||
successfully, it returns the <classname>DtPrintSetupBox</classname> widget ID.
|
||||
If it fails, it returns <symbol role="define">NULL</symbol>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>ENVIRONMENT VARIABLES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>RESOURCES</title>
|
||||
<para>None.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>ACTIONS/MESSAGES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>ERRORS/WARNINGS</title>
|
||||
<para>None.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>EXAMPLES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>FILES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para><function>DtPrintSetupBox</function>(3),
|
||||
<function>DtCreatePrintSetupDialog</function>(3)</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
79
cde/doc/C/guides/man/m3_Dt/CreSpinB.sgm
Normal file
79
cde/doc/C/guides/man/m3_Dt/CreSpinB.sgm
Normal file
@@ -0,0 +1,79 @@
|
||||
<!-- $XConsortium: CreSpinB.sgm /main/9 1996/08/30 12:55:45 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN21.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN21.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateSpinBox</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateSpinBox</Function></RefName>
|
||||
<RefPurpose>the SpinBox widget creation function
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Interleaf, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/SpinBox.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateSpinBox</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<note>
|
||||
<para>This function has been superseded by the equivalent
|
||||
Motif function <function>XmCreateSimpleSpinBox</function>. Please refer to the
|
||||
<![ %CDE.C.CDE; [<emphasis>Motif Programmer's Reference</emphasis>]]><![ %CDE.C.XO; [&str-ZM;]]> for more information.
|
||||
</para>
|
||||
</note>
|
||||
<Para>The
|
||||
<Function>DtCreateSpinBox</Function> function creates an instance of a SpinBox
|
||||
widget and returns the associated widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute/value pairs in the argument list.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtCreateSpinBox</Function> function returns the SpinBox widget ID.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>&cdeman.DtSpinBox;.</Para>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para><Classname>DtSpinBox</Classname>.</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
79
cde/doc/C/guides/man/m3_Dt/CreTerm.sgm
Normal file
79
cde/doc/C/guides/man/m3_Dt/CreTerm.sgm
Normal file
@@ -0,0 +1,79 @@
|
||||
<!-- $XConsortium: CreTerm.sgm /main/7 1996/10/08 19:58:01 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN12.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN12.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtCreateTerm</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtCreateTerm</Function></RefName>
|
||||
<RefPurpose>create a DtTerm widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Term.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtCreateTerm</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtCreateTerm</Function> function creates a terminal emulator widget hierarchy.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute and value
|
||||
pairs in the argument list
|
||||
(<Symbol Role="Variable">arglist</Symbol>).
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>The DtTerm widget provides the core set of functionality needed to
|
||||
emulate an <Literal>ANSI X3.64-1979</Literal>- and <Literal>ISO 6429:1992(E)</Literal>-style terminal,
|
||||
such as the DEC VT220.
|
||||
This functionality includes text rendering, scrolling, margin and tab support,
|
||||
escape sequence parsing and the low-level OS-specific interface required to
|
||||
allocate and configure a
|
||||
<Literal>pty</Literal> or STREAMS pseudo-terminal device and write the system's
|
||||
<Literal>utmp</Literal> device.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtCreateTerm</Function> function returns the DtTerm widget ID.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.dtterm;, <![ %CDE.C.CDE; [&cdeman.dttermesc;, <Filename MoreInfo="RefEntry">pty</Filename>(7), ]]><![ %CDE.C.XO; [<XRef Linkend="XCSA.M5DTT.anch.1" Role="2">; ]]>&cdeman.Dt.Term.h;, &cdeman.DtTerm;, &cdeman.DtTermInitialize;, &cdeman.DtTermDisplaySend;, &cdeman.DtTermSubprocSend;, &cdeman.DtTermSubprocReap;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
93
cde/doc/C/guides/man/m3_Dt/CreatePr.sgm
Normal file
93
cde/doc/C/guides/man/m3_Dt/CreatePr.sgm
Normal file
@@ -0,0 +1,93 @@
|
||||
<!-- $XConsortium: CreatePr.sgm /main/7 1996/08/30 12:56:05 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.XPRINT.DtCreatePrintSetupBox">]]>
|
||||
<![ %CDE.C.XO; [<refentry id="XCSA.XPRINT.DtCreatePrintSetupBox">]]>
|
||||
<refmeta><refentrytitle>
|
||||
DtCreatePrintSetupBox
|
||||
</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtCreatePrintSetupBox</function></refname><refpurpose>
|
||||
creates an instance of a <function>DtPrintSetupBox</function> widget
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <Print.h></funcsynopsisinfo>
|
||||
<funcdef>Widget <function>DtCreatePrintSetupBox</function></funcdef>
|
||||
<paramdef>Widget <parameter>parent</parameter></paramdef>
|
||||
<paramdef>const String <parameter>name</parameter></paramdef>
|
||||
<paramdef>ArgList <parameter>arglist</parameter></paramdef>
|
||||
<paramdef>Cardinal <parameter>argcount</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtCreatePrintSetupBox</function> function
|
||||
creates an unmanaged instance of a <function>DtPrintSetupBox</function>
|
||||
widget and returns its widget ID.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">parent</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the parent widget ID.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">name</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the name of the created widget.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">arglist</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the argument list.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">argcount</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the number of attribute/value pairs in arglist.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtCreatePrintSetupBox</function> completes
|
||||
successfully, it returns the
|
||||
<function>DtPrintSetupBox</function> widget ID.
|
||||
If it fails, it returns NULL.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ENVIRONMENT VARIABLES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>RESOURCES</title>
|
||||
<para>None.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ACTIONS/MESSAGES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ERRORS/WARNINGS</title>
|
||||
<para>None.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>FILES</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtPrintSetupBox;,
|
||||
&cdeman.DtCreatePrintSetupDialog;</para>
|
||||
</refsect1></refentry>
|
||||
97
cde/doc/C/guides/man/m3_Dt/DbLoad.sgm
Normal file
97
cde/doc/C/guides/man/m3_Dt/DbLoad.sgm
Normal file
@@ -0,0 +1,97 @@
|
||||
<!-- $XConsortium: DbLoad.sgm /main/8 1996/09/08 20:02:35 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN22.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN22.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtDbLoad</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtDbLoad</Function></RefName>
|
||||
<RefPurpose>load actions and data types database
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis>
|
||||
<FuncSynopsisInfo>#include <Dt/Action.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtDbLoad</Function></FuncDef>
|
||||
<void>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtDbLoad</Function> function loads the actions and data types database
|
||||
into the application.
|
||||
When the function returns, the database has been loaded.
|
||||
<![ %CDE.C.XO; [See
|
||||
<XRef Linkend="XCDI.M4DTS.anch.1" Role="3">for the general syntax and location of the actions
|
||||
and data types database.)
|
||||
]]></Para>
|
||||
<Para><![ %CDE.C.CDE; [An environment variable determines the set of directories to be searched.
|
||||
The
|
||||
<Function>DtDbLoad</Function> function loads all actions and data types
|
||||
defined in files with a
|
||||
<Filename>.dt</Filename> suffix located in these directories.
|
||||
</Para>
|
||||
<Para>The directory search path is based on the value of the
|
||||
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> environment variable and internal defaults.
|
||||
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> contains a comma-separated list of directories
|
||||
in <Literal>[</Literal><Symbol Role="Variable">host</Symbol><Literal>:]/</Literal><Emphasis>path</Emphasis> format.
|
||||
The application must call
|
||||
<Function>DtDbLoad</Function> before calling
|
||||
any of the routines that query either the action or data type databases.
|
||||
If called multiple times, the old databases are freed before the new
|
||||
ones are created.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtDbLoad</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If this function is used in a long-lived application, the application
|
||||
must dynamically reload the databases when they are modified.
|
||||
To do this, the client must register to receive notification whenever the
|
||||
actions and data types database needs to be modified.
|
||||
It is up to the application to recall
|
||||
<Function>DtDbLoad</Function> after receiving notification.
|
||||
This is done with a call to
|
||||
&cdeman.DtDbReloadNotify;.</Para>
|
||||
<Para>If errors are encountered when reading the database files, error messages are
|
||||
written to the user's errorlog file (<Filename>$HOME/.dt/errorlog</Filename>).
|
||||
Records containing errors are not incorporated into the internal database.
|
||||
<!--There are no error returns available to the application
|
||||
because, while errors may occur loading some of those
|
||||
files, this does not necessarily mean that the application should fail.
|
||||
Errors typically affect only a single record in the database.
|
||||
The application can continue processing and
|
||||
error messages will be emitted when the data in the database is
|
||||
actually used.
|
||||
.br
|
||||
--></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, &cdeman.DtDbReloadNotify;, <![ %CDE.C.CDE; [&cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
66
cde/doc/C/guides/man/m3_Dt/DbReload.sgm
Normal file
66
cde/doc/C/guides/man/m3_Dt/DbReload.sgm
Normal file
@@ -0,0 +1,66 @@
|
||||
<!-- $XConsortium: DbReload.sgm /main/7 1996/08/31 14:57:09 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN23.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN23.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtDbReloadNotify</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtDbReloadNotify</Function></RefName>
|
||||
<RefPurpose>reload the Dt actions and data typing services database
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Action.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtDbReloadNotify</Function></FuncDef>
|
||||
<ParamDef>DtDbReloadCallbackProc <Parameter>callback_proc</Parameter></ParamDef>
|
||||
<ParamDef>XtPointer <Parameter>client_data</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtDbReloadNotify</Function> function registers an application callback function that is called
|
||||
whenever the actions and data types database needs to be reloaded;
|
||||
the conditions that trigger this callback are implementation-dependent.
|
||||
The
|
||||
<Emphasis>callback_proc</Emphasis> must flush any actions and data type information that the
|
||||
application has cached and then call
|
||||
&cdeman.DtDbLoad; to reload the database.
|
||||
The
|
||||
<Symbol Role="Variable">client_data</Symbol> argument passes additional application information
|
||||
to the callback routine.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtDbReloadNotify</Function> function returns no value.
|
||||
</Para>
|
||||
<Para>If errors are encountered when reading the database files, error messages are
|
||||
written to the user's errorlog file (<Filename>$HOME/.dt/errorlog</Filename>).
|
||||
Records containing errors are not incorporated into the internal database.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Action.h;, &cdeman.DtDbLoad;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
82
cde/doc/C/guides/man/m3_Dt/DndCreSI.sgm
Normal file
82
cde/doc/C/guides/man/m3_Dt/DndCreSI.sgm
Normal file
@@ -0,0 +1,82 @@
|
||||
<!-- $XConsortium: DndCreSI.sgm /main/5 1996/08/30 12:56:35 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN24.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN24.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtDndCreateSourceIcon</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtDndCreateSourceIcon</Function></RefName>
|
||||
<RefPurpose>create a drag source icon
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Dnd.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtDndCreateSourceIcon</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>Pixmap <Parameter>pixmap</Parameter></ParamDef>
|
||||
<ParamDef>Pixmap <Parameter>mask</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtDndCreateSourceIcon</Function> function creates a Motif drag icon, named
|
||||
<Literal>sourceIcon</Literal>, based on the characteristics of the
|
||||
<Symbol Role="Variable">pixmap</Symbol> argument.
|
||||
The resulting drag icon is suitable for use with
|
||||
&cdeman.DtDndDragStart;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument is the parent of the drag icon.
|
||||
Typically this widget is the drag source.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">pixmap</Symbol> argument is the pixmap representation of the data to be dragged.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">mask</Symbol> argument is the mask for the
|
||||
<Symbol Role="Variable">pixmap</Symbol>.</Para>
|
||||
<Para>When it calls
|
||||
&cdeman.XmCreateDragIcon;, the
|
||||
<Function>DtDndCreateSourceIcon</Function> function sets Motif resources in the drag icon;
|
||||
the application must not modify the values of any of these resources:
|
||||
</Para>
|
||||
<ItemizedList>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNwidth</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNheight</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNpixmap</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNmask</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdepth</SystemItem></Para></ListItem>
|
||||
</ItemizedList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtDndCreateSourceIcon</Function> function returns a drag icon created by calling
|
||||
&cdeman.XmCreateDragIcon; with the characteristics of the
|
||||
<Symbol Role="Variable">pixmap</Symbol>; otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Dnd.h;, <![ %CDE.C.CDE; [&cdeman.DtDndDragStart;, &cdeman.XmCreateDragIcon;, &cdeman.XmDragIcon;, &cdeman.XmDragStart;, <Function>XtDestroyWidget</Function>(3). ]]><![ %CDE.C.XO; [<Function>DtDndDragStart</Function>; <Function>XmCreateDragIcon</Function>, <Function>XmDragIcon</Function>, <Function>XmDragStart</Function> in the &str-ZM;;
|
||||
<Function>XtDestroyWidget</Function> in the &str-Zt;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
532
cde/doc/C/guides/man/m3_Dt/DndDragS.sgm
Normal file
532
cde/doc/C/guides/man/m3_Dt/DndDragS.sgm
Normal file
@@ -0,0 +1,532 @@
|
||||
<!-- $XConsortium: DndDragS.sgm /main/8 1996/09/08 20:02:44 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN25.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN25.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtDndDragStart</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtDndDragStart</Function>,
|
||||
<Function>DtDndVaDragStart</Function>
|
||||
</RefName>
|
||||
<RefPurpose>initiate a drag
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Dnd.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtDndDragStart</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>dragSource</Parameter></ParamDef>
|
||||
<ParamDef>XEvent *<Parameter>event</Parameter></ParamDef>
|
||||
<ParamDef>DtDndProtocol <Parameter>protocol</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>numItems</Parameter></ParamDef>
|
||||
<ParamDef>unsigned char <Parameter>operations</Parameter></ParamDef>
|
||||
<ParamDef>XtCallbackList <Parameter>convertCallback</Parameter></ParamDef>
|
||||
<ParamDef>XtCallbackList <Parameter>dragFinishCallback</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>argList</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argCount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncDef>Widget <Function>DtDndVaDragStart</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>dragSource</Parameter></ParamDef>
|
||||
<ParamDef>XEvent *<Parameter>event</Parameter></ParamDef>
|
||||
<ParamDef>DtDndProtocol <Parameter>protocol</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>numItems</Parameter></ParamDef>
|
||||
<ParamDef>unsigned char <Parameter>operations</Parameter></ParamDef>
|
||||
<ParamDef>XtCallbackList <Parameter>convertCallback</Parameter></ParamDef>
|
||||
<ParamDef>XtCallbackList <Parameter>dragFinishCallback</Parameter></ParamDef>
|
||||
<ParamDef>...</ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> functions initiate a Motif drag, with drag visuals appropriate to the
|
||||
type of data being dragged,
|
||||
and updates the translation table of the drag context.
|
||||
Either of the functions
|
||||
is called from the application's event handler, which interprets
|
||||
mouse events to determine when a drag should begin.
|
||||
</Para>
|
||||
<Para>The only difference between
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> is how the argument list is passed.
|
||||
The argument list is passed as an
|
||||
<StructName Role="typedef">ArgList</StructName> to
|
||||
<Function>DtDndDragStart</Function> and using
|
||||
<Symbol Role="Variable">varargs</Symbol> for
|
||||
<Function>DtDndVaDragStart</Function>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>dragSource</Emphasis> argument is the widget that received the event that triggered the drag.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">event</Symbol> argument is the button press or button motion event that triggered the drag.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">protocol</Symbol> argument specifies the protocol used for the data transfer.
|
||||
Valid values are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_TEXT_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of text is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_FILENAME_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of file names is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_BUFFER_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of memory buffers is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>The
|
||||
<Emphasis>numItems</Emphasis> argument specifies the number of items being dragged.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">operations</Symbol> argument indicates which operations the
|
||||
<Emphasis>dragSource</Emphasis> supports.
|
||||
The operations are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>XmDROP_COPY</Term>
|
||||
<ListItem>
|
||||
<Para>Copy operations are valid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>XmDROP_LINK</Term>
|
||||
<ListItem>
|
||||
<Para>Link operations are valid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>XmDROP_MOVE</Term>
|
||||
<ListItem>
|
||||
<Para>Move operations are valid.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>A drag source can support any combination of these operations.
|
||||
A combination of operations is specified by the
|
||||
bitwise inclusive OR of several operation values.
|
||||
For example, to support the move and copy operations,
|
||||
the application can specify:
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>XmDROP_MOVE | XmDROP_COPY
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Emphasis>convertCallback</Emphasis> argument is a callback function that
|
||||
is invoked when a drop has started and the drop site has requested
|
||||
data from the drag source.
|
||||
The
|
||||
<Emphasis>convertCallback</Emphasis> is responsible for providing the data that is transferred to the drop site.
|
||||
<![ %CDE.C.CDE; [
|
||||
<!-- this is omitted from X/Open because it is info not--><!-- typically stated there about Motif callbacks-->The arguments for the
|
||||
<Emphasis>convertCallback</Emphasis> are the Motif Drag Context, an
|
||||
<StructName Role="typedef">XtPointer</StructName> to application-supplied client data,
|
||||
and an
|
||||
<StructName Role="typedef">XtPointer</StructName> to a
|
||||
<StructName Role="typedef">DtDndConvertCallbackStruct</StructName> structure.
|
||||
]]></Para>
|
||||
<Para>The
|
||||
<Emphasis>dragFinishCallback</Emphasis> argument is a callback function that
|
||||
is invoked when the drag and drop transaction is complete.
|
||||
The
|
||||
<Emphasis>dragFinishCallback</Emphasis> is called after the
|
||||
<Emphasis>convertCallback</Emphasis>, if applicable.
|
||||
(The
|
||||
<Emphasis>convertCallback</Emphasis> is called only after a drop has started
|
||||
on an eligible drop site, whereas
|
||||
<Emphasis>dragFinishCallback</Emphasis> is called after the drag finishes,
|
||||
whether or not a drop occurred.)
|
||||
The
|
||||
<Emphasis>dragFinishCallback</Emphasis> should reset any drag motion handler and free any memory allocated
|
||||
by the drag source during the drag and drop transaction.
|
||||
<![ %CDE.C.CDE; [The arguments
|
||||
for the
|
||||
<Emphasis>dragFinishCallback</Emphasis> are the Motif Drag Context, an
|
||||
<StructName Role="typedef">XtPointer</StructName> to application-supplied client data,
|
||||
and an
|
||||
<StructName Role="typedef">XtPointer</StructName> to a
|
||||
<StructName Role="typedef">DtDndDragFinishCallbackStruct</StructName> structure.
|
||||
]]></Para>
|
||||
<RefSect2>
|
||||
<Title>Argument Value Pairs</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> functions support the following optional argument-value pairs.
|
||||
Motif resources can be set via the argument list as well,
|
||||
provided they are not resources that are used by the drag and drop subsystem;
|
||||
see
|
||||
<Literal>Motif Resources</Literal>.</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNsourceIcon</SystemItem> (<StructName Role="typedef">Widget</StructName>)</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies the
|
||||
<Classname>XmDragIcon</Classname> used to represent the data being dragged.
|
||||
This icon is created using either
|
||||
&cdeman.DtDndCreateSourceIcon; or
|
||||
&cdeman.XmCreateDragIcon;. If
|
||||
<SystemItem Class="Resource">DtNsourceIcon</SystemItem> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then a default icon is used, which is appropriate for the data
|
||||
begin dragged.
|
||||
The default value is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNbufferIsText</SystemItem> (<StructName Role="typedef">Boolean</StructName>)</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies whether the dragged buffer should also be sourced
|
||||
as text, allowing the buffer to be dropped onto text widgets.
|
||||
This attribute is only valid if
|
||||
<Symbol Role="Variable">protocol</Symbol> <SystemItem Class="Constant">DtDND_BUFFER_TRANSFER</SystemItem> and is ignored for other transfers.
|
||||
If
|
||||
<SystemItem Class="Resource">DtNbufferIsText</SystemItem> is True, the buffer is sourced as text in addition
|
||||
to being sourced as buffers;
|
||||
if it is False, the buffers are sourced only as buffers.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNdropOnRootCallback</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>Specifies the callback to be invoked when the drop occurs on the desktop.
|
||||
This callback is only for use by specialized clients such as file managers.
|
||||
If
|
||||
<SystemItem Class="Resource">DtNdropOnRootCallback</SystemItem> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, then drops onto the desktop background are not allowed.
|
||||
The default value is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. ]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Callbacks</Title>
|
||||
<Para>Once the rendezvous with the drop site has been accomplished,
|
||||
the application-provided callback functions are called
|
||||
to perform the transfer of the dragged data.
|
||||
</Para>
|
||||
<Para>First, the
|
||||
<Emphasis>convertCallback</Emphasis> is called with a
|
||||
<Symbol Role="Variable">reason</Symbol> of
|
||||
<SystemItem Class="Constant">DtCR_DND_CONVERT_DATA</SystemItem>. The application must set the
|
||||
<StructName Role="typedef">DtDndContext</StructName> fields appropriate to the transfer protocol to
|
||||
provide the data to be transferred to the drop site.
|
||||
</Para>
|
||||
<Para>If the drag operation is
|
||||
<SystemItem Class="Constant">XmDROP_MOVE</SystemItem> and the drop site requests that the move be completed,
|
||||
the
|
||||
<Emphasis>convertCallback</Emphasis> is called again with a
|
||||
<Symbol Role="Variable">reason</Symbol> of
|
||||
<SystemItem Class="Constant">DtCR_DND_CONVERT_DELETE</SystemItem>. The application should delete its version of the dragged data.
|
||||
</Para>
|
||||
<Para>Once the data transfer is complete, the
|
||||
<Emphasis>dragFinishCallback</Emphasis> is called with a
|
||||
<Symbol Role="Variable">reason</Symbol> of
|
||||
<SystemItem Class="Constant">DtCR_DND_DRAG_FINISH</SystemItem>. The application should free any memory allocated in the
|
||||
<Emphasis>convertCallback</Emphasis> and restore any application state.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Callback Information</Title>
|
||||
<Para>Each of the callbacks for
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> has an associated callback structure.
|
||||
These callbacks cannot be used with the
|
||||
<Function>XtAddCallback</Function>(3) interface.
|
||||
</Para>
|
||||
<Para>A pointer to the following structure is passed to the
|
||||
<Emphasis>convertCallback</Emphasis>:</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct {
|
||||
int <Symbol Role="Variable">reason</Symbol>;
|
||||
XEvent *<Symbol Role="Variable">event</Symbol>;
|
||||
DtDndContext *<Emphasis>dragData</Emphasis>;
|
||||
DtDndStatus <Symbol Role="Variable">status</Symbol>;
|
||||
} DtDndConvertCallbackStruct, *DtDndConvertCallback;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">reason</Symbol> argument indicates why the callback was invoked.
|
||||
The possible reasons for this callback are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtCR_DND_CONVERT_DATA</Term>
|
||||
<ListItem>
|
||||
<Para>The callback provides the requested data by setting appropriate
|
||||
fields in the
|
||||
<Emphasis>dragData</Emphasis> structure.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtCR_DND_CONVERT_DELETE</Term>
|
||||
<ListItem>
|
||||
<Para>The callback completes the
|
||||
<SystemItem Class="Constant">XmDROP_MOVE</SystemItem> operation by deleting its copy of the dragged data.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">event</Symbol> argument
|
||||
points to the
|
||||
<StructName Role="typedef">XEvent</StructName> that triggered the callback.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>dragData</Emphasis> argument
|
||||
specifies the
|
||||
<StructName Role="typedef">DtDndContext</StructName> that contains the data to be dragged.
|
||||
If the
|
||||
<Symbol Role="Variable">reason</Symbol> argument
|
||||
is
|
||||
<SystemItem Class="Constant">DtCR_DND_CONVERT_DATA,</SystemItem> the application must provide the data by setting the relevant fields in the
|
||||
<StructName Role="typedef">DtDndContext</StructName>, as described in the following
|
||||
<Literal>Structures</Literal> section.
|
||||
If the
|
||||
<Symbol Role="Variable">reason</Symbol> argument is
|
||||
<SystemItem Class="Constant">DtCR_DND_CONVERT_DELETE</SystemItem>, the application must delete the original data that
|
||||
completes a move operation.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">status</Symbol> argument
|
||||
indicates the status of the conversion.
|
||||
The application can set this to
|
||||
<SystemItem Class="Constant">DtDND_FAILURE</SystemItem> to cancel the conversion and consequently the drag and drop operation.
|
||||
The value of
|
||||
<Symbol Role="Variable">status</Symbol> is normally
|
||||
<SystemItem Class="Constant">DtDND_SUCCESS</SystemItem>.</Para>
|
||||
<Para>A pointer to the following structure is passed to the
|
||||
<Emphasis>dragFinishCallback</Emphasis>:</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct {
|
||||
int <Symbol Role="Variable">reason</Symbol>;
|
||||
XEvent *<Symbol Role="Variable">event</Symbol>;
|
||||
DtDndContext *<Emphasis>dragData</Emphasis>;
|
||||
Widget <Emphasis>sourceIcon</Emphasis>;
|
||||
} DtDndDragFinishCallbackStruct, *DtDndDragFinishCallback;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">reason</Symbol> argument
|
||||
indicates why the callback was invoked.
|
||||
The valid reason for this callback is
|
||||
<SystemItem Class="Constant">DtCR_DND_DRAG_FINISH</SystemItem>.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">event</Symbol> argument
|
||||
points to the
|
||||
<StructName Role="typedef">XEvent</StructName> that triggered the callback.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>sourceIcon</Emphasis> argument
|
||||
specifies the source icon registered in the call to
|
||||
<Function>DtDndDragStart</Function>. This widget is provided to allow the application to free data associated
|
||||
with the source icon and optionally destroy the source icon.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>dragData</Emphasis> argument specifies the
|
||||
<StructName Role="typedef">DtDndContext</StructName> that contains the data that was dragged.
|
||||
The application should free any
|
||||
data it associated with the
|
||||
<Emphasis>dragData</Emphasis>.</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Structures</Title>
|
||||
<Para>The following structures are used by the drag source in the
|
||||
<Emphasis>convertCallback</Emphasis> and
|
||||
<Emphasis>dragFinishCallback</Emphasis> to communicate data between the application and the drag and drop subsystem.
|
||||
The
|
||||
<StructName Role="typedef">DtDndContext</StructName> structure is passed to these callbacks as
|
||||
<Emphasis>dragData</Emphasis> in the callback structure appropriate to the callback.
|
||||
</Para>
|
||||
<Para>In the
|
||||
<Emphasis>convertCallback</Emphasis>, the application that is acting as the drag source is responsible for filling
|
||||
in the
|
||||
<StructName Role="typedef">DtDndContext</StructName> structure with the data being transferred.
|
||||
</Para>
|
||||
<Para>In the
|
||||
<Emphasis>dragFinishCallback</Emphasis>, the application acting as the drag source is responsible for freeing any
|
||||
data it allocated for use in the
|
||||
<StructName Role="typedef">DtDndContext</StructName> structure.
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct _DtDndContext {
|
||||
DtDndProtocol <Symbol Role="Variable">protocol</Symbol>;
|
||||
int <Emphasis>numItems</Emphasis>;
|
||||
union {
|
||||
XmString *<Symbol Role="Variable">strings</Symbol>;
|
||||
String *<Emphasis>files</Emphasis>;
|
||||
DtDndBuffer *<Emphasis>buffers</Emphasis>;
|
||||
} <Symbol Role="Variable">data</Symbol>;
|
||||
} DtDndContext;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">protocol</Symbol> argument indicates the data transfer protocol under which the data in the
|
||||
<StructName Role="typedef">DtDndContext</StructName> is being transferred.
|
||||
Valid values are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_TEXT_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of text is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_FILENAME_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of file names is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_BUFFER_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of memory buffers is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>The
|
||||
<Emphasis>numItems</Emphasis> argument indicates the number of items being transferred.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument is a union containing data that
|
||||
should be stored and read in the format
|
||||
corresponding to the specified
|
||||
<Symbol Role="Variable">protocol</Symbol>. The data structures corresponding to the transfer protocols are as follows.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">strings</Symbol> argument is valid if the
|
||||
<Symbol Role="Variable">protocol</Symbol> is
|
||||
<SystemItem Class="Constant">DtDND_TEXT_TRANSFER</SystemItem>. The
|
||||
<Symbol Role="Variable">strings</Symbol> argument is an array of pointers to Motif strings
|
||||
containing the text being transferred.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>files</Emphasis> argument is valid if the
|
||||
<Symbol Role="Variable">protocol</Symbol> is
|
||||
<SystemItem Class="Constant">DtDND_FILENAME_TRANSFER</SystemItem>. It is an array of pointers to the names of the files being transferred.
|
||||
The file names have been converted to local host file names
|
||||
where possible.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>buffers</Emphasis> argument is valid if the
|
||||
<Symbol Role="Variable">protocol</Symbol> is
|
||||
<SystemItem Class="Constant">DtDND_BUFFER_TRANSFER</SystemItem>. It is an array of pointers to
|
||||
<StructName Role="typedef">DtDndBuffer</StructName> structures containing the meory buffers being transferred.
|
||||
</Para>
|
||||
<Para>The following structure is used with
|
||||
<SystemItem Class="Constant">DtDND_FILENAME_TRANSFER</SystemItem>:</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct _DtDndBuffer {
|
||||
void *<Emphasis>bp</Emphasis>;
|
||||
int <Symbol Role="Variable">size</Symbol>;
|
||||
string <Symbol Role="Variable">name</Symbol>;
|
||||
} DtDndBuffer;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Emphasis>bp</Emphasis> argument points to the buffer data being transferred.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">size</Symbol> argument indicates the number of bytes in the buffer.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument points to the name of the buffer.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Motif Resources</Title>
|
||||
<Para>When it calls
|
||||
&cdeman.XmDragStart;, the
|
||||
<Function>DtDndDragStart</Function> function sets Motif resources;
|
||||
the application must not modify the values of any of these resources.
|
||||
Resources other than those listed here
|
||||
can be used and are passed through to the underlying
|
||||
<Function>XmDragStart</Function> call.
|
||||
</Para>
|
||||
<Para>The following resources are modified by
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> in the Motif Drag Context:
|
||||
</Para>
|
||||
<ItemizedList>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNblendModel</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNclientData</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNconvertProc</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNcursorBackground</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNcursorForeground</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdragDropFinishCallback</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdragOperations</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdropFinishCallback</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdropStartCallback</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNexportTargets</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNnumExportTargets</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNsourcePixmapIcon</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNtopLevelEnterCallback</SystemItem></Para></ListItem>
|
||||
</ItemizedList>
|
||||
<Para>The following resources are modified by
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> in the Motif Drag Icon:
|
||||
</Para>
|
||||
<ItemizedList>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNattachment</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdepth</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNheight</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNhotX</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNhotY</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNmask</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNoffsetX</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNoffsetY</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNpixmap</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNwidth</SystemItem></Para></ListItem>
|
||||
</ItemizedList>
|
||||
</RefSect2>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtDndDragStart</Function> function returns the drag context widget created
|
||||
when the Motif drag is started;
|
||||
otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem> if the drag could not be started.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Dnd.h;, &cdeman.DtDtsFileToDataType;, &cdeman.DtDndCreateSourceIcon;, &cdeman.DtDndDropRegister;, &cdeman.DtDndDropRegister;, <![ %CDE.C.CDE; [&cdeman.DtDndDropUnregister;, &cdeman.XmCreateDragIcon;, &cdeman.XmDragContext;, &cdeman.XmDragIcon;, &cdeman.XmDragStart;. ]]><![ %CDE.C.XO; [<Function>DtDndDropUnregister</Function>; <Function>XmCreateDragIcon</Function>, <Function>XmDragContext</Function>, <Function>XmDragIcon</Function>, <Function>XmDragStart</Function> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
519
cde/doc/C/guides/man/m3_Dt/DndDropR.sgm
Normal file
519
cde/doc/C/guides/man/m3_Dt/DndDropR.sgm
Normal file
@@ -0,0 +1,519 @@
|
||||
<!-- $XConsortium: DndDropR.sgm /main/10 1996/11/15 15:20:54 cdedoc $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN26.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN26.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtDndDropRegister</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtDndDropRegister</Function>,
|
||||
<Function>DtDndVaDropRegister</Function>
|
||||
</RefName>
|
||||
<RefPurpose>specify a drop site
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Dnd.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtDndDropRegister</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>dropSite</Parameter></ParamDef>
|
||||
<ParamDef>DtDndProtocol <Parameter>protocols</Parameter></ParamDef>
|
||||
<ParamDef>unsigned char <Parameter>operations</Parameter></ParamDef>
|
||||
<ParamDef>XtCallbackList <Parameter>transferCallback</Parameter></ParamDef>
|
||||
<ParamDef>ArgList <Parameter>argList</Parameter></ParamDef>
|
||||
<ParamDef>Cardinal <Parameter>argCount</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncDef>void <Function>DtDndVaDropRegister</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>dropSite</Parameter></ParamDef>
|
||||
<ParamDef>DtDndProtocol <Parameter>protocols</Parameter></ParamDef>
|
||||
<ParamDef>unsigned char <Parameter>operations</Parameter></ParamDef>
|
||||
<ParamDef>XtCallbackList <Parameter>transferCallback</Parameter></ParamDef>
|
||||
<ParamDef>...</ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> functions register a Motif drop site with import targets based on the
|
||||
specified data transfer protocols.
|
||||
<Function>DtDndDropRegister</Function> may be called to register a widget as a drop site at any time, typically
|
||||
soon after the widget is created.
|
||||
</Para>
|
||||
<Para>The only difference between
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> is how the argument list is passed.
|
||||
The argument list is passed as an
|
||||
<StructName Role="typedef">ArgList</StructName> to
|
||||
<Function>DtDndDropRegister</Function> and using
|
||||
<symbol role="variable">VarArgs</symbol> for
|
||||
<Function>DtDndVaDropRegister</Function>.</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">dropSite</symbol> argument specifies the widget to register as the drop site.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">protocol</Symbol> argument specifies the set of data transfer protocols
|
||||
in which the drop site is able to participate.
|
||||
Valid values are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_TEXT_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>The drop site can transfer a list of text.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_FILENAME_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>The drop site can transfer a list of file names.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_BUFFER_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>The drop site can transfer a list of memory buffers.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>A drop site can support any combination of these protocols.
|
||||
A combination of protocols is specified by the
|
||||
bitwise inclusive OR of several protocol values.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">operations</Symbol> argument
|
||||
specifies the set of valid operations associated with a drop site.
|
||||
The operations are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>XmDROP_COPY</Term>
|
||||
<ListItem>
|
||||
<Para>Copy operations are valid.
|
||||
The data will be copied from the drag source.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>XmDROP_LINK</Term>
|
||||
<ListItem>
|
||||
<Para>Link operations are valid.
|
||||
The data will be linked using an alternative method.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>XmDROP_MOVE</Term>
|
||||
<ListItem>
|
||||
<Para>Move operations are valid.
|
||||
The data will be copied, and optionally deleted, from the drag source.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>A drop site can support any combination of these operations.
|
||||
A combination of operations is specified by the
|
||||
bitwise inclusive OR of several operation values.
|
||||
</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">transferCallback</symbol> argument
|
||||
specifies the callback to be called when the dropped data object has been
|
||||
received by the drop site.
|
||||
The
|
||||
<symbol role="variable">transferCallback</symbol> is responsible for transferring the data from the
|
||||
<symbol role="variable">dropData</symbol> to the appropriate internal data structures at the drop site.
|
||||
<![ %CDE.C.CDE; [
|
||||
<!-- this is omitted from X/Open because it is info not--><!-- typically stated there about Motif callbacks-->The arguments for the
|
||||
<symbol role="variable">convertCallback</symbol> are the Motif Drag Context, an
|
||||
<StructName Role="typedef">XtPointer</StructName> to application-supplied client data,
|
||||
and an
|
||||
<StructName Role="typedef">XtPointer</StructName> to a
|
||||
<StructName Role="typedef">DtDndConvertCallbackStruct</StructName> structure.
|
||||
]]></Para>
|
||||
<Para>The
|
||||
<symbol role="variable">argList</symbol> argument specifies the optional argument list.
|
||||
</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">argCount</symbol> argument specifies the number of arguments in
|
||||
<symbol role="variable">argList</symbol>.</Para>
|
||||
<RefSect2>
|
||||
<Title>Argument Value Pairs</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDragStart</Function> and
|
||||
<Function>DtDndVaDragStart</Function> functions support the following optional argument-value pairs.
|
||||
Motif resources can be set via the argument list as well,
|
||||
provided they are not resources that are used by the drag and drop subsystem;
|
||||
see
|
||||
<Literal>Motif Resources</Literal>.</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNregisterChildren</SystemItem> (<StructName Role="typedef">Boolean</StructName>)</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies whether children of a composite drop site
|
||||
widget should be registered.
|
||||
If <symbol role="define">True</symbol>, then the composite
|
||||
<symbol role="variable">dropSite</symbol> widget and its children are registered as a single drop site.
|
||||
If <symbol role="define">False</symbol>, then only the
|
||||
<symbol role="variable">dropSite</symbol> widget itself is registered as the drop site.
|
||||
The default is <symbol role="define">False</symbol>.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNtextIsBuffer</SystemItem> (<StructName Role="typedef">Boolean</StructName>)</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies whether the drops of text selections
|
||||
should be treated as buffer drops.
|
||||
This attribute is only valid if
|
||||
<Symbol Role="Variable">protocols</Symbol> includes
|
||||
<SystemItem Class="Constant">DtDND_BUFFER_TRANSFER</SystemItem>. If
|
||||
<SystemItem Class="Resource">DtNtextIsBuffer</SystemItem> is <symbol role="define">True</symbol>, text drops are accepted as unnamed buffers;
|
||||
if it is <symbol role="define">False</symbol>, only drops of the specified
|
||||
<Symbol Role="Variable">protocols</Symbol> are accepted.
|
||||
The default is <symbol role="define">False</symbol>.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNpreserveRegistration</SystemItem> (<StructName Role="typedef">Boolean</StructName>)</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies whether to preserve any existing drop site
|
||||
registration for the
|
||||
<symbol role="variable">dropSite</symbol> widget.
|
||||
The application can disable preserving the
|
||||
drop site registration if the
|
||||
<symbol role="variable">dropSite</symbol> widget is known not to be registered as a drop site
|
||||
or that registration is not desired.
|
||||
This may improve drop site registration performance.
|
||||
If
|
||||
<SystemItem Class="Resource">DtNpreserveRegistration</SystemItem> is <symbol role="define">True</symbol>, existing drop site registration is preserved;
|
||||
if it is <symbol role="define">False</symbol>, the existing drop site registration is replaced.
|
||||
The default is <symbol role="define">True</symbol>.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Resource">DtNdropAnimateCallback</SystemItem> (<StructName Role="typedef">XtCallbackList</StructName>)</Term>
|
||||
<ListItem>
|
||||
<Para>Specifies the callback to be called when the drop is complete.
|
||||
This enables graphical animation upon successful completion of a drop.
|
||||
This callback is called after the
|
||||
<symbol role="variable">transferCallback</symbol> is called and after Motif performs the "melt" effect.
|
||||
<![ %CDE.C.CDE; [The arguments for the
|
||||
<symbol role="variable">DtNDropAnimateCallback</Symbol> are the Motif Drag Context, an
|
||||
<StructName Role="typedef">XtPointer</StructName> to application-supplied client data,
|
||||
and an
|
||||
<StructName Role="typedef">XtPointer</StructName> to a
|
||||
<StructName Role="typedef">DtDndDropAnimateCallbackStruct</StructName> structure.
|
||||
]]>The Motif Drag Context is in the process of being destroyed at this
|
||||
point so the application must not use it or any of its values in the
|
||||
<symbol role="variable">dropAnimateCallback</symbol>. The default is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Callbacks</Title>
|
||||
<Para>Once the rendezvous with the drag source has been accomplished,
|
||||
the application-provided callback functions are called
|
||||
to perform the data transfer.
|
||||
</Para>
|
||||
<Para>First, the
|
||||
<symbol role="variable">transferCallback</symbol> is called with a
|
||||
<Symbol Role="Variable">reason</Symbol> of
|
||||
<SystemItem Class="Constant">DtCR_DND_TRANSFER_DATA</SystemItem>. The application should access the
|
||||
<StructName Role="typedef">DtDndContext</StructName> fields appropriate for the transfer protocol.
|
||||
The application should parse or type the dropped data
|
||||
to determine whether it is acceptable.
|
||||
If the dropped data is not acceptable,
|
||||
the status field of the
|
||||
<StructName Role="typedef">DtDndTransferCallbackStruct</StructName> should be set to
|
||||
<SystemItem Class="Constant">DtDND_FAILURE</SystemItem>.</Para>
|
||||
<Para>If the
|
||||
<SystemItem Class="Resource">DtNdropAnimateCallback</SystemItem> attribute has been specified, the
|
||||
<symbol role="variable">dropAnimateCallback</symbol> is then called with a
|
||||
<Symbol Role="Variable">reason</Symbol> of
|
||||
<SystemItem Class="Constant">DtCR_DND_DROP_ANIMATE</SystemItem>. The application should perform any
|
||||
application-provided animations for the drop.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<symbol role="variable">transferCallback</symbol> (or the
|
||||
<symbol role="variable">dropAnimateCallback</symbol>, if specified)
|
||||
returns, all memory associated with the
|
||||
drop transfer is freed.
|
||||
Any data in the callback structures that will be
|
||||
used after the drop transfer is complete must be copied
|
||||
by the application.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Callback Information</Title>
|
||||
<Para>Each of the callbacks for
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> has an associated callback structure.
|
||||
These callbacks cannot be used with the
|
||||
<Function>XtAddCallback</Function>(3) interface.
|
||||
</Para>
|
||||
<Para>A pointer to the following structure is passed to the
|
||||
<symbol role="variable">transferCallback</symbol>:</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct {
|
||||
int <Symbol Role="Variable">reason</Symbol>;
|
||||
XEvent *<Symbol Role="Variable">event</Symbol>;
|
||||
Position <Symbol Role="Variable">x</Symbol>, <Symbol Role="Variable">y</Symbol>;
|
||||
unsigned char <Symbol Role="Variable">operation</Symbol>;
|
||||
DtDndContext *<Symbol Role="Variable">dropData</Symbol>;
|
||||
Widget <Symbol Role="Variable">dragContext</Symbol>;
|
||||
Boolean <Symbol Role="Variable">completeMove</Symbol>;
|
||||
DtDndStatus <Symbol Role="Variable">status</Symbol>;
|
||||
} DtDndTransferCallbackStruct, *DtDndTransferCallback;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">reason</Symbol> argument
|
||||
indicates why the callback was invoked:
|
||||
<SystemItem Class="Constant">DtCR_DND_TRANSFER_DATA</SystemItem>.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">event</Symbol> argument is always set to
|
||||
<SystemItem Class="Constant">NULL</SystemItem> by Motif drag and drop.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">x</Symbol> and
|
||||
<Symbol Role="Variable">y</Symbol> arguments
|
||||
indicate the coordinates of the dropped item in relation to the origin of
|
||||
the drop site widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">operation</Symbol> argument indicates the type of drop:
|
||||
<SystemItem Class="Constant">XmDROP_COPY</SystemItem>, <SystemItem Class="Constant">XmDROP_MOVE</SystemItem> or
|
||||
<SystemItem Class="Constant">XmDROP_LINK</SystemItem>.</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">dropData</symbol> argument
|
||||
contains the data that has been dropped.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">dragContext</Symbol> argument
|
||||
specifies the ID of the Motif Drag Context widget associated with this
|
||||
drag and drop transaction.
|
||||
</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">completeMove</symbol> argument
|
||||
indicates whether a move operation needs to be completed.
|
||||
If the
|
||||
<Symbol Role="Variable">operation</Symbol> is
|
||||
<SystemItem Class="Constant">XmDROP_MOVE</SystemItem> and
|
||||
<symbol role="variable">completeMove</symbol> is set to <symbol role="define">False</symbol> in the
|
||||
<symbol role="variable">transferCallback</symbol>, a delete does not occur.
|
||||
By default,
|
||||
<symbol role="variable">completeMove</symbol> is <symbol role="define">True</symbol> and a delete occurs to complete the move operation.
|
||||
The
|
||||
<symbol role="variable">completeMove</symbol> field should be set to <symbol role="define">False</symbol> if an
|
||||
alternative method will be used to complete the move.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">status</Symbol> argument
|
||||
indicates the success or failure of the data transfer.
|
||||
If the data could not
|
||||
be appropriately moved, copied or linked, the
|
||||
<Symbol Role="Variable">status</Symbol> field must be set to
|
||||
<SystemItem Class="Constant">DtDND_FAILURE</SystemItem>. By default, the
|
||||
<Symbol Role="Variable">status</Symbol> field is set to
|
||||
<SystemItem Class="Constant">DtDND_SUCCESS</SystemItem>.</Para>
|
||||
<Para>A pointer to the following structure is passed to the
|
||||
<symbol role="variable">dropAnimateCallback</symbol>:</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct {
|
||||
int <Symbol Role="Variable">reason</Symbol>;
|
||||
XEvent *<Symbol Role="Variable">event</Symbol>;
|
||||
Position <Symbol Role="Variable">x</Symbol>, <Symbol Role="Variable">y</Symbol>;
|
||||
unsigned char <Symbol Role="Variable">operation</Symbol>;
|
||||
DtDndContext *<symbol role="variable">dropData</symbol>;
|
||||
} DtDndDropAnimateCallbackStruct, *DtDndDropAnimateCallback;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">reason</Symbol> argument
|
||||
indicates why the callback was invoked.
|
||||
The valid reason is
|
||||
<SystemItem Class="Constant">DtCR_DND_DROP_ANIMATE</SystemItem>.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">event</Symbol> argument
|
||||
is always set to
|
||||
<SystemItem Class="Constant">NULL</SystemItem> by Motif drag and drop.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">x</Symbol> and
|
||||
<Symbol Role="Variable">y</Symbol> arguments
|
||||
indicate the coordinates of the dropped item in relation to the origin of
|
||||
the drop site widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">operation</Symbol> argument indicates the type of drop:
|
||||
<SystemItem Class="Constant">XmDROP_COPY</SystemItem>, <SystemItem Class="Constant">XmDROP_MOVE</SystemItem> or
|
||||
<SystemItem Class="Constant">XmDROP_LINK</SystemItem>.</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">dropData</symbol> argument
|
||||
contains the data that has been dropped.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Structures</Title>
|
||||
<Para>The following structures are used by the drop site in the
|
||||
<symbol role="variable">transferCallback</symbol> to get the transferred data from the drag and drop subsystem.
|
||||
The
|
||||
<StructName Role="typedef">DtDndContext</StructName> structure is passed as
|
||||
<symbol role="variable">dropData</symbol> in the
|
||||
<StructName Role="typedef">DtDndTransferCallbackStruct</StructName> structure.
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct {
|
||||
DtDndProtocol <Symbol Role="Variable">protocol</Symbol>;
|
||||
int <symbol role="variable">numItems</symbol>;
|
||||
union {
|
||||
XmString *<Symbol Role="Variable">strings</Symbol>;
|
||||
String *<symbol role="variable">files</symbol>;
|
||||
DtDndBuffer *<symbol role="variable">buffers</symbol>;
|
||||
} <Symbol Role="Variable">data</Symbol>;
|
||||
} DtDndContext;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">protocol</Symbol> argument
|
||||
indicates the data transfer protocol under which the data in the
|
||||
<StructName Role="typedef">DtDndContext</StructName> is being transferred.
|
||||
Valid values are:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_TEXT_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of text is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_FILENAME_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of file names is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtDND_BUFFER_TRANSFER</Term>
|
||||
<ListItem>
|
||||
<Para>A list of memory buffers is being transferred.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>The
|
||||
<symbol role="variable">numItems</symbol> argument indicates the number of items being transferred.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument
|
||||
is a union containing data that the drop site should access in the format
|
||||
corresponding to the specified
|
||||
<Symbol Role="Variable">protocol</Symbol>. The data structures corresponding to the transfer protocols are as follows.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">strings</Symbol> argument is valid if the
|
||||
<Symbol Role="Variable">protocol</Symbol> is
|
||||
<SystemItem Class="Constant">DtDND_TEXT_TRANSFER</SystemItem>. The
|
||||
<Symbol Role="Variable">strings</Symbol> argument is an array of pointers to Motif strings
|
||||
containing the text being transferred.
|
||||
</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">files</symbol> argument is valid if the
|
||||
<Symbol Role="Variable">protocol</Symbol> is
|
||||
<SystemItem Class="Constant">DtDND_FILENAME_TRANSFER</SystemItem>. It is an array of pointers to the names of the files being transferred.
|
||||
The file names have been converted to local host file names
|
||||
where possible.
|
||||
</Para>
|
||||
<Para>The
|
||||
<symbol role="variable">buffers</symbol> argument is valid if the
|
||||
<Symbol Role="Variable">protocol</Symbol> is
|
||||
<SystemItem Class="Constant">DtDND_BUFFER_TRANSFER</SystemItem>. It is an array of pointers to
|
||||
<StructName Role="typedef">DtDndBuffer</StructName> structures containing the meory buffers being transferred.
|
||||
</Para>
|
||||
<Para>The following structure is used with
|
||||
<SystemItem Class="Constant">DtDND_FILENAME_TRANSFER</SystemItem>:</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>typedef struct _DtDndBuffer {
|
||||
void *<symbol role="variable">bp</symbol>;
|
||||
int <Symbol Role="Variable">size</Symbol>;
|
||||
string <Symbol Role="Variable">name</Symbol>;
|
||||
} DtDndBuffer;
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The
|
||||
<symbol role="variable">bp</symbol> argument points to the buffer data being transferred.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">size</Symbol> argument indicates the number of bytes in the buffer.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">name</Symbol> argument points to the name of the buffer.
|
||||
</Para>
|
||||
</RefSect2>
|
||||
<RefSect2>
|
||||
<Title>Motif Resources</Title>
|
||||
<Para>When it calls
|
||||
&cdeman.XmDropSiteRegister;, the
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> functions set Motif resources;
|
||||
the application must not modify the values of any of these resources.
|
||||
Resources other than those listed here
|
||||
can be used and are passed through to the underlying
|
||||
<Function>XmDropRegister</Function>. call.
|
||||
</Para>
|
||||
<Para>The following resources are modified by
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> in the Motif Drag Context.
|
||||
</Para>
|
||||
<ItemizedList>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdestroyCallback</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdropTransfers</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNnumDropTransfers</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNtransferProc</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNtransferStatus</SystemItem></Para></ListItem>
|
||||
</ItemizedList>
|
||||
<Para>The following resources are modified by
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> in the Motif Drop Site.
|
||||
</Para>
|
||||
<ItemizedList>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdropProc</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdropSiteOperations</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNdropSiteType</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNimportTargets</SystemItem></Para></ListItem>
|
||||
<ListItem><Para><SystemItem Class="Resource">XmNnumImportTargets</SystemItem></Para></ListItem>
|
||||
</ItemizedList>
|
||||
</RefSect2>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDropRegister</Function> and
|
||||
<Function>DtDndVaDropRegister</Function> functions return no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Dnd.h;, &cdeman.DtDtsDataTypeToAttributeValue;, &cdeman.DtDndDragStart;, &cdeman.DtDndDragStart;, <![ %CDE.C.CDE; [&cdeman.DtDndDropUnregister;, &cdeman.XmDragContext;, &cdeman.XmDropSite;, &cdeman.XmDropSiteRegister;, &cdeman.XmDropSiteUpdate;, &cdeman.XmDropTransfer;, &cdeman.XmDropTransferStart;. ]]><![ %CDE.C.XO; [&cdeman.DtDndDropUnregister;; <Function>XmDragContext</Function>, <Function>XmDropSite</Function>, <Function>XmDropSiteRegister</Function>, <Function>XmDropSiteUpdate</Function>, <Function>XmDropTransfer</Function>, <Function>XmDropTransferStart</Function> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
59
cde/doc/C/guides/man/m3_Dt/DndDropU.sgm
Normal file
59
cde/doc/C/guides/man/m3_Dt/DndDropU.sgm
Normal file
@@ -0,0 +1,59 @@
|
||||
<!-- $XConsortium: DndDropU.sgm /main/4 1996/08/30 12:57:05 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<RefEntry Id="CDEMX.MAN47.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtDndDropUnregister</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtDndDropUnregister</Function></RefName>
|
||||
<RefPurpose>deactivate a drop site
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Dnd.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtDndDropUnregister</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>dropSite</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDropUnregister</Function> function removes the widget,
|
||||
<Emphasis>dropSite</Emphasis>, from the set of drop sites that have been registered with
|
||||
&cdeman.DtDndDropRegister; and frees data allocated by a call to
|
||||
&cdeman.DtDndDropRegister;.</Para>
|
||||
<Para>The
|
||||
<Function>DtDndDropUnregister</Function> function
|
||||
is used to unregister a widget when it is no longer a drop site.
|
||||
A widget can be unregistered with
|
||||
<Function>DtDndDropUnregister</Function> at any time after it has been registered with
|
||||
&cdeman.DtDndDropRegister;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtDndDropUnregister</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Dnd.h;, &cdeman.DtDndDropRegister;, <![ %CDE.C.CDE; [&cdeman.DtDndDropRegister;, &cdeman.XmDropSite;, &cdeman.XmDropSiteRegister;, &cdeman.XmDropSiteUnregister;. ]]><![ %CDE.C.XO; [<Function>DtDndVaDropRegister</Function>; <Function>XmDropSite</Function>, <Function>XmDropSiteRegister</Function>, <Function>XmDropSiteUnregister</Function> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
153
cde/doc/C/guides/man/m3_Dt/EdAppFF.sgm
Normal file
153
cde/doc/C/guides/man/m3_Dt/EdAppFF.sgm
Normal file
@@ -0,0 +1,153 @@
|
||||
<!-- $XConsortium: EdAppFF.sgm /main/5 1996/08/30 12:57:15 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN15.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN15.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorAppendFromFile</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorAppendFromFile</Function></RefName>
|
||||
<RefPurpose>append data from a file into a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorAppendFromFile</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>fileName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para><Function>DtEditorAppendFromFile</Function> function appends data from a file to
|
||||
after the last character in a DtEditor widget.
|
||||
After the data is appended, the insertion cursor is positioned at the
|
||||
new last character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>fileName</Emphasis> argument is the pathname of the file
|
||||
relative to the local system.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorAppendFromFile</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The file is readable and writable.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_READ_ONLY_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is read only.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>The file contained embedded
|
||||
<SystemItem Class="Constant">NULL</SystemItem> characters, which were removed.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if
|
||||
the
|
||||
<Function>DtEditorAppendFromFile</Function> function
|
||||
cannot append the data into the DtEditor widget,
|
||||
it returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NONEXISTENT_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file does not exist.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_DIRECTORY</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a directory.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a character-special device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_BLOCK_MODE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a block-mode device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_FILE_ACCESS</Term>
|
||||
<ListItem>
|
||||
<Para>The file cannot be accessed.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to append the file.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_UNREADABLE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is unreadable for an unspecified reason.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in memory, rather than a disk file, the application should
|
||||
use
|
||||
&cdeman.DtEditorAppend;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;. &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
167
cde/doc/C/guides/man/m3_Dt/EdAppend.sgm
Normal file
167
cde/doc/C/guides/man/m3_Dt/EdAppend.sgm
Normal file
@@ -0,0 +1,167 @@
|
||||
<!-- $XConsortium: EdAppend.sgm /main/6 1996/09/08 20:03:03 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN14.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN14.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorAppend</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorAppend</Function></RefName>
|
||||
<RefPurpose>append data to a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorAppend</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorContentRec *<Parameter>data</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorAppend</Function> function appends either a
|
||||
<SystemItem Class="Constant">NULL</SystemItem>-terminated string, wide character string or sized buffer
|
||||
after the last character in a DtEditor widget.
|
||||
The data is transferred to the DtEditor widget using a
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, which indicates the
|
||||
type of data being transferred along with the actual data.
|
||||
After the data is appended, the insertion cursor is positioned at the
|
||||
new last character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument points to the data structure containing the data to append.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorAppend</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorAppend</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The data was appended sucessfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>NULL characters were found and removed from the data.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if
|
||||
the
|
||||
<Function>DtEditorAppend</Function> function
|
||||
cannot append the data into the DtEditor widget,
|
||||
it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_TYPE</Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">type</Symbol> field is unrecognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the buffer passed in is negative.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULL_ITEM</Term>
|
||||
<ListItem>
|
||||
<Para>The buffer is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. <![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to append the data.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment sets the contents of a DtEditor
|
||||
widget to ``The quick brown fox.''
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor;
|
||||
DtEditorContentRec cr;
|
||||
DtEditorErrorCode status;
|
||||
char *sampleString1="The quick",
|
||||
*secondString2=" brown fox";
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.value.string = sampleString1;
|
||||
status = DtEditorSetContents(editor, &cr);
|
||||
<![ %CDE.C.XO; [if (status != DtEDITOR_NO_ERRORS) {
|
||||
]]><![ %CDE.C.CDE; [if (status != DtEDITOR_NO_ERRORS && status != DtEDITOR_NULLS_REMOVED) {
|
||||
]]> printf("Unable to set the contents of the widget\n");
|
||||
} else {
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.value.string = sampleString2;
|
||||
status = DtEditorAppend(editor, &cr);
|
||||
if (status != DtEDITOR_NO_ERRORS)
|
||||
printf("Unable to append to the contents of the widget\n");
|
||||
}
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in a disk file, rather than in memory, the application should
|
||||
use
|
||||
&cdeman.DtEditorAppendFromFile;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
101
cde/doc/C/guides/man/m3_Dt/EdChange.sgm
Normal file
101
cde/doc/C/guides/man/m3_Dt/EdChange.sgm
Normal file
@@ -0,0 +1,101 @@
|
||||
<!-- $XConsortium: EdChange.sgm /main/5 1996/08/30 12:57:35 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN16.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN16.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorChange</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorChange</Function></RefName>
|
||||
<RefPurpose>change one or all occurrences of a string in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorChange</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorChangeValues *<Parameter>findChangeStrings</Parameter></ParamDef>
|
||||
<ParamDef>unsigned int <Parameter>instanceToChange</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorChange</Function> function replaces the next occurrence of a string, all occurrences of
|
||||
the string, or the currently selected text in a DtEditor widget with a
|
||||
replacement string.
|
||||
The string to search for and the value to
|
||||
change it to can be the last values entered in the Find/Change
|
||||
dialog (see
|
||||
&cdeman.DtEditorInvokeFindChangeDialog;) or passed as arguments to
|
||||
<Function>DtEditorChange</Function>.</Para>
|
||||
<Para>The search begins at the insertion cursor.
|
||||
If the string is not found by the time the end of the document is reached,
|
||||
the search continues at the beginning of the document,
|
||||
stopping at the character before the insertion cursor.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>findChangeStrings</Emphasis> argument specifies the string to change and the replacement value.
|
||||
If
|
||||
<Emphasis>findChangeStrings</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, <Function>DtEditorChange</Function> uses the last string specified in the Find and Change To fields
|
||||
of the Find/Change dialog.
|
||||
If the
|
||||
<Emphasis>instanceToChange</Emphasis> argument is
|
||||
<SystemItem Class="Constant">DtEDITOR_CURRENT_SELECTION</SystemItem>, the Find field of
|
||||
<StructName Role="typedef">DtEditorChangeValues</StructName> is ignored.
|
||||
</Para>
|
||||
<Para>If the
|
||||
<Emphasis>instanceToChange</Emphasis> argument
|
||||
is set to
|
||||
<SystemItem Class="Constant">DtEDITOR_NEXT_OCCURRENCE</SystemItem>, <Function>DtEditorChange</Function> replaces the next occurrence (relative to the
|
||||
insertion cursor) of the find string.
|
||||
If this argument is set to
|
||||
<SystemItem Class="Constant">DtEDITOR_ALL_OCCURRENCES</SystemItem>, all instances of the find string are changed.
|
||||
If this argument ia set to
|
||||
<SystemItem Class="Constant">DtEDITOR_CURRENT_SELECTION</SystemItem>, the Find field of
|
||||
<StructName Role="typedef">DtEditorChangeValues</StructName>, is ignored and the currently selected text is replaced.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorChangeValues</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorChange</Function> function returns
|
||||
True
|
||||
if the substitution occurred;
|
||||
otherwise, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorFind;, &cdeman.DtEditorInvokeFindChangeDialog;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
72
cde/doc/C/guides/man/m3_Dt/EdCheckF.sgm
Normal file
72
cde/doc/C/guides/man/m3_Dt/EdCheckF.sgm
Normal file
@@ -0,0 +1,72 @@
|
||||
<!-- $XConsortium: EdCheckF.sgm /main/5 1996/08/30 12:57:45 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN17.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN17.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorCheckForUnsavedChanges</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorCheckForUnsavedChanges</Function></RefName>
|
||||
<RefPurpose>report whether text has been edited
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorCheckForUnsavedChanges</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorCheckForUnsavedChanges</Function> function reports whether the text contained in the edit window of a
|
||||
DtEditor widget has been modified since the last call to
|
||||
&cdeman.DtEditorGetContents; or
|
||||
&cdeman.DtEditorSaveContentsToFile;, including inserting, deleting or moving text with the keyboard
|
||||
or mouse.
|
||||
For information about retrieving the text without affecting whether
|
||||
<Function>DtEditorCheckForUnsavedChanges</Function> reports that all changes have been saved, see
|
||||
&cdeman.DtEditorGetContents; and
|
||||
&cdeman.DtEditorSaveContentsToFile;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorCheckForUnsavedChanges</Function> function returns
|
||||
True
|
||||
if changes have been
|
||||
made to the contents of the DtEditor widget since the last call to
|
||||
&cdeman.DtEditorGetContents; or
|
||||
&cdeman.DtEditorSaveContentsToFile;; otherwise, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorSaveContentsToFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
70
cde/doc/C/guides/man/m3_Dt/EdClearS.sgm
Normal file
70
cde/doc/C/guides/man/m3_Dt/EdClearS.sgm
Normal file
@@ -0,0 +1,70 @@
|
||||
<!-- $XConsortium: EdClearS.sgm /main/5 1996/08/30 12:57:54 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN18.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN18.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorClearSelection</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorClearSelection</Function></RefName>
|
||||
<RefPurpose>clear the primary selection in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorClearSelection</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorClearSelection</Function> function replaces the primary selection in
|
||||
a DtEditor widget, specified by
|
||||
<Symbol Role="Variable">widget</Symbol>, with blanks
|
||||
<![ %CDE.C.CDE; [(ASCII character 0x20)
|
||||
]]>and newlines.
|
||||
Text can be selected and deselected programmatically with
|
||||
&cdeman.DtEditorSelectAll; and
|
||||
&cdeman.DtEditorDeselect;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorClearSelection</Function> function returns
|
||||
True;
|
||||
otherwise, if the primary selection is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, or if the widget
|
||||
does not own the primary selection, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorPasteFromClipboard;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
69
cde/doc/C/guides/man/m3_Dt/EdCopyTo.sgm
Normal file
69
cde/doc/C/guides/man/m3_Dt/EdCopyTo.sgm
Normal file
@@ -0,0 +1,69 @@
|
||||
<!-- $XConsortium: EdCopyTo.sgm /main/5 1996/08/30 12:58:04 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN19.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN19.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorCopyToClipboard</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorCopyToClipboard</Function></RefName>
|
||||
<RefPurpose>copy the primary selection in a DtEditor widget to the clipboard
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorCopyToClipboard</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorCopyToClipboard</Function> function copies to the clipboard the currently selected text in
|
||||
the DtEditor widget specified by the
|
||||
<Symbol Role="Variable">widget</Symbol> argument.
|
||||
Text can be selected and deselect programmatically with
|
||||
&cdeman.DtEditorSelectAll; and
|
||||
&cdeman.DtEditorDeselect;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorCopyToClipboard</Function> function returns
|
||||
True;
|
||||
otherwise, if the primary selection is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, or if the widget
|
||||
does not own the primary selection, or if the function is unable to gain
|
||||
ownership of the clipboard selection, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorPasteFromClipboard;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
70
cde/doc/C/guides/man/m3_Dt/EdCutToC.sgm
Normal file
70
cde/doc/C/guides/man/m3_Dt/EdCutToC.sgm
Normal file
@@ -0,0 +1,70 @@
|
||||
<!-- $XConsortium: EdCutToC.sgm /main/5 1996/08/30 12:58:14 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN20.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN20.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorCutToClipboard</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorCutToClipboard</Function></RefName>
|
||||
<RefPurpose>copy the primary selection in a DtEditor widget to the clipboard and delete the selected text
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorCutToClipboard</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorCutToClipboard</Function> function copies the primary selected text in the DtEditor widget,
|
||||
specified by the
|
||||
<Symbol Role="Variable">widget</Symbol>, argument to the clipboard and then
|
||||
deletes the primary selected text.
|
||||
Text can be selected and deselected programmatically with
|
||||
&cdeman.DtEditorSelectAll; and
|
||||
&cdeman.DtEditorDeselect;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorCutToClipboard</Function> function returns
|
||||
True;
|
||||
otherwise, if the primary selection is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, or if the widget doesn't own the primary selection, or if the
|
||||
function is unable to gain ownership of the clipboard selection, it
|
||||
returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorPasteFromClipboard;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
69
cde/doc/C/guides/man/m3_Dt/EdDelete.sgm
Normal file
69
cde/doc/C/guides/man/m3_Dt/EdDelete.sgm
Normal file
@@ -0,0 +1,69 @@
|
||||
<!-- $XConsortium: EdDelete.sgm /main/5 1996/08/30 12:58:24 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN21.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN21.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorDeleteSelection</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorDeleteSelection</Function></RefName>
|
||||
<RefPurpose>delete the primary selection in the DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorDeleteSelection</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorDeleteSelection</Function> function removes the currently highlighted data in a DtEditor
|
||||
widget.
|
||||
Any data following the deleted data is moved up.
|
||||
Text can be selected and deselect programmatically with
|
||||
&cdeman.DtEditorSelectAll; and
|
||||
&cdeman.DtEditorDeselect;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument
|
||||
Specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorDeleteSelection</Function> function returns
|
||||
True;
|
||||
otherwise, if the primary selection is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, or if the widget
|
||||
does not own the primary selection, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorPasteFromClipboard;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
65
cde/doc/C/guides/man/m3_Dt/EdDesele.sgm
Normal file
65
cde/doc/C/guides/man/m3_Dt/EdDesele.sgm
Normal file
@@ -0,0 +1,65 @@
|
||||
<!-- $XConsortium: EdDesele.sgm /main/5 1996/08/30 12:58:34 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN22.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN22.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorDeselect</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorDeselect</Function></RefName>
|
||||
<RefPurpose>deselect the current selection in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorDeselect</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorDeselect</Function> function deselects any currently selected text in a DtEditor widget.
|
||||
The entire contents of a DtEditor widget may be selected with
|
||||
&cdeman.DtEditorSelectAll;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorDeselect</Function> function returns
|
||||
True;
|
||||
otherwise, if the primary selection is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, or if the widget
|
||||
does not own the primary selection, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorSelectAll;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
64
cde/doc/C/guides/man/m3_Dt/EdDisabl.sgm
Normal file
64
cde/doc/C/guides/man/m3_Dt/EdDisabl.sgm
Normal file
@@ -0,0 +1,64 @@
|
||||
<!-- $XConsortium: EdDisabl.sgm /main/4 1996/08/30 12:58:44 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<RefEntry Id="CDEMX.MAN48.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorDisableRedisplay</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorDisableRedisplay</Function></RefName>
|
||||
<RefPurpose>temporarily prevent visual update of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorDisableRedisplay</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorDisableRedisplay</Function> function prevents redisplay of a DtEditor widget even
|
||||
though its visual attributes have been modified.
|
||||
The visual appearance of the widget remains unchanged until
|
||||
&cdeman.DtEditorEnableRedisplay; is called.
|
||||
This allows an application to make multiple
|
||||
changes to an editor widget without causing intermediate
|
||||
visual updates.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorDisableRedisplay</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorEnableRedisplay;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
66
cde/doc/C/guides/man/m3_Dt/EdEnable.sgm
Normal file
66
cde/doc/C/guides/man/m3_Dt/EdEnable.sgm
Normal file
@@ -0,0 +1,66 @@
|
||||
<!-- $XConsortium: EdEnable.sgm /main/4 1996/08/30 12:58:54 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<RefEntry Id="CDEMX.MAN49.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorEnableRedisplay</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorEnableRedisplay</Function></RefName>
|
||||
<RefPurpose>force the visual update of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorEnableRedisplay</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorEnableRedisplay</Function> function forces a DtEditor widget to update its visual
|
||||
display if any visual attributes have been set or modified
|
||||
since the
|
||||
&cdeman.DtEditorDisableRedisplay; function was called for the specified widget.
|
||||
Any subsequent changes that affect the widget's visual
|
||||
appearance will cause the widget to update its display.
|
||||
These functions allow an application to make multiple
|
||||
changes to an editor widget without causing intermediate
|
||||
visual updates.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorEnableRedisplay</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorDisableRedisplay;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
79
cde/doc/C/guides/man/m3_Dt/EdFind.sgm
Normal file
79
cde/doc/C/guides/man/m3_Dt/EdFind.sgm
Normal file
@@ -0,0 +1,79 @@
|
||||
<!-- $XConsortium: EdFind.sgm /main/5 1996/08/30 12:59:03 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN23.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN23.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorFind</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorFind</Function></RefName>
|
||||
<RefPurpose>search for the next occurrence of a string in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorFind</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>find</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorFind</Function> function searches for the next occurrence (relative to the
|
||||
insertion cursor) of a string.
|
||||
The string is either
|
||||
the last find string value specified in the
|
||||
Find/Change dialog (see
|
||||
&cdeman.DtEditorInvokeFindChangeDialog;) or is passed in as an argument.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>find</Emphasis> argument specifies the string to search for.
|
||||
If
|
||||
<Emphasis>find</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, <Function>DtEditorFind</Function> uses the last string specified in the Find field of the
|
||||
Find/Change dialog.
|
||||
If the string is not found by the time the end of the document is reached,
|
||||
the search continues at the beginning of the document,
|
||||
stopping at the character before the insertion cursor.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorFind</Function> function returns
|
||||
True
|
||||
if the search string was found;
|
||||
otherwise, it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorChange;, &cdeman.DtEditorInvokeFindChangeDialog;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
165
cde/doc/C/guides/man/m3_Dt/EdFormat.sgm
Normal file
165
cde/doc/C/guides/man/m3_Dt/EdFormat.sgm
Normal file
@@ -0,0 +1,165 @@
|
||||
<!-- $XConsortium: EdFormat.sgm /main/5 1996/08/30 12:59:13 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN24.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN24.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorFormat</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorFormat</Function></RefName>
|
||||
<RefPurpose>format all or part of the contents of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- ***********************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorFormat</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorFormatSettings *<Parameter>formatSettings</Parameter></ParamDef>
|
||||
<ParamDef>unsigned int <Parameter>amountToFormat</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorFormat</Function> function formats all or part of the contents of the DtEditor widget according
|
||||
to the current text format settings in the Format
|
||||
Settings dialog.
|
||||
These options specify which margins and
|
||||
alignments (left aligned, right aligned, justified or centered)
|
||||
are used.
|
||||
Optionally, alternative settings can be passed as an argument to
|
||||
<Function>DtEditorFormat</Function> in a
|
||||
data structure.
|
||||
This function
|
||||
formats either the paragraph containing the insertion cursor
|
||||
or the entire contents of the DtEditor widget, depending on the value of the
|
||||
<Emphasis>amountToFormat</Emphasis> argument.
|
||||
</Para>
|
||||
<Para>The Format Settings dialog is displayed with
|
||||
&cdeman.DtEditorInvokeFormatDialog;. For a complete description of formatting and the Format Settings
|
||||
dialog, see
|
||||
<Classname>DtEditor</Classname>.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the editor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>formatSettings</Emphasis> argument specifies left margin value, right margin value and the
|
||||
justification style.
|
||||
The LeftMargin and RightMargin fields of
|
||||
<StructName Role="typedef">DtEditorFormatSettings</StructName> must be zero or larger.
|
||||
The Alignment field can have a value of
|
||||
<SystemItem Class="Constant">DtEDITOR_ALIGN_CENTER</SystemItem>, <SystemItem Class="Constant">DtEDITOR_ALIGN_JUSTIFY</SystemItem>, <SystemItem Class="Constant">DtEDITOR_ALIGN_LEFT</SystemItem> or
|
||||
<SystemItem Class="Constant">DtEDITOR_ALIGN_RIGHT</SystemItem>. If the
|
||||
<Emphasis>formatSettings</Emphasis> argument is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>, <Function>DtEditorFormat</Function> uses the last format settings specified in the Format Settings dialog.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Emphasis>amountToFormat</Emphasis> argument is set to
|
||||
<SystemItem Class="Constant">DtEDITOR_FORMAT_ALL</SystemItem>, it reformats all the text in the edit window.
|
||||
When this argument is set to
|
||||
<SystemItem Class="Constant">DtEDITOR_PARAGRAPH</SystemItem>, only the paragraph
|
||||
containing the insertion cursor is formatted.
|
||||
</Para><![ %CDE.C.CDE; [<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;.</Para>]]>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorFormatSettings</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para><![ %CDE.C.CDE; [
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorFormat</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, it returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_TMP_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Function>DtEditorFormat</Function> function cannot create two temporary files in the directory returned by
|
||||
<Function>tmpnam</Function>3S.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
|
||||
<ListItem>
|
||||
<Para>The left or right margin values are negative.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_RANGE</Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Emphasis>amountToFormat</Emphasis> argument is not recognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_TYPE</Term>
|
||||
<ListItem>
|
||||
<Para>The Alignment field is not recognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<![ %CDE.C.XO; [
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorFormat</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, it returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
|
||||
<ListItem>
|
||||
<Para>The left or right margin values are negative.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_RANGE</Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Emphasis>amountToFormat</Emphasis> argument is not recognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_TYPE</Term>
|
||||
<ListItem>
|
||||
<Para>The Alignment field is not recognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
]]>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorInvokeFormatDialog;; <![ %CDE.C.CDE; [<Function>tmpnam</Function>3S. ]]><![ %CDE.C.XO; [<Function>tmpnam</Function> in the &str-ZK;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
134
cde/doc/C/guides/man/m3_Dt/EdGetCon.sgm
Normal file
134
cde/doc/C/guides/man/m3_Dt/EdGetCon.sgm
Normal file
@@ -0,0 +1,134 @@
|
||||
<!-- $XConsortium: EdGetCon.sgm /main/7 1996/09/08 20:03:12 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN25.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN25.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorGetContents</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorGetContents</Function></RefName>
|
||||
<RefPurpose>retrieve the contents of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- ************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorGetContents</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorContentRec *<Parameter>data</Parameter></ParamDef>
|
||||
<ParamDef>Boolean <Parameter>hardCarriageReturns</Parameter></ParamDef>
|
||||
<ParamDef>Boolean <Parameter>markContentsAsSaved</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGetContents</Function> function retrieves the entire contents of a DtEditor widget as
|
||||
a string, wide character string or sized buffer of data.
|
||||
The data is transferred from the
|
||||
DtEditor widget using a
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, which indicates the
|
||||
type of data being transferred along with the actual data.
|
||||
If desired, any soft
|
||||
line feeds (word wraps) can be replaced with
|
||||
<KeySym>newline</KeySym>s.</Para>
|
||||
<Para>The DtEditor widget tracks whether its contents have changed since they
|
||||
were last saved or retrieved.
|
||||
Setting the
|
||||
<Emphasis>markContentsAsSaved</Emphasis> argument to True
|
||||
retrieves a copy of the data without
|
||||
affecting whether
|
||||
&cdeman.DtEditorCheckForUnsavedChanges; reports that there are unsaved changes.
|
||||
This is useful if the application needs a temporary copy of the
|
||||
contents.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument is a pointer to a data structure to receive
|
||||
the contents of
|
||||
<Symbol Role="Variable">widget</Symbol>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>hardCarriageReturns</Emphasis> argument, if set to
|
||||
True,
|
||||
indicates that the DtEditor widget should replace
|
||||
any soft line feeds (word wraps) with
|
||||
<KeySym>newline</KeySym>s when saving
|
||||
the data.
|
||||
When
|
||||
<Emphasis>hardCarriageReturns</Emphasis> is set to
|
||||
False,
|
||||
any line wrapped because it reaches the
|
||||
right edge of the window is saved as one complete line.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>markContentsAsSaved</Emphasis> argument, if set to
|
||||
True,
|
||||
causes the DtEditor widget to mark that all changes made to date have been saved.
|
||||
When
|
||||
<Emphasis>markContentsAsSaved</Emphasis> is set to
|
||||
False,
|
||||
the DtEditor widget does not change its status regarding unsaved changes.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorGetContents</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, it returns
|
||||
<SystemItem Class="Constant">DtEDITOR_INVALID_TYPE</SystemItem> if the Type field is not recognized.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment retrieves the contents of a DtEditor widget,
|
||||
marking that all changes to date have been saved.
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor;
|
||||
DtEditorContentRec cr;
|
||||
DtEditorErrorCode status;
|
||||
Boolean markContentsAsSaved = True;
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
status = DtEditorGetContents(editor, &cr, False, markContentsAsSaved);
|
||||
if (status == DtEDITOR_NO_ERRORS)
|
||||
printf("The contents are:\n%s\n", cr.value.string);
|
||||
else
|
||||
printf("Unable to retrieve contents of the widget\n");
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>To write the data directly to a file, the application should use
|
||||
&cdeman.DtEditorSaveContentsToFile;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorCheckForUnsavedChanges;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
66
cde/doc/C/guides/man/m3_Dt/EdGetIns.sgm
Normal file
66
cde/doc/C/guides/man/m3_Dt/EdGetIns.sgm
Normal file
@@ -0,0 +1,66 @@
|
||||
<!-- $XConsortium: EdGetIns.sgm /main/5 1996/08/30 12:59:32 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN26.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN26.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorGetInsertionPosition</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorGetInsertionPosition</Function></RefName>
|
||||
<RefPurpose>retrieve the position of the insert cursor in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>XmTextPosition <Function>DtEditorGetInsertionPosition</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGetInsertionPosition</Function> function accesses the current position of the insertion cursor in the DtEditor
|
||||
widget.
|
||||
The position is an integer number of characters from the
|
||||
beginning of the widget's text buffer.
|
||||
The first character position is zero.
|
||||
The position of the insertion cursor can be set with
|
||||
&cdeman.DtEditorSetInsertionPosition;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorGetInsertionPosition</Function> function returns an
|
||||
<StructName Role="typedef">XmTextPosition</StructName> value that indicates the position of the insertion cursor in the text; otherwise,
|
||||
it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorGetLastPosition;, &cdeman.DtEditorSetInsertionPosition;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
74
cde/doc/C/guides/man/m3_Dt/EdGetLas.sgm
Normal file
74
cde/doc/C/guides/man/m3_Dt/EdGetLas.sgm
Normal file
@@ -0,0 +1,74 @@
|
||||
<!-- $XConsortium: EdGetLas.sgm /main/5 1996/08/30 12:59:41 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN27.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN27.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorGetLastPosition</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorGetLastPosition</Function></RefName>
|
||||
<RefPurpose>retrieve the position of the last character in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>XmTextPosition <Function>DtEditorGetLastPosition</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGetLastPosition</Function> function accesses the last text position in the DtEditor widget.
|
||||
The position is an
|
||||
integer number of characters from the beginning of the widget's buffer.
|
||||
Any text added to the end of the buffer is added after this position.
|
||||
The first character position is zero.
|
||||
The last character
|
||||
position is equal to the number of characters contained in the widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorGetLastPosition</Function> function returns an
|
||||
<StructName Role="typedef">XmTextPosition</StructName> value that indicates the last
|
||||
position in the text; otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The position information is given in terms of characters,
|
||||
which may differ from the byte position when multi-byte
|
||||
code sets are in use.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorGetInsertionPosition;, &cdeman.DtEditorSetInsertionPosition;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
70
cde/doc/C/guides/man/m3_Dt/EdGetMes.sgm
Normal file
70
cde/doc/C/guides/man/m3_Dt/EdGetMes.sgm
Normal file
@@ -0,0 +1,70 @@
|
||||
<!-- $XConsortium: EdGetMes.sgm /main/4 1996/08/30 12:59:52 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<RefEntry Id="CDEMX.MAN50.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorGetMessageTextFieldID</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorGetMessageTextFieldID</Function></RefName>
|
||||
<RefPurpose>retrieve the widget ID of the message text field in the DtEditor status line
|
||||
<IndexTerm>
|
||||
<Primary>DtEditorGetMessageTextFieldID</Primary>
|
||||
</IndexTerm><IndexTerm>
|
||||
<Primary>DtEditor functions</Primary>
|
||||
<Secondary>DtEditorGetMessageTextFieldID</Secondary>
|
||||
</IndexTerm></RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtEditorGetMessageTextFieldID</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGetMessageTextFieldID</Function> function returns the widget ID of the Motif Text Field located in the
|
||||
status area of a DtEditor widget.
|
||||
By setting the
|
||||
<SystemItem Class="Resource">XmNvalue</SystemItem> or
|
||||
<SystemItem Class="Resource">XmNvalueWcs</SystemItem> resource of this widget, an application can
|
||||
display feedback messages for the user.
|
||||
If the application does not use the message field,
|
||||
the message field can be unmanaged by calling
|
||||
<Function>XtUnmanageWidget</Function>(3) with this widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>For a complete definition of the DtEditor widget and its associated resources, see
|
||||
&cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorGetMessageTextFieldID</Function> function returns the ID of the text field widget; otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.XmTextField;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
99
cde/doc/C/guides/man/m3_Dt/EdGetSiz.sgm
Normal file
99
cde/doc/C/guides/man/m3_Dt/EdGetSiz.sgm
Normal file
@@ -0,0 +1,99 @@
|
||||
<!-- $XConsortium: EdGetSiz.sgm /main/6 1996/09/08 20:03:21 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN28.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN28.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorGetSizeHints</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorGetSizeHints</Function></RefName>
|
||||
<RefPurpose>retrieve sizing information from a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- ************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorGetSizeHints</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>XSizeHints *<Parameter>pHints</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGetSizeHints</Function> function retrieves the current sizing information from
|
||||
a DtEditor widget, allowing the application to compute appropriate size hints
|
||||
for the window manager.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>pHints</Emphasis> argument is a pointer to an
|
||||
<StructName Role="typedef">XSizeHints</StructName> structure into which the current sizing information is placed.
|
||||
The fields in this structure do not have to contain any
|
||||
values when it is passed in.
|
||||
</Para>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorGetSizeHints</Function> function fills in the following fields of the
|
||||
<StructName Role="typedef">XSizeHints</StructName> structure: minimum width (
|
||||
<Emphasis>min_width</Emphasis>) and height (
|
||||
<Emphasis>min_height</Emphasis>); width (
|
||||
<Emphasis>width_inc</Emphasis>) and height (
|
||||
<Emphasis>height_inc</Emphasis>) increment; and base width (
|
||||
<Emphasis>base_width</Emphasis>) and height (
|
||||
<Emphasis>base_height</Emphasis>); otherwise, the structure is unchanged.
|
||||
The Flags field is set to:
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>PMinSize | PResizeInc | PBaseSize
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGetSizeHints</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment sets the resize increment and minimum window
|
||||
size properties for the application.
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor,
|
||||
application_shell;
|
||||
Display display;
|
||||
XSizeHints size_hints;
|
||||
long supplied_return;
|
||||
XGetWMSizeHints(display, XtWindow(application_shell),
|
||||
&size_hints, &supplied_return, XA_WM_NORMAL_HINTS);
|
||||
DtEditorGetSizeHints(editor, &size_hints);
|
||||
XSetWMSizeHints(display, XtWindow(application_shell),
|
||||
&size_hints, XA_WM_NORMAL_HINTS);
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
84
cde/doc/C/guides/man/m3_Dt/EdGoToLi.sgm
Normal file
84
cde/doc/C/guides/man/m3_Dt/EdGoToLi.sgm
Normal file
@@ -0,0 +1,84 @@
|
||||
<!-- $XConsortium: EdGoToLi.sgm /main/5 1996/08/30 13:00:10 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN29.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN29.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorGoToLine</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorGoToLine</Function></RefName>
|
||||
<RefPurpose>move the insert cursor for a DtEditor widget to a specified line
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- ***********************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorGoToLine</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>int <Parameter>lineNumber</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGoToLine</Function> function moves the insert cursor for the DtEditor widget to the beginning of the
|
||||
line specified by the
|
||||
<Emphasis>lineNumber</Emphasis> argument.
|
||||
The cursor can be moved to the last
|
||||
line by specifying
|
||||
<SystemItem Class="Constant">DtEDITOR_LAST_LINE</SystemItem> as the line number.
|
||||
If the line is not currently on-screen, the contents for the DtEditor widget
|
||||
are scrolled to display the new insertion position.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>lineNumber</Emphasis> argument is the number of the line in the file,
|
||||
counting from 1.
|
||||
If the
|
||||
<Emphasis>lineNumber</Emphasis> argument is less than 1, the insert cursor is placed
|
||||
at the beginning of the first line.
|
||||
If the argument is greater than the total
|
||||
number of lines, the cursor is placed at the last line of text.
|
||||
</Para>
|
||||
<Para>The insert cursor can be moved to a specific character position with
|
||||
&cdeman.DtEditorSetInsertionPosition;. The
|
||||
<SystemItem Class="Resource">DtNtopCharacter</SystemItem> resource can be used to control which line is displayed at the top of the
|
||||
DtEditor widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>lineNumber</Emphasis> argument specifies the line number within the DtEditor widget.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorGoToLine</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorSetInsertionPosition;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
151
cde/doc/C/guides/man/m3_Dt/EdInsFF.sgm
Normal file
151
cde/doc/C/guides/man/m3_Dt/EdInsFF.sgm
Normal file
@@ -0,0 +1,151 @@
|
||||
<!-- $XConsortium: EdInsFF.sgm /main/5 1996/08/30 13:00:20 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN31.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN31.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorInsertFromFile</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorInsertFromFile</Function></RefName>
|
||||
<RefPurpose>insert data from a file into a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorInsertFromFile</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>fileName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInsertFromFile</Function> function inserts data from a file to
|
||||
the insertion cursor position in a DtEditor widget.
|
||||
After the data is inserted, the insertion cursor is positioned after the
|
||||
last character inserted.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>fileName</Emphasis> argument is the pathname of the file
|
||||
relative to the local system.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorInsertFromFile</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The file is readable and writable.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_READ_ONLY_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is read only.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>The file contained embedded
|
||||
<SystemItem Class="Constant">NULL</SystemItem> characters, which were removed.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if it cannot insert the data into the DtEditor widget,
|
||||
<Function>DtEditorInsertFromFile</Function> returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NONEXISTENT_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file does not exist.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_DIRECTORY</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a directory.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a character-special device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_BLOCK_MODE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a block-mode device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_FILE_ACCESS</Term>
|
||||
<ListItem>
|
||||
<Para>The file cannot be accessed.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to insert the file.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_UNREADABLE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is unreadable for an unspecified reason.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in memory, rather than a disk file, the application should
|
||||
use
|
||||
&cdeman.DtEditorInsert;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorGetInsertionPosition;, &cdeman.DtEditorSetInsertionPosition;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
172
cde/doc/C/guides/man/m3_Dt/EdInsert.sgm
Normal file
172
cde/doc/C/guides/man/m3_Dt/EdInsert.sgm
Normal file
@@ -0,0 +1,172 @@
|
||||
<!-- $XConsortium: EdInsert.sgm /main/6 1996/09/08 20:03:30 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN30.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN30.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorInsert</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorInsert</Function></RefName>
|
||||
<RefPurpose>insert data into a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorInsert</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorContentRec *<Parameter>data</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInsert</Function> function inserts either a string, wide character string or sized buffer
|
||||
at the insertion cursor position in a DtEditor widget.
|
||||
The data is transferred to the
|
||||
DtEditor widget using a
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, which indicates the
|
||||
type of data being transferred along with the actual data.
|
||||
After the data is appended, the insertion cursor is positioned after the
|
||||
last character inserted.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument is a pointer to a data structure
|
||||
containing the data to insert.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorInsert</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorInsert</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The data was inserted sucessfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>NULL characters were found and removed from the data.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if
|
||||
the
|
||||
<Function>DtEditorInsert</Function> function
|
||||
cannot insert the data into the DtEditor widget,
|
||||
it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_TYPE</Term>
|
||||
<ListItem>
|
||||
<Para>The Type field is not recognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the buffer passed in is negative.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULL_ITEM</Term>
|
||||
<ListItem>
|
||||
<Para>The buffer is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. <![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to insert the data.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment sets the contents of a DtEditor
|
||||
widget to ``The quick brown fox.''
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor;
|
||||
DtEditorContentRec cr;
|
||||
DtEditorErrorCode status;
|
||||
char *sampleString1="The brown fox",
|
||||
*sampleString2=" quick";
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.value.string = sampleString1;
|
||||
status = DtEditorSetContents(editor, &cr);
|
||||
<![ %CDE.C.XO; [if (status != DtEDITOR_NO_ERRORS) {
|
||||
]]><![ %CDE.C.CDE; [if (status != DtEDITOR_NO_ERRORS && status != DtEDITOR_NULLS_REMOVED) {
|
||||
]]> printf("Unable to set contents of the widget\n");
|
||||
} else {
|
||||
/*
|
||||
* Move the insertion cursor so it is after the
|
||||
* letter 'e' in "The".
|
||||
*/
|
||||
DtEditorSetInsertionCursorPosition(editor, 2);
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.data.string = sampleString2;
|
||||
status = DtEditorInsert(editor, &cr);
|
||||
if (status != DtEDITOR_NO_ERRORS)
|
||||
printf("Unable to insert into the contents of the widget\n");
|
||||
}
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in a disk file, rather than in memory, the application should
|
||||
use
|
||||
&cdeman.DtEditorInsertFromFile;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorGetInsertionPosition;, &cdeman.DtEditorSetInsertionPosition;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
71
cde/doc/C/guides/man/m3_Dt/EdInvFin.sgm
Normal file
71
cde/doc/C/guides/man/m3_Dt/EdInvFin.sgm
Normal file
@@ -0,0 +1,71 @@
|
||||
<!-- $XConsortium: EdInvFin.sgm /main/5 1996/08/30 13:00:40 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN32.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN32.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorInvokeFindChangeDialog</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorInvokeFindChangeDialog</Function></RefName>
|
||||
<RefPurpose>display the DtEditor widget dialog for searching and replacing text
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorInvokeFindChangeDialog</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInvokeFindChangeDialog</Function> function displays the Find/Change dialog for the DtEditor widget.
|
||||
This dialog enables a
|
||||
user to search for, and optionally replace, a string in the
|
||||
text for the DtEditor widget.
|
||||
It also allows the user to specify a replacement
|
||||
string, which can be substituted for either the next occurrence of the
|
||||
search string or all occurrences.
|
||||
The Find/Change dialog remains displayed until the user closes it.
|
||||
For a complete description of the Find/Change dialog see
|
||||
<Classname>DtEditor</Classname>.</Para>
|
||||
<Para>Subsequent searches for the last search string entered can be made by
|
||||
calling
|
||||
&cdeman.DtEditorFind;. Subsequent substitutions can be made with
|
||||
&cdeman.DtEditorChange;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInvokeFindChangeDialog</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorChange;, &cdeman.DtEditorFind;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
69
cde/doc/C/guides/man/m3_Dt/EdInvFor.sgm
Normal file
69
cde/doc/C/guides/man/m3_Dt/EdInvFor.sgm
Normal file
@@ -0,0 +1,69 @@
|
||||
<!-- $XConsortium: EdInvFor.sgm /main/5 1996/08/30 13:00:50 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN33.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN33.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorInvokeFormatDialog</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorInvokeFormatDialog</Function></RefName>
|
||||
<RefPurpose>display the DtEditor widget dialog for choosing formatting options
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorInvokeFormatDialog</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInvokeFormatDialog</Function> function displays the Format Settings dialog of the DtEditor widget.
|
||||
This dialog
|
||||
enables a user to set the text formatting options:
|
||||
margins and
|
||||
text alignments (left aligned, right aligned, justified or centered).
|
||||
The dialog also provides the capability to format either the paragraph
|
||||
containing the insertion cursor or the entire contents of the DtEditor widget.
|
||||
The Format Settings dialog remains displayed until the user closes it.
|
||||
For a complete description of the Format Settings dialog, see
|
||||
<Classname>DtEditor</Classname>.</Para>
|
||||
<Para>Text can be formatted programmatically with
|
||||
&cdeman.DtEditorFormat;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInvokeFormatDialog</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorFormat;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
92
cde/doc/C/guides/man/m3_Dt/EdInvSpe.sgm
Normal file
92
cde/doc/C/guides/man/m3_Dt/EdInvSpe.sgm
Normal file
@@ -0,0 +1,92 @@
|
||||
<!-- $XConsortium: EdInvSpe.sgm /main/5 1996/08/31 14:57:26 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<RefEntry Id="CDEMX.MAN51.rsml.1">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorInvokeSpellDialog</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorInvokeSpellDialog</Function></RefName>
|
||||
<RefPurpose>display the DtEditor widget dialog for checking text for spelling errors
|
||||
<IndexTerm>
|
||||
<Primary>DtEditorInvokeSpellDialog</Primary>
|
||||
</IndexTerm><IndexTerm>
|
||||
<Primary>DtEditor functions</Primary>
|
||||
<Secondary>DtEditorInvokeSpellDialog</Secondary>
|
||||
</IndexTerm></RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorInvokeSpellDialog</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorInvokeSpellDialog</Function> function displays the Spell dialog for the DtEditor widget.
|
||||
This dialog displays
|
||||
the list of unrecognized or misspelled words from the widget's text.
|
||||
Users can search for and replace misspelled words
|
||||
with the Spell dialog.
|
||||
The list of misspelled words is automatically generated by filtering the
|
||||
text for the DtEditor widget through the filter specified by the
|
||||
<SystemItem Class="Resource">DtNspellFilter</SystemItem> resource when
|
||||
<Function>DtEditorInvokeSpellDialog</Function> is called.
|
||||
For a complete description of the Spell dialog and
|
||||
the
|
||||
<SystemItem Class="Resource">DtNspellFilter</SystemItem> resource, see
|
||||
&cdeman.DtEditor;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>For a complete definition of the DtEditor widget and its associated resources, see
|
||||
&cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorInvokeSpellDialog</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem> if the widget successfully executed the spell filter; otherwise,
|
||||
it returns one of the following:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_SPELL_FILTER_FAILED</Term>
|
||||
<ListItem>
|
||||
<Para>If it cannot successfully execute the filter specified by the
|
||||
<Symbol>DtNspellfilter</Symbol> resource.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_TMP_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>If it cannot create a temporary file in the directory returned by
|
||||
<Filename MoreInfo="RefEntry">tmpnam</Filename>(3S).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, <Filename MoreInfo="RefEntry">tmpnam</Filename>(3S).</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
70
cde/doc/C/guides/man/m3_Dt/EdPasteF.sgm
Normal file
70
cde/doc/C/guides/man/m3_Dt/EdPasteF.sgm
Normal file
@@ -0,0 +1,70 @@
|
||||
<!-- $XConsortium: EdPasteF.sgm /main/5 1996/08/30 13:01:09 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN34.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN34.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorPasteFromClipboard</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorPasteFromClipboard</Function></RefName>
|
||||
<RefPurpose>insert the clipboard selection into a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorPasteFromClipboard</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorPasteFromClipboard</Function> function inserts the clipboard selection before the insertion cursor of the
|
||||
DtEditor widget.
|
||||
If the insertion cursor is inside the current selection,
|
||||
the clipboard selection replaces the selected text.
|
||||
Text can be cut or copied to the clipboard with
|
||||
&cdeman.DtEditorCutToClipboard; and
|
||||
&cdeman.DtEditorCopyToClipboard;. Text can be selected and deselected programmatically with
|
||||
&cdeman.DtEditorSelectAll; and
|
||||
&cdeman.DtEditorDeselect;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorPasteFromClipboard</Function> function returns
|
||||
True;
|
||||
otherwise, if the widget does not own the primary selection,
|
||||
the function returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorDeselect;, &cdeman.DtEditorSelectAll;, &cdeman.DtEditorUndoEdit;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
182
cde/doc/C/guides/man/m3_Dt/EdReplFF.sgm
Normal file
182
cde/doc/C/guides/man/m3_Dt/EdReplFF.sgm
Normal file
@@ -0,0 +1,182 @@
|
||||
<!-- $XConsortium: EdReplFF.sgm /main/5 1996/08/30 13:01:18 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN36.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN36.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorReplaceFromFile</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorReplaceFromFile</Function></RefName>
|
||||
<RefPurpose>replace a portion of the contents of a DtEditor widget with the contents of a file
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorReplaceFromFile</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>XmTextPosition <Parameter>startPos</Parameter></ParamDef>
|
||||
<ParamDef>XmTextPosition <Parameter>endPos</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>fileName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorReplaceFromFile</Function> function
|
||||
replaces part of the contents of a DtEditor widget
|
||||
with the contents of a file.
|
||||
All data following the start position
|
||||
and up to, but not including, the end position is replaced.
|
||||
If the start position and the end position are equal, the
|
||||
data is inserted after the end position.
|
||||
The character positions begin at zero and are numbered sequentially
|
||||
from the beginning of the text.
|
||||
After the replacement, the insertion cursor is positioned after the
|
||||
last character inserted.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">startPos</Symbol> argument specifies the starting character position of
|
||||
the portion to replace.
|
||||
The replacement begins
|
||||
at this character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">endPos</Symbol> argument specifies the ending character position of
|
||||
the portion to replace.
|
||||
The replacement ends
|
||||
before this character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>fileName</Emphasis> argument is the pathname of the file
|
||||
relative to the local system.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorReplaceFromFile</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The file is readable and writable.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_READ_ONLY_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is read only.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>The file contained embedded
|
||||
<SystemItem Class="Constant">NULL</SystemItem> characters, which were removed.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if it cannot insert the data into the DtEditor widget,
|
||||
the function
|
||||
returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_RANGE</Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">startPos</Symbol> argument is greater than the
|
||||
<Symbol Role="Variable">endPos</Symbol> argument.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NONEXISTENT_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file does not exist.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_DIRECTORY</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a directory.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a character-special device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_BLOCK_MODE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a block-mode device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_FILE_ACCESS</Term>
|
||||
<ListItem>
|
||||
<Para>The file cannot be accessed.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to replace the data.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_UNREADABLE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is unreadable for an unspecified reason.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in memory, rather than a disk file, the application should
|
||||
use
|
||||
&cdeman.DtEditorReplace;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
199
cde/doc/C/guides/man/m3_Dt/EdReplac.sgm
Normal file
199
cde/doc/C/guides/man/m3_Dt/EdReplac.sgm
Normal file
@@ -0,0 +1,199 @@
|
||||
<!-- $XConsortium: EdReplac.sgm /main/6 1996/09/08 20:03:38 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN35.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN35.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorReplace</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorReplace</Function></RefName>
|
||||
<RefPurpose>replace a portion of the contents of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorReplace</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>XmTextPosition <Parameter>startPos</Parameter></ParamDef>
|
||||
<ParamDef>XmTextPosition <Parameter>endPos</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorContentRec *<Parameter>data</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorReplace</Function> function replaces part of the contents of a DtEditor widget with a string,
|
||||
a wide character string or sized buffer.
|
||||
The data is transferred to the
|
||||
DtEditor widget using a
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, which indicates the
|
||||
type of data being transferred along with the actual data.
|
||||
All data following the start position
|
||||
and up to, but not including, the end position is replaced.
|
||||
If the start position and the end position are equal, the
|
||||
data is inserted after the end position.
|
||||
The character positions begin at zero and are numbered sequentially
|
||||
from the beginning of the text.
|
||||
After the replacement, the insertion cursor is positioned after the
|
||||
last character inserted.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">startPos</Symbol> argument specifies the starting character position of
|
||||
the portion to replace.
|
||||
The replacement begins
|
||||
at this character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">endPos</Symbol> argument specifies the ending character position of
|
||||
the portion to replace.
|
||||
The replacement ends
|
||||
before this character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument is a pointer to the data structure
|
||||
containing the data to insert.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorReplace</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, if it cannot
|
||||
replace the string, the function returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorReplace</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The data was replaced sucessfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>NULL characters were found and removed from the data.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if
|
||||
the
|
||||
<Function>DtEditorReplace</Function> function
|
||||
cannot replace the data in the DtEditor widget,
|
||||
it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_TYPE</Term>
|
||||
<ListItem>
|
||||
<Para>The Type field is not recognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_RANGE</Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">startPos</Symbol> argument is greater than the
|
||||
<Symbol Role="Variable">endPos</Symbol> argument.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the buffer passed in is negative.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULL_ITEM</Term>
|
||||
<ListItem>
|
||||
<Para>The data buffer is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. <![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to replace the data.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment modifies the contents of a
|
||||
DtEditor widget to ``The quick fox.''
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor;
|
||||
DtEditorContentRec cr;
|
||||
DtEditorErrorCode status;
|
||||
XmTextPosition start = (XmTextPosition) 4,
|
||||
end = (XmTextPosition) 9;
|
||||
char *sampleString1="The brown fox",
|
||||
*sampleString2="quick";
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.value.string = sampleString1;
|
||||
status = DtEditorSetContents(editor, &cr);
|
||||
<![ %CDE.C.XO; [if (status != DtEDITOR_NO_ERRORS) {
|
||||
]]><![ %CDE.C.CDE; [if (status != DtEDITOR_NO_ERRORS && status != DtEDITOR_NULLS_REMOVED) {
|
||||
]]> printf("Unable to set contents of the widget\n");
|
||||
} else {
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.data.string = sampleString2;
|
||||
status = DtEditorReplace(editor, start, end, &cr);
|
||||
if (status != DtEDITOR_NO_ERRORS)
|
||||
printf("Unable to replace part of the widget contents\n");
|
||||
}
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in a disk file, rather than in memory, the application should
|
||||
use
|
||||
&cdeman.DtEditorReplaceFromFile;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
69
cde/doc/C/guides/man/m3_Dt/EdReset.sgm
Normal file
69
cde/doc/C/guides/man/m3_Dt/EdReset.sgm
Normal file
@@ -0,0 +1,69 @@
|
||||
<!-- $XConsortium: EdReset.sgm /main/5 1996/08/30 13:01:37 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN37.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN37.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorReset</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorReset</Function></RefName>
|
||||
<RefPurpose>reset a DtEditor widget to its default state
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorReset</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorReset</Function> function deletes the contents of a DtEditor widget,
|
||||
resets the undo edit function, clears the last string searched for plus
|
||||
the last replacement string.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorReset</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorReset</Function> is analogous to destroying a DtEditor widget and creating a new one
|
||||
with the current resource settings.
|
||||
It is useful when reusing a DtEditor widget.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
217
cde/doc/C/guides/man/m3_Dt/EdSaveCo.sgm
Normal file
217
cde/doc/C/guides/man/m3_Dt/EdSaveCo.sgm
Normal file
@@ -0,0 +1,217 @@
|
||||
<!-- $XConsortium: EdSaveCo.sgm /main/6 1996/09/08 20:03:47 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN38.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN38.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorSaveContentsToFile</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorSaveContentsToFile</Function></RefName>
|
||||
<RefPurpose>save the contents of a DtEditor widget to a file
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorSaveContentsToFile</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>fileName</Parameter></ParamDef>
|
||||
<ParamDef>Boolean <Parameter>overwriteIfExists</Parameter></ParamDef>
|
||||
<ParamDef>Boolean <Parameter>hardCarriageReturns</Parameter></ParamDef>
|
||||
<ParamDef>Boolean <Parameter>markContentsAsSaved</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorSaveContentsToFile</Function> function saves the entire contents of the DtEditor widget to a file,
|
||||
optionally replacing soft line feeds (word wraps)
|
||||
with
|
||||
<KeySym>newline</KeySym>s. If the file does not exist and the directory has the correct
|
||||
write permissions, the file is created.
|
||||
If the file exists and the
|
||||
<Emphasis>overwriteIfExists</Emphasis> argument is set to
|
||||
True,
|
||||
the contents of the file are overwritten.
|
||||
If the file or its directory does not have the correct write
|
||||
permissions, an error is returned.
|
||||
</Para>
|
||||
<Para>The DtEditor widget tracks whether its contents have changed since they were
|
||||
last saved or retrieved.
|
||||
If the
|
||||
<Emphasis>markContentsAsSaved</Emphasis> argument is set to False,
|
||||
a copy of the data is saved without affecting whether
|
||||
&cdeman.DtEditorCheckForUnsavedChanges; reports that there are unsaved changes.
|
||||
This is useful if the application needs to save a copy of the
|
||||
contents to a temporary file.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>fileName</Emphasis> argument is the pathname of the file
|
||||
relative to the local system.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>overwriteIfExists</Emphasis> argument, if set to
|
||||
True,
|
||||
causes
|
||||
<Function>DtEditorSaveContentsToFile</Function> to save the widget contents even though the file specified by the
|
||||
<Emphasis>fileName</Emphasis> argument exists and has correct write permissions.
|
||||
If this argument is set to
|
||||
False,
|
||||
<Function>DtEditorSaveContentsToFile</Function> returns
|
||||
<SystemItem Class="Constant">DtEDITOR_WRITABLE_FILE</SystemItem>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>hardCarriageReturns</Emphasis> argument, if set to
|
||||
True,
|
||||
indicates that the widget should replace
|
||||
any soft line feeds (word wraps) with
|
||||
<KeySym>newline</KeySym>s when saving
|
||||
the data.
|
||||
When this argument is set to
|
||||
False,
|
||||
any line wrapped because it reaches the
|
||||
right edge of the window, is saved as one complete line.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>markContentsAsSaved</Emphasis> argument, when set to
|
||||
True,
|
||||
causes the DtEditor widget to mark that
|
||||
all changes made to date have been saved.
|
||||
When this argument is set to
|
||||
False,
|
||||
the DtEditor widget
|
||||
does not change its status regarding unsaved changes.
|
||||
If an error arises during the save,
|
||||
the status does not change, regardless of the
|
||||
value of the
|
||||
<Emphasis>markContentsAsSaved</Emphasis> argument.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorSaveContentsToFile</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, if it cannot save the data to the file,
|
||||
the function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_FILENAME</Term>
|
||||
<ListItem>
|
||||
<Para>No file was specified.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_UNWRITABLE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The application does not have write
|
||||
permission for the file or directory.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a device-special file.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_BLOCK_MODE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a block-mode device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_FILE_ACCESS</Term>
|
||||
<ListItem>
|
||||
<Para>The file cannot be accessed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_SAVE_FAILED</Term>
|
||||
<ListItem>
|
||||
<Para>The contents could not be saved for an
|
||||
unspecified reason.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_WRITABLE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The named files exist and the
|
||||
<Emphasis>overwriteIfExists</Emphasis> argument is set to
|
||||
False.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment saves the contents
|
||||
of a DtEditor widget to the local file, Foo, substituting
|
||||
<KeySym>newline</KeySym>s for soft line feeds.
|
||||
It also indicates that all changes
|
||||
to the contents of the widget have been saved.
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor;
|
||||
DtEditorErrorCode status;
|
||||
char *fname = "Foo";
|
||||
Boolean overwrite = False,
|
||||
hardReturns = True,
|
||||
markContentsAsSaved = True;
|
||||
status = DtEditorSaveContentsToFile(editor, fname, overwrite,
|
||||
hardReturns, markContentsAsSaved);
|
||||
switch(status)
|
||||
{
|
||||
case DtEDITOR_NO_ERRORS:
|
||||
break;
|
||||
case DtEDITOR_WRITABLE_FILE:
|
||||
printf("Save failed. The file already exists.\n");
|
||||
break;
|
||||
default:
|
||||
printf("Could not save contents.\n");
|
||||
break;
|
||||
}
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The application should use
|
||||
&cdeman.DtEditorGetContents; to retrieve the data in a memory buffer,
|
||||
rather than a disk file.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorCheckForUnsavedChanges;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSetContentsFromFile;, &cdeman.DtEditorSetContents;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
65
cde/doc/C/guides/man/m3_Dt/EdSelect.sgm
Normal file
65
cde/doc/C/guides/man/m3_Dt/EdSelect.sgm
Normal file
@@ -0,0 +1,65 @@
|
||||
<!-- $XConsortium: EdSelect.sgm /main/5 1996/08/30 13:01:54 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN39.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN39.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorSelectAll</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorSelectAll</Function></RefName>
|
||||
<RefPurpose>select all text in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorSelectAll</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorSelectAll</Function> function selects all text in a DtEditor widget.
|
||||
Any current selection
|
||||
can be programmatically deselected with
|
||||
&cdeman.DtEditorDeselect;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorSelectAll</Function> function returns
|
||||
True;
|
||||
otherwise, if it is unable to gain
|
||||
ownership of the clipboard selection it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorClearSelection;, &cdeman.DtEditorCopyToClipboard;, &cdeman.DtEditorCutToClipboard;, &cdeman.DtEditorDeleteSelection;, &cdeman.DtEditorDeselect;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
154
cde/doc/C/guides/man/m3_Dt/EdSetCFF.sgm
Normal file
154
cde/doc/C/guides/man/m3_Dt/EdSetCFF.sgm
Normal file
@@ -0,0 +1,154 @@
|
||||
<!-- $XConsortium: EdSetCFF.sgm /main/5 1996/08/30 13:02:03 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN41.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN41.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorSetContentsFromFile</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorSetContentsFromFile</Function></RefName>
|
||||
<RefPurpose>load data from a file into a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorSetContentsFromFile</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>fileName</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorSetContentsFromFile</Function> function loads the contents of a file into a
|
||||
DtEditor widget.
|
||||
Any data currently in the DtEditor widget is lost.
|
||||
After the data is loaded, the insertion cursor is positioned at the
|
||||
first character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>fileName</Emphasis> argument is the pathname of the file
|
||||
relative to the local system.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorSetContentsFromFile</Function> function returns one of the following values
|
||||
when it successfully loads the data into the DtEditor widget:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The file is readable and writable.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_READ_ONLY_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is read only.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>The file contained embedded
|
||||
<SystemItem Class="Constant">NULL</SystemItem> characters, which were removed.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if it cannot load the data into the DtEditor widget,
|
||||
the function
|
||||
returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NONEXISTENT_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file does not exist.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_DIRECTORY</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a directory.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_CHAR_SPECIAL_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a character-special device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_BLOCK_MODE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is a block-mode device.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_FILE_ACCESS</Term>
|
||||
<ListItem>
|
||||
<Para>The file cannot be accessed.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to load the file.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_UNREADABLE_FILE</Term>
|
||||
<ListItem>
|
||||
<Para>The file is unreadable for an unspecified reason.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in memory, rather than a disk file, the application should
|
||||
use
|
||||
&cdeman.DtEditorSetContents;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContents;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
161
cde/doc/C/guides/man/m3_Dt/EdSetCon.sgm
Normal file
161
cde/doc/C/guides/man/m3_Dt/EdSetCon.sgm
Normal file
@@ -0,0 +1,161 @@
|
||||
<!-- $XConsortium: EdSetCon.sgm /main/6 1996/09/08 20:03:55 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN40.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN40.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorSetContents</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorSetContents</Function></RefName>
|
||||
<RefPurpose>place data into a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtEditorErrorCode <Function>DtEditorSetContents</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>DtEditorContentRec *<Parameter>data</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorSetContents</Function> function places a
|
||||
<SystemItem Class="Constant">NULL</SystemItem>−terminated string, wide character string
|
||||
or sized buffer into a DtEditor widget.
|
||||
Any data currently in the DtEditor widget is lost.
|
||||
The data is transferred to the
|
||||
DtEditor widget using a
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, which indicates the
|
||||
type of data being transferred along with the actual data.
|
||||
After the data is placed into the DtEditor widget, the insertion cursor is
|
||||
positioned at the first character.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">data</Symbol> argument is a pointer to a data structure containing
|
||||
the new contents of
|
||||
<Symbol Role="Variable">widget</Symbol>. <![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
<Para>For a complete definition of
|
||||
<StructName Role="typedef">DtEditorContentRec</StructName>, see
|
||||
&cdeman.Dt.Editor.h;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorSetContents</Function> function returns
|
||||
<SystemItem Class="Constant">DtEDITOR_NO_ERRORS</SystemItem>; otherwise, it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorSetContents</Function> function returns one of the following values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NO_ERRORS</Term>
|
||||
<ListItem>
|
||||
<Para>The data was loaded sucessfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULLS_REMOVED</Term>
|
||||
<ListItem>
|
||||
<Para>NULL characters were found and removed from the data.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>Otherwise, if
|
||||
the
|
||||
<Function>DtEditorSetContents</Function> function
|
||||
cannot load the data in the DtEditor widget,
|
||||
it returns one of the following values:
|
||||
</Para>
|
||||
]]>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INVALID_TYPE</Term>
|
||||
<ListItem>
|
||||
<Para>The Type field is unrecognized.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_ILLEGAL_SIZE</Term>
|
||||
<ListItem>
|
||||
<Para>The size of the buffer passed in is negative.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_NULL_ITEM</Term>
|
||||
<ListItem>
|
||||
<Para>The buffer is
|
||||
<SystemItem Class="Constant">NULL</SystemItem>. <![ %CDE.C.CDE; [</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtEDITOR_INSUFFICIENT_MEMORY</Term>
|
||||
<ListItem>
|
||||
<Para>Not enough system memory is available to load the data.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>The following code segment sets the contents of a DtEditor
|
||||
widget to ``The quick brown fox.''
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>Widget editor;
|
||||
DtEditorContentRec cr;
|
||||
DtEditorErrorCode status;
|
||||
char *sampleString="The quick brown fox";
|
||||
cr.type = DtEDITOR_TEXT;
|
||||
cr.value.string = sampleString;
|
||||
status = DtEditorSetContents(editor, &cr);
|
||||
<![ %CDE.C.XO; [if (status != DtEDITOR_NO_ERRORS) {
|
||||
]]><![ %CDE.C.CDE; [if (status != DtEDITOR_NO_ERRORS && status != DtEDITOR_NULLS_REMOVED) {
|
||||
]]> printf("Unable to set contents of the widget\n");
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>If the data is in a disk file, rather than in memory, the application should
|
||||
use
|
||||
&cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorAppend;, &cdeman.DtEditorAppendFromFile;, &cdeman.DtEditorGetContents;, &cdeman.DtEditorInsert;, &cdeman.DtEditorInsertFromFile;, &cdeman.DtEditorReplace;, &cdeman.DtEditorReplaceFromFile;, &cdeman.DtEditorSaveContentsToFile;, &cdeman.DtEditorSetContentsFromFile;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
72
cde/doc/C/guides/man/m3_Dt/EdSetIns.sgm
Normal file
72
cde/doc/C/guides/man/m3_Dt/EdSetIns.sgm
Normal file
@@ -0,0 +1,72 @@
|
||||
<!-- $XConsortium: EdSetIns.sgm /main/5 1996/08/30 13:02:38 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN42.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN42.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorSetInsertionPosition</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorSetInsertionPosition</Function></RefName>
|
||||
<RefPurpose>set the position of the insert cursor in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorSetInsertionPosition</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>XmTextPosition <Parameter>position</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorSetInsertionPosition</Function> function sets the insertion cursor position of the DtEditor widget.
|
||||
The current position of the insertion cursor can be retrieved with
|
||||
&cdeman.DtEditorGetInsertionPosition;. The last text position of the DtEditor widget can be retrieved with
|
||||
&cdeman.DtEditorGetLastPosition;.</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">position</Symbol> argument specifies the position of the insertion
|
||||
cursor.
|
||||
This is an integer number of characters from the beginning of
|
||||
the text buffer.
|
||||
The first character position is zero.
|
||||
Values greater
|
||||
than the last position place the cursor at the last
|
||||
position (that is, at the end of the text).
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorSetInsertionPosition</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorGetInsertionPosition;, &cdeman.DtEditorGetLastPosition;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
60
cde/doc/C/guides/man/m3_Dt/EdTraver.sgm
Normal file
60
cde/doc/C/guides/man/m3_Dt/EdTraver.sgm
Normal file
@@ -0,0 +1,60 @@
|
||||
<!-- $XConsortium: EdTraver.sgm /main/5 1996/08/30 13:02:48 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN43.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN43.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorTraverseToEditor</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorTraverseToEditor</Function></RefName>
|
||||
<RefPurpose>set keyboard traversal to the edit window of a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtEditorTraverseToEditor</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorTraverseToEditor</Function> function causes the Motif keyboard traversal
|
||||
to be set to the edit window of a DtEditor widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorTraverseToEditor</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
74
cde/doc/C/guides/man/m3_Dt/EdUndoEd.sgm
Normal file
74
cde/doc/C/guides/man/m3_Dt/EdUndoEd.sgm
Normal file
@@ -0,0 +1,74 @@
|
||||
<!-- $XConsortium: EdUndoEd.sgm /main/5 1996/08/30 13:02:57 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN44.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN44.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtEditorUndoEdit</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtEditorUndoEdit</Function></RefName>
|
||||
<RefPurpose>undo the last edit made to the text in a DtEditor widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Editor.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtEditorUndoEdit</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtEditorUndoEdit</Function> function undoes the last change (deletion or insertion) made
|
||||
to the text in a DtEditor widget.
|
||||
A change consists of either a set of
|
||||
consecutive insertions, or a set of consecutive deletions followed by up
|
||||
to one set of consecutive insertions.
|
||||
An insertion is consecutive if there have been no intervening deletions,
|
||||
and it is continuing forward from the same point.
|
||||
A deletion is consecutive if there have been no intervening insertions,
|
||||
and its start or end position is coincidental with the last deletion
|
||||
(that is, the deletion is continuing from the same point, either forward or
|
||||
backward).
|
||||
Undoing an edit once restores the original text.
|
||||
Undoing an edit twice restores the last change.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>For a complete definition of the DtEditor widget
|
||||
and its associated resources, see
|
||||
&cdeman.DtEditor;. ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtEditorUndoEdit</Function> function returns
|
||||
True;
|
||||
otherwise, if there is no pending undo it returns
|
||||
False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
2663
cde/doc/C/guides/man/m3_Dt/Editor.sgm
Normal file
2663
cde/doc/C/guides/man/m3_Dt/Editor.sgm
Normal file
File diff suppressed because it is too large
Load Diff
1194
cde/doc/C/guides/man/m3_Dt/HelpDial.sgm
Normal file
1194
cde/doc/C/guides/man/m3_Dt/HelpDial.sgm
Normal file
File diff suppressed because it is too large
Load Diff
81
cde/doc/C/guides/man/m3_Dt/HelpQDGC.sgm
Normal file
81
cde/doc/C/guides/man/m3_Dt/HelpQDGC.sgm
Normal file
@@ -0,0 +1,81 @@
|
||||
<!-- $XConsortium: HelpQDGC.sgm /main/6 1996/09/08 20:04:30 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN47.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN47.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtHelpQuickDialogGetChild</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtHelpQuickDialogGetChild</Function></RefName>
|
||||
<RefPurpose>get child of DtHelpQuickDialog widget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/HelpQuickD.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Widget <Function>DtHelpQuickDialogGetChild</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>int <Parameter>child</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtHelpQuickDialogGetChild</Function> function accesses a component within a
|
||||
DtHelpQuickDialog
|
||||
widget.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument specifies the
|
||||
DtHelpQuickDialog
|
||||
widget instance.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">child</Symbol> argument specifies which
|
||||
DtHelpQuickDialog
|
||||
widget child the widget ID is for.
|
||||
The following are valid values for the
|
||||
<Symbol Role="Variable">child</Symbol> argument:
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing><SystemItem Class="Constant">DtHELP_QUICK_CLOSE_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_PRINT_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_HELP_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_SEPARATOR</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_MORE_BUTTON</SystemItem> <SystemItem Class="Constant">DtHELP_QUICK_BACK_BUTTON</SystemItem></ProgramListing>
|
||||
</InformalExample>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtHelpQuickDialogGetChild</Function> function returns the widget ID of the requested child of the
|
||||
DtHelpQuickDialog
|
||||
widget; otherwise, it returns
|
||||
<SystemItem Class="Constant">NULL</SystemItem> if either the function call fails, or an invalid value was passed in for
|
||||
the
|
||||
<Symbol Role="Variable">child</Symbol> argument.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>If an invalid child type is given,
|
||||
a warning message is generated:
|
||||
``Non-valid Quick Help child type.''
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.HelpQuickD.h;, &cdeman.DtCreateHelpQuickDialog;; <![ %CDE.C.CDE; [&cdeman.XmeWarning;. ]]><![ %CDE.C.XO; [<Emphasis>XmWarning</Emphasis> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
1623
cde/doc/C/guides/man/m3_Dt/HelpQDia.sgm
Normal file
1623
cde/doc/C/guides/man/m3_Dt/HelpQDia.sgm
Normal file
File diff suppressed because it is too large
Load Diff
129
cde/doc/C/guides/man/m3_Dt/HelpRetu.sgm
Normal file
129
cde/doc/C/guides/man/m3_Dt/HelpRetu.sgm
Normal file
@@ -0,0 +1,129 @@
|
||||
<!-- $XConsortium: HelpRetu.sgm /main/6 1996/08/30 13:03:58 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN48.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN48.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtHelpReturnSelectedWidgetId</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtHelpReturnSelectedWidgetId</Function></RefName>
|
||||
<RefPurpose>select a widget or gadget
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Help.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>int <Function>DtHelpReturnSelectedWidgetId</Function></FuncDef>
|
||||
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
|
||||
<ParamDef>String <Parameter>cursor</Parameter></ParamDef>
|
||||
<ParamDef>Widget *<Parameter>widget</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtHelpReturnSelectedWidgetId</Function> function provides an
|
||||
interface for users to select a component within an application.
|
||||
</Para>
|
||||
<Para>This function
|
||||
grabs the pointer and returns the widget within which a button press occurs.
|
||||
Pressing the escape key (ESC) aborts this function.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">parent</Symbol> argument specifies the widget ID to use as the basis
|
||||
of the interaction, usually a top level shell.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">cursor</Symbol> argument specifies the cursor to be used for the pointer
|
||||
during the interaction.
|
||||
If a
|
||||
<SystemItem Class="Constant">NULL</SystemItem> value is used,
|
||||
<Function>DtHelpReturnSelectedWidgetId</Function> uses a default cursor value.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Symbol Role="Variable">widget</Symbol> argument is the return value (for example, the
|
||||
selected widget).
|
||||
A
|
||||
<SystemItem Class="Constant">NULL</SystemItem> value is returned on error.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Function>DtHelpReturnSelectedWidgetId</Function> function allows applications to get the widget ID for
|
||||
any widget in their user interface that the user has selected via the
|
||||
pointer.
|
||||
The application can then directly display a
|
||||
help topic based on the selected widget, or dynamically
|
||||
construct some help information based on the current context of the selected
|
||||
item.
|
||||
At any point while the question mark cursor is displayed, the user can
|
||||
select the escape key to abort the function call, and a
|
||||
<SystemItem Class="Constant">NULL</SystemItem> value is returned.
|
||||
If the user selects any
|
||||
item outside the current applications windows, an error status is
|
||||
returned along with a
|
||||
<SystemItem Class="Constant">NULL</SystemItem> value for the
|
||||
<Symbol Role="Variable">widget</Symbol> argument.
|
||||
<![ %CDE.C.CDE; [Refer to &cdeman.XmTrackingLocate; for a similar function.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>Upon successful completion, the
|
||||
<Function>DtHelpReturnSelectedWidgetId</Function> function returns one of the following status values:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>DtHELP_SELECT_ERROR</Term>
|
||||
<ListItem>
|
||||
<Para>An error occurred while attempting to process the function.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtHELP_SELECT_INVALID</Term>
|
||||
<ListItem>
|
||||
<Para>The user selected an invalid component that is not contained
|
||||
in the current widget hierarchy.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtHELP_SELECT_ABORT</Term>
|
||||
<ListItem>
|
||||
<Para>The user aborted the function (for example, pressed the escape key), and a
|
||||
<SystemItem Class="Constant">NULL</SystemItem> widget value is passed back.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>DtHELP_SELECT_VALID</Term>
|
||||
<ListItem>
|
||||
<Para>The user selected a valid component within the application, and the
|
||||
<Symbol Role="Variable">widget</Symbol> argument is the ID of the selected component.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Help.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;; <![ %CDE.C.CDE; [&cdeman.XmTrackingLocate;, ]]><![ %CDE.C.XO; [<Function>XmTrackingLocate</Function> in the &str-ZM;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
80
cde/doc/C/guides/man/m3_Dt/HelpSetC.sgm
Normal file
80
cde/doc/C/guides/man/m3_Dt/HelpSetC.sgm
Normal file
@@ -0,0 +1,80 @@
|
||||
<!-- $XConsortium: HelpSetC.sgm /main/5 1996/08/30 13:04:07 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN49.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN49.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtHelpSetCatalogName</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtHelpSetCatalogName</Function></RefName>
|
||||
<RefPurpose>assign the name of the message catalog to use for help services
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- CDE Common Source Format, Version 1.0.0-->
|
||||
<!-- *************************************************************************-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
|
||||
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
|
||||
<!-- *************************************************************************-->
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Help.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtHelpSetCatalogName</Function></FuncDef>
|
||||
<ParamDef>char *<Parameter>catFile</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtHelpSetCatalogName</Function> function provides an interface for applications to set
|
||||
the name of the message catalog file that the
|
||||
help services library uses at runtime.
|
||||
This message catalog contains all
|
||||
strings, messages and button labels used in the help widgets
|
||||
that can be localized.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Emphasis>catFile</Emphasis> argument specifies the name of the message catalog file that
|
||||
the help services library accesses at runtime.
|
||||
See
|
||||
<Function>catopen</Function>3C for more information on the message catalog naming and location semantics for
|
||||
various environments.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>The
|
||||
<Function>DtHelpSetCatalogName</Function> function returns no value.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The
|
||||
<Function>DtHelpSetCatalogName</Function> function is only required if applications deliver localized online help
|
||||
information into a non-localized &str-XZ; desktop environment.
|
||||
In this case,
|
||||
applications must use this function and give the help message
|
||||
catalog file a unique name in order to avoid collision with other clients
|
||||
using and localizing their online-help user interface.
|
||||
In order for this call to properly affect the help services library,
|
||||
this call must be
|
||||
made prior to creation of any help widgets.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.Dt.Help.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtCreateHelpDialog;; <![ %CDE.C.CDE; [<Function>catopen</Function>3C. ]]><![ %CDE.C.XO; [<Function>catopen</Function> in the &str-ZK;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
|
||||
156
cde/doc/C/guides/man/m3_Dt/InfoShow.sgm
Normal file
156
cde/doc/C/guides/man/m3_Dt/InfoShow.sgm
Normal file
@@ -0,0 +1,156 @@
|
||||
<!-- $XConsortium: InfoShow.sgm /main/2 1996/09/20 11:10:27 cdedoc $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDE.INFO.showtopic">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.INFO.showtopic">]]>
|
||||
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtInfoShowTopic</RefEntryTitle>
|
||||
<ManVolNum>API</ManVolNum>
|
||||
</RefMeta>
|
||||
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtInfoShowTopic</Function></RefName>
|
||||
<RefPurpose>provide the user access to a local information corpus at a specific location
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Info.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>DtIfnoShowStatus <Function>DtInfoShowTopic</Function></FuncDef>
|
||||
<ParamDef>const char <Parameter>*info_lib</Parameter></ParamDef>
|
||||
<ParamDef>const char <Parameter>*locator</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
|
||||
<para>
|
||||
By invoking <Function>DtInfoShowTopic</Function>, a client application requests that dtinfo display a
|
||||
particular section of data, or topic. <Function>DtInfoShowTopic</Function> sends a ToolTalk message
|
||||
to any active dtinfo process that can access the
|
||||
requested information in the current locale. The browser is started if it is not already running. This
|
||||
corresponds to invoking the <command>dtinfo</command> command with the <option>-sect</option> option from the command line.
|
||||
</para>
|
||||
<para>
|
||||
The locator parameter must be a valid, resolvable location in the specified or default infolib for dtinfo to
|
||||
display the location. Unfortunately, there is no way to determine this from the calling application as
|
||||
<function>DtInfoShowTopic</function> will return an ok status as long as the message has been delivered to dtinfo. In the
|
||||
case of an invalid locator, dtinfo will still map to the current workspace of the invoking application and
|
||||
display an error dialog.
|
||||
</para>
|
||||
<para>
|
||||
This API is implemented in the Desktop Services library, <literal>DtSvc</literal>. To access the DtShowInfoTopic
|
||||
API, include the header file <filename>Dt/Info.h</filename> and link with <literal>-lDtSvc</literal>.
|
||||
</para>
|
||||
</RefSect1>
|
||||
|
||||
<refsect1>
|
||||
<Title>ARGUMENTS</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><symbol role="Variable">*info_lib</symbol></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Specifies a file path, relative or absolute, to an information library. If
|
||||
<symbol role="Variable">info_lib</symbol> is NULL, the browser displays the default information library(s).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><symbol role="Variable">*locator</symbol></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Specifies the information library section in generalized locator format.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">DtINFO_SHOW_OK</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
ToolTalk request succesfully sent.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">DtINFO_SHOW_BAD_LOCATOR</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
The locator argument is NULL.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">DtINFO_SHOW_TT_OPEN_FAIL</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Call to <function>tt_open()</function> failed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">DtINFO_SHOW_MSG_CREATE_FAIL</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Call to <function>tt_message_create()</function> failed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">DtINFO_SHOW_MSG_SEND_FAIL</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Call to <function>tt_message_send()</function> failed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</variablelist>
|
||||
</RefSect1>
|
||||
|
||||
<refsect1>
|
||||
<title>ENVIRONMENT</title>
|
||||
<variablelist>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="environvar">DTINFOLIBSEARCHPATH</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Search path environment variable for locating information libraries on
|
||||
local and remote mounted systems.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="environvar">DTINFOLIBDEFAULT</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>
|
||||
Specifies the name of the default information library(s) to load if the
|
||||
locator argument is NULL. Multiple information libraries can be
|
||||
specified by a comma separated list.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</variablelist>
|
||||
</RefSect1>
|
||||
|
||||
</RefEntry>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
74
cde/doc/C/guides/man/m3_Dt/Initiali.sgm
Normal file
74
cde/doc/C/guides/man/m3_Dt/Initiali.sgm
Normal file
@@ -0,0 +1,74 @@
|
||||
<!-- $XConsortium: Initiali.sgm /main/8 1996/09/04 15:34:02 cdedoc $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN47.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN47.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtInitialize</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtInitialize</Function>,
|
||||
<Function>DtAppInitialize</Function>
|
||||
</RefName>
|
||||
<RefPurpose>initialize the Desktop Services library
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis Remap="ANSI">
|
||||
<FuncSynopsisInfo>#include <Dt/Dt.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>Boolean <Function>DtInitialize</Function></FuncDef>
|
||||
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>tool_class</Parameter></ParamDef>
|
||||
<FuncDef>Boolean <Function>DtAppInitialize</Function></FuncDef>
|
||||
<ParamDef>XtAppContext <Parameter>app_context</Parameter></ParamDef>
|
||||
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
|
||||
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>name</Parameter></ParamDef>
|
||||
<ParamDef>char *<Parameter>tool_class</Parameter></ParamDef>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>These functions perform the one-time initialization in the
|
||||
Desktop Services library.
|
||||
Applications must call either
|
||||
<Function>DtInitialize</Function> or
|
||||
<Function>DtAppInitialize</Function> before calling any other Desktop Services library routines.
|
||||
</Para>
|
||||
<Para>The difference between these two functions is whether
|
||||
<Emphasis>app_context</Emphasis> is specified.
|
||||
<Function>DtInitialize</Function> uses the default Intrinsic
|
||||
<StructName Role="typedef">XtAppContext</StructName>.</Para>
|
||||
<Para>The
|
||||
<Emphasis>app_context</Emphasis> argument is the application context,
|
||||
<Symbol Role="Variable">display</Symbol> is the X display connection,
|
||||
<Symbol Role="Variable">widget</Symbol> is the application's top-level Widget,
|
||||
<Symbol Role="Variable">name</Symbol> is the application name and
|
||||
<Emphasis>tool_class</Emphasis> is the application class.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUES</Title>
|
||||
<Para>Upon successful completion,
|
||||
<Function>DtAppInitialize</Function> and
|
||||
<Function>DtInitialize</Function> return True if the library has been
|
||||
correctly initialized;
|
||||
otherwise, they return False.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para><Function>XtAppInitialize</Function>(3), <Function>XtToolkitInitialize</Function>(3), <![ %CDE.C.CDE; [<Function>XtCreateApplicationContext</Function>(3). ]]><![ %CDE.C.XO; [<Function>XtCreateApplicationContext</Function> in the &str-Zt;.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
513
cde/doc/C/guides/man/m3_Dt/MenuButt.sgm
Normal file
513
cde/doc/C/guides/man/m3_Dt/MenuButt.sgm
Normal file
@@ -0,0 +1,513 @@
|
||||
<!-- $XConsortium: MenuButt.sgm /main/10 1996/09/08 20:04:50 rws $ -->
|
||||
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1995 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1995 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN48.rsml.1">]]><![ %CDE.C.XO; [<refentry
|
||||
id="XCDI.MAN48.rsml.1">]]><refmeta><refentrytitle>DtMenuButton</refentrytitle>
|
||||
<manvolnum>library call</manvolnum></refmeta><refnamediv><refname><classname>DtMenuButton</classname></refname><refpurpose>the MenuButton widget class
|
||||
</refpurpose></refnamediv><!-- CDE Common Source Format, Version 1.0.0--><!--
|
||||
(c) Copyright 1993, 1994, 1995 Hewlett-Packard Company--><!-- (c) Copyright
|
||||
1993, 1994, 1995 International Business Machines Corp.--><!-- (c) Copyright
|
||||
1993, 1994, 1995 Sun Microsystems, Inc.--><!-- (c) Copyright 1993, 1994, 1995
|
||||
Novell, Inc.--><refsynopsisdiv>
|
||||
<synopsis>#include <Dt/MenuButton.h></synopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The DtMenuButton widget is a command widget that complements the menu
|
||||
cascading functionality of an XmCascadeButton widget. As a complement to the
|
||||
XmCascadeButton widget, DtMenuButton can only be instantiated outside a MenuPane;
|
||||
the application must use XmCascadeButton widget inside a MenuPane.</para>
|
||||
<para>The DtMenuButton widget belongs to a subclass of the XmLabel class.
|
||||
Visually, the DtMenuButton widget consists of a label string and a menu glyph.
|
||||
The menu glyph always appears on the right end of the widget and, by default,
|
||||
is a downward pointing arrow.</para>
|
||||
<para>The DtMenuButton widget has an implicitly created submenu attached to
|
||||
it. The submenu <?Pub Caret>is a popup MenuPane and has this DtMenuButton
|
||||
widget as its parent. The name of the implicitly created submenu is obtained
|
||||
by adding <literal>submenu_</literal> as a prefix to the name of this DtMenuButton
|
||||
widget. The widget ID of the submenu can be obtained by doing an <function>XtGetValues</function> on the <systemitem class="Resource">DtNsubMenuId</systemitem>
|
||||
resource of this DtMenuButton widget. The implicitly created submenu must
|
||||
not be destroyed by the user of this widget.</para>
|
||||
<para>The submenu can be popped up by pressing the menu post Button (see the <systemitem class="Resource">XmNmenuPost</systemitem> resource of the <![ %CDE.C.CDE; [&cdeman.XmRowColumn; widget)
|
||||
]]><![ %CDE.C.XO; [XmRowColumn widget) ]]>anywhere on the DtMenuButton widget.
|
||||
</para>
|
||||
<para>Widget subclassing is not supported for the DtMenuButton widget class.
|
||||
</para>
|
||||
<refsect2>
|
||||
<title>Classes</title>
|
||||
<para>The DtMenuButton widget inherits behavior and resources from the <classname>Core</classname>, <classname>Composite</classname>, <classname>XmPrimitive</classname> and <classname>XmLabel</classname> classes.</para>
|
||||
<para>The class pointer is <Symbol>dtMenuButtonWidgetClass</Symbol>.</para>
|
||||
<para>The class name is <structname role="typedef">DtMenuButtonWidget</structname>.
|
||||
</para>
|
||||
</refsect2>
|
||||
<refsect2>
|
||||
<title>New Resources</title>
|
||||
<para>The following table defines a set of widget resources used by the application
|
||||
to specify data. The application can also set the resource values for the
|
||||
inherited classes to set attributes for this widget. To reference a resource
|
||||
by name or by class in a <Filename>.Xdefaults</Filename> file, the application
|
||||
must remove the <Symbol>DtN</Symbol> or <Symbol>DtC</Symbol> prefix and
|
||||
use the remaining letters. To specify one of the defined values for a resource
|
||||
in a <Filename>.Xdefaults</Filename> file, the application must remove the <symbol>Dt</symbol> prefix and use the remaining letters (in either lower case or
|
||||
upper case, but including any underscores between words). The codes in the
|
||||
access column indicate if the given resource can be set at creation time (C),
|
||||
set by using <function>XtSetValues</function> (S), retrieved by using <function>XtGetValues</function> (G), or is not applicable (N/A).</para>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.78in">
|
||||
<colspec align="left" colname="col1" colwidth="197*">
|
||||
<colspec align="left" colname="col2" colwidth="140*">
|
||||
<colspec align="left" colwidth="93*">
|
||||
<colspec align="left" colwidth="135*">
|
||||
<colspec align="left" colwidth="77*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>DtMenuButton Resource
|
||||
Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNcascadingCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtCallbackList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNcascadePixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtNsubMenuId</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">DtCMenuWidget</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Widget</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">SG</entry></row></tbody></tgroup></informaltable>
|
||||
<variablelist>
|
||||
<varlistentry><term><systemitem class="Resource">DtNcascadingCallback</systemitem></term>
|
||||
<listitem>
|
||||
<para>Specifies the list of callbacks that is called before the popping up
|
||||
of the attached submenu. The reason for the callback is <systemitem class="Constant">DtCR_CASCADING</systemitem>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNcascadePixmap</systemitem></term>
|
||||
<listitem>
|
||||
<para>Specifies the pixmap displayed as the menu glyph. If no pixmap is specified,
|
||||
a downward pointing arrow is displayed.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><systemitem class="Resource">DtNsubMenuId</systemitem></term>
|
||||
<listitem>
|
||||
<para>Specifies the widget ID of the popup MenuPane to be associated with
|
||||
this DtMenuButton widget. The popup MenuPane must be created with this DtMenuButton
|
||||
as its parent. This resource cannot be specified at the time of widget creation.
|
||||
The implicit submenu is automatically destroyed by DtMenuButton when this
|
||||
resource is set.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect2>
|
||||
<refsect2>
|
||||
<title>Inherited Resources</title>
|
||||
<para>The DtMenuButton widget inherits behavior and resources from the following
|
||||
named superclasses. For a complete description of each resource, see the <![ %CDE.C.CDE; [man page
|
||||
]]><![ %CDE.C.XO; [entry in &str-ZM; ]]>for that superclass.</para>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.84in">
|
||||
<colspec align="left" colname="col1" colwidth="190*">
|
||||
<colspec align="left" colname="col2" colwidth="189*">
|
||||
<colspec align="left" colwidth="100*">
|
||||
<colspec align="left" colwidth="88*">
|
||||
<colspec align="left" colwidth="80*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>XmLabel Resource
|
||||
Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNaccelerator</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCAccelerator</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">String</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNacceleratorText</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCAcceleratorText</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmString</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNalignment</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCAlignment</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">unsigned char</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNfontList</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCFontList</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmFontList</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNlabelInsensitivePixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCLabelInsensitivePixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNlabelPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCLabelPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNlabelString</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCXmString</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmString</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNlabelType</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCLabelType</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">unsigned char</StructName></entry>
|
||||
<entry align="left" valign="top">XmSTRING</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmarginBottom</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMarginBottom</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmarginHeight</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMarginHeight</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">2</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmarginLeft</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMarginLeft</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmarginRight</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMarginRight</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmarginTop</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMarginTop</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmarginWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMarginWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">2</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmnemonic</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMnemonic</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">KeySym</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmnemonicCharSet</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMnemonicCharSet</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">String</structname></entry>
|
||||
<entry align="left" valign="top">XmFONTLIST-_DEFAULT_TAG</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNrecomputeSize</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCRecomputeSize</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNstringDirection</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCStringDirection</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmStringDirection</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row></tbody></tgroup></informaltable>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.93in">
|
||||
<colspec align="left" colname="col1" colwidth="206*">
|
||||
<colspec align="left" colname="col2" colwidth="200*">
|
||||
<colspec align="left" colwidth="85*">
|
||||
<colspec align="left" colwidth="85*">
|
||||
<colspec align="left" colwidth="79*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>XmPrimitive Resource
|
||||
Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbottomShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBottomShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbottomShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBottomShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNforeground</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCForeground</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhelpCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtCallbackList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhighlightColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHighlightColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhighlightOnEnter</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHighlightOnEnter</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">False</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhighlightPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHighlightPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNhighlightThickness</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHighlightThickness</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNnavigationType</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCNavigationType</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XmNavigationType</structname></entry>
|
||||
<entry align="left" valign="top">XmNONE</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNshadowThickness</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCShadowThickness</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtopShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTopShadowColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtopShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTopShadowPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtraversalOn</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTraversalOn</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">False</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNunitType</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCUnitType</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">unsigned char</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNuserData</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCUserData</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtPointer</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row></tbody></tgroup></informaltable>
|
||||
<informaltable>
|
||||
<tgroup cols="5" colsep="0" rowsep="0">
|
||||
<?PubTbl tgroup dispwid="7.85in">
|
||||
<colspec align="left" colname="col1" colwidth="197*">
|
||||
<colspec align="left" colname="col2" colwidth="191*">
|
||||
<colspec align="left" colwidth="91*">
|
||||
<colspec align="left" colwidth="90*">
|
||||
<colspec align="left" colwidth="79*">
|
||||
<spanspec nameend="col2" namest="col1" spanname="1to2">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" spanname="1to2" valign="top"><literal>Core Resource Set</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Name</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Class</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Type</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Default</literal></entry>
|
||||
<entry align="left" valign="top"><literal>Access</literal></entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNaccelerators</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCAccelerators</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtAccelerators</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNancestorSensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCSensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">G</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbackground</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBackground</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNbackgroundPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNborderColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBorderColor</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixel</structname></entry>
|
||||
<entry align="left" valign="top">XtDefaultForeground</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNborderPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPixmap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Pixmap</structname></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Constant">XmUNSPECIFIED_PIXMAP</systemitem></entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNborderWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCBorderWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNcolormap</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCColormap</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Colormap</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNdepth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCDepth</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">int</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNdestroyCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCCallback</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtCallbackList</structname></entry>
|
||||
<entry align="left" valign="top">NULL</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNheight</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCHeight</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNinitialResourcesPersistent</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCInitialResourcesPersistent</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">C</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNmappedWhenManaged</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCMappedWhenManaged</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNscreen</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCScreen</systemitem></entry>
|
||||
<entry align="left" valign="top"><StructName Role="typedef">Screen *</StructName></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNsensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCSensitive</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
|
||||
<entry align="left" valign="top">True</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNtranslations</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCTranslations</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">XtTranslations</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNwidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCWidth</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Dimension</structname></entry>
|
||||
<entry align="left" valign="top">dynamic</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNx</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Position</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmNy</systemitem></entry>
|
||||
<entry align="left" valign="top"><systemitem class="Resource">XmCPosition</systemitem></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">Position</structname></entry>
|
||||
<entry align="left" valign="top">0</entry>
|
||||
<entry align="left" valign="top">CSG</entry></row></tbody></tgroup></informaltable>
|
||||
</refsect2>
|
||||
<refsect2>
|
||||
<title>Callback Information</title>
|
||||
<para>A pointer to the following structure is passed to each DtMenuButton
|
||||
callback:</para>
|
||||
<informalexample remap="indent">
|
||||
<programlisting>typedef struct {
|
||||
int <symbol role="Variable">reason</symbol>;
|
||||
XEvent *<symbol role="Variable">event</symbol>;
|
||||
} XmAnyCallbackStruct;</programlisting>
|
||||
</informalexample>
|
||||
<para>The <symbol role="Variable">reason</symbol> argument indicates why the
|
||||
callback was invoked; it is always <systemitem class="Constant">DtCR_CASCADING</systemitem> when the <systemitem class="Resource">DtNcascadingCallback</systemitem>
|
||||
is issued.</para>
|
||||
<para>The <symbol role="Variable">event</symbol> argument points to the <structname role="typedef">XEvent</structname> that triggered the callback or <systemitem class="Constant">NULL</systemitem> if the callback was not triggered by an <structname role="typedef">XEvent</structname>.</para>
|
||||
</refsect2>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title><![ %CDE.C.CDE; [<Para>&cdeman.DtCreateMenuButton;, &cdeman.Core;, &cdeman.XmLabel;, &cdeman.XmPrimitive;, &cdeman.XmRowColumn;, <Function>XtGetValues</Function>(3), <Function>XtSetValues</Function>(3).</Para>
|
||||
]]><![ %CDE.C.XO; [<para>&cdeman.DtCreateMenuButton;; <classname>Core</classname>, <classname>XmLabel</classname>, <classname>XmPrimitive</classname>, <classname>XmRowColumn</classname>, in the &str-ZM;; <function>XtGetValues</function>, <function>XtSetValues</function> in the &str-Zt;.</para>]]></refsect1></refentry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
<?Pub *0000060897>
|
||||
56
cde/doc/C/guides/man/m3_Dt/MmdbBCFI.sgm
Normal file
56
cde/doc/C/guides/man/m3_Dt/MmdbBCFI.sgm
Normal file
@@ -0,0 +1,56 @@
|
||||
<!-- $XConsortium: MmdbBCFI.sgm /main/6 1996/09/08 20:05:00 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookCaseFreeInfo">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookCaseFreeInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookCaseFreeInfo</function></refname><refpurpose>frees space
|
||||
used by bookcase information structure
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>void <function>DtMmdbBookCaseFreeInfo</function></funcdef>
|
||||
<paramdef>DtMmdbBookCaseInfo* <parameter>x</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookCaseFreeInfo</function> function
|
||||
frees the space used by the specified bookcase information
|
||||
structure.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">x</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies a pointer to the bookcase information structure.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>None.</para>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbBookCaseFreeInfo</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtBookCaseInfo* x = DtMmdbBookCaseGetInfo(0);
|
||||
/* make use of x */
|
||||
DtMmdbBookCaseFreeInfo(x);
|
||||
/* free x */
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbBookCaseGetInfo;,
|
||||
&cdeman.DtMmdbBookCaseGetInfo;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
59
cde/doc/C/guides/man/m3_Dt/MmdbBCGI.sgm
Normal file
59
cde/doc/C/guides/man/m3_Dt/MmdbBCGI.sgm
Normal file
@@ -0,0 +1,59 @@
|
||||
<!-- $XConsortium: MmdbBCGI.sgm /main/6 1996/09/08 20:05:08 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookCaseGetInfo">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookCaseGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookCaseGetInfo</function></refname><refpurpose>obtains
|
||||
information about a bookcase</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbBookCaseInfo* <function>DtMmdbBookCaseGetInfo</function></funcdef>
|
||||
<paramdef>int <parameter>bookcase_descriptor</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookCaseGetInfo</function> function returns a structure
|
||||
containing information about the specified bookcase.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">bookcase_descriptor</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the descriptor for the bookcase.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookCaseGetInfo</function> completes
|
||||
successfully, it return the information structure for the bookcase.
|
||||
If it fails, it returns NULL.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbBookCaseGetInfo</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>int i;
|
||||
DtMmdbInfoLib* infolibInfo = DtMmdbInfoLibGetInfo(0);
|
||||
DtMmdbBookCaseInfo* x;
|
||||
for (i=0; i<infolibInfo->num_bookcases; i++)
|
||||
{
|
||||
x = DtMmdbBookCaseGetInfo(i);
|
||||
/* make use of x */
|
||||
}
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbBookCaseFreeInfo;,
|
||||
&cdeman.DtMmdbBookCaseGetInfo;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
73
cde/doc/C/guides/man/m3_Dt/MmdbBGLT.sgm
Normal file
73
cde/doc/C/guides/man/m3_Dt/MmdbBGLT.sgm
Normal file
@@ -0,0 +1,73 @@
|
||||
<!-- $XConsortium: MmdbBGLT.sgm /main/5 1996/08/30 13:05:05 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookGetLongTitle">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookGetLongTitle</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookGetLongTitle</function></refname><refpurpose>obtains
|
||||
the long title of a book</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>const char* <function>DtMmdbBookGetLongTitle</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookGetLongTitle</function> function
|
||||
returns the long title of the specified book object. Do not use the
|
||||
<function>free</function> function on the returned pointer.
|
||||
Table lookup is involved when the identifier is specified by either the
|
||||
<symbol role="Variable">primary_oid</symbol> or
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as a valid value in the <symbol role="Variable">primary_oid</symbol>, the
|
||||
<symbol role="Variable">secondary_oid</symbol>, or the
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
The <symbol role="Variable">primary_oid</symbol> represents the
|
||||
DtInfo Database object identifier of the TOC section; the
|
||||
<symbol role="Variable">secondary_oid</symbol> represents the
|
||||
object identifier of the book itself; and the
|
||||
<symbol role="Variable">sequence_num</symbol> represents
|
||||
the sequence number of the book within the bookcase (0 based).
|
||||
If more than one of these fields have a valid value, the
|
||||
order of precedence is:
|
||||
<symbol role="Variable">primary_oid</symbol>,
|
||||
<symbol role="Variable">secondary_oid</symbol>, and, last,
|
||||
<symbol role="Variable">sequence_num</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the variable to receive the length of the
|
||||
returned long title, if the returned pointer to the title is not NULL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookGetLongTitle</function> completes
|
||||
successfully, it returns a pointer to the book's long title.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbBookGetShortTitle;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
57
cde/doc/C/guides/man/m3_Dt/MmdbBGSN.sgm
Normal file
57
cde/doc/C/guides/man/m3_Dt/MmdbBGSN.sgm
Normal file
@@ -0,0 +1,57 @@
|
||||
<!-- $XConsortium: MmdbBGSN.sgm /main/4 1996/08/25 20:55:37 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookGetSeqNum">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookGetSeqNum</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookGetSeqNum</function></refname><refpurpose>obtains
|
||||
the sequence number of a book</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbBookGetSeqNum</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookGetSeqNum</function> function returns
|
||||
the sequence number of the specified book object. Table lookup is involved
|
||||
when the identifier is specified by the
|
||||
<symbol role="Variable">primary_oid</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as a valid value in the <symbol role="Variable">primary_oid</symbol> or
|
||||
the <symbol role="Variable">secondary_oid</symbol> field.
|
||||
The <symbol role="Variable">primary_oid</symbol> represents the
|
||||
DtInfo Database object identifier of the TOC section; and the
|
||||
<symbol role="Variable">secondary_oid</symbol> represents the
|
||||
object identifier of the book itself. If both of these fields have
|
||||
a valid value, the order of precedence is:
|
||||
<symbol role="Variable">primary_oid</symbol>
|
||||
and then <symbol role="Variable">secondary_oid</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookGetSeqNum</function> completes
|
||||
successfully, it returns the sequence number of the book.
|
||||
If it fails, it returns -1.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED.</para>
|
||||
</refsect1></refentry>
|
||||
73
cde/doc/C/guides/man/m3_Dt/MmdbBGST.sgm
Normal file
73
cde/doc/C/guides/man/m3_Dt/MmdbBGST.sgm
Normal file
@@ -0,0 +1,73 @@
|
||||
<!-- $XConsortium: MmdbBGST.sgm /main/5 1996/08/30 13:05:17 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookGetShortTitle">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookGetShortTitle</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookGetShortTitle</function></refname><refpurpose>obtains
|
||||
the short title of a book</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>const char* <function>DtMmdbBookGetShortTitle</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookGetShortTitle</function> function
|
||||
returns the short title of the specified book object. Do not use the
|
||||
<function>free</function> function on the returned pointer. Table lookup is involved
|
||||
when the identifier is specified by either the
|
||||
<symbol role="Variable">primary_oid</symbol> or
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as a valid value in the <symbol role="Variable">primary_oid</symbol>, the
|
||||
<symbol role="Variable">secondary_oid</symbol>, or the
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
The <symbol role="Variable">primary_oid</symbol> represents the
|
||||
DtInfo Database object identifier of the TOC section; the
|
||||
<symbol role="Variable">secondary_oid</symbol> represents the
|
||||
object identifier of the book itself; and the
|
||||
<symbol role="Variable">sequence_num</symbol> represents
|
||||
the sequence number of the book within the bookcase (0 based).
|
||||
If more than one of these fields have a valid value, the
|
||||
order of precedence is:
|
||||
<symbol role="Variable">primary_oid</symbol>,
|
||||
<symbol role="Variable">secondary_oid</symbol>, and, last,
|
||||
<symbol role="Variable">sequence_num</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the variable to receive the length of the
|
||||
returned short title, if the returned pointer to the title is not NULL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookGetShortTitle</function> completes
|
||||
successfully, it returns a pointer to the book's short title.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbBookGetLongTitle;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
79
cde/doc/C/guides/man/m3_Dt/MmdbBGTL.sgm
Normal file
79
cde/doc/C/guides/man/m3_Dt/MmdbBGTL.sgm
Normal file
@@ -0,0 +1,79 @@
|
||||
<!-- $XConsortium: MmdbBGTL.sgm /main/6 1996/09/08 20:05:16 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookGetTabList">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookGetTabList</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookGetTabList</function></refname><refpurpose>obtains
|
||||
the list of tab sections in a book</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbHandle** <function>DtMmdbBookGetTabList</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookGetTabList</function> function
|
||||
returns the list of tab sections for the specified book object. It returns
|
||||
the list in a NULL-terminated array. Use the <function>DtMmdbFreeHandleList</function>
|
||||
function to release the memory when the array is no longer needed. Table lookup is
|
||||
involved when the identifier is specified by either the
|
||||
<symbol role="Variable">primary_oid</symbol> or
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as a valid value in the <symbol role="Variable">primary_oid</symbol>, the
|
||||
<symbol role="Variable">secondary_oid</symbol>, or the
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
The <symbol role="Variable">primary_oid</symbol> represents the
|
||||
DtInfo Database object identifier of the TOC section; the
|
||||
<symbol role="Variable">secondary_oid</symbol> represents the
|
||||
object identifier of the book itself; and the
|
||||
<symbol role="Variable">sequence_num</symbol> represents
|
||||
the sequence number of the book within the bookcase (0 based).
|
||||
If more than one of these fields have a valid value, the
|
||||
order of precedence is:
|
||||
<symbol role="Variable">primary_oid</symbol>,
|
||||
<symbol role="Variable">secondary_oid</symbol>, and, last,
|
||||
<symbol role="Variable">sequence_num</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the variable to receive the length of the
|
||||
returned list of sections, if the returned pointer to the list is not NULL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookGetTabList</function> completes
|
||||
successfully, it returns a pointer to the list of sections
|
||||
for the book. If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED.
|
||||
</para>
|
||||
<!--
|
||||
&cdeman.DtMmdbBookGetTabList;,
|
||||
&cdeman.DtMmdbBookGetTabList;
|
||||
-->
|
||||
</refsect1></refentry>
|
||||
|
||||
78
cde/doc/C/guides/man/m3_Dt/MmdbBGTO.sgm
Normal file
78
cde/doc/C/guides/man/m3_Dt/MmdbBGTO.sgm
Normal file
@@ -0,0 +1,78 @@
|
||||
<!-- $XConsortium: MmdbBGTO.sgm /main/6 1996/09/08 20:05:25 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookGetTocObject">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookGetTocObjectId</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookGetTocObjectId</function></refname><refpurpose>obtains
|
||||
the locator of a book's TOC section</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbHandle* <function>DtMmdbBookGetTocObjectId</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookGetTocObjectId</function> function
|
||||
returns the object identifier of the specified book's TOC section.
|
||||
Use the <function>DtMmdbFreeHandleList</function>
|
||||
function to release the memory when the object identifier is no
|
||||
longer needed. Table lookup is
|
||||
involved when the identifier is specified by either the
|
||||
<symbol role="Variable">primary_oid</symbol> or
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as a valid value in the <symbol role="Variable">primary_oid</symbol>, the
|
||||
<symbol role="Variable">secondary_oid</symbol>, or the
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
The <symbol role="Variable">primary_oid</symbol> represents the
|
||||
DtInfo Database object identifier of the TOC section; the
|
||||
<symbol role="Variable">secondary_oid</symbol> represents the
|
||||
object identifier of the book itself; and the
|
||||
<symbol role="Variable">sequence_num</symbol> represents
|
||||
the sequence number of the book within the bookcase (0 based).
|
||||
If more than one of these fields have a valid value, the
|
||||
order of precedence is:
|
||||
<symbol role="Variable">primary_oid</symbol>,
|
||||
<symbol role="Variable">secondary_oid</symbol>, and, last,
|
||||
<symbol role="Variable">sequence_num</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookGetTocObjectId</function> completes
|
||||
successfully, it returns a pointer to the object identifier
|
||||
for the book's TOC section. If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbBookGetTocObjectId</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
request.bookcase_descriptor = DtMmdbGetBookCase(myInfoLibPtr, "myBase");
|
||||
request.sequence_num = 1;
|
||||
DtMmdbBookGetTocObjectId(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED.
|
||||
</para>
|
||||
<!--
|
||||
&cdeman.DtMmdbBookGetTabList;,
|
||||
&cdeman.DtMmdbBookGetTabList;
|
||||
-->
|
||||
</refsect1></refentry>
|
||||
77
cde/doc/C/guides/man/m3_Dt/MmdbBkGL.sgm
Normal file
77
cde/doc/C/guides/man/m3_Dt/MmdbBkGL.sgm
Normal file
@@ -0,0 +1,77 @@
|
||||
<!-- $XConsortium: MmdbBkGL.sgm /main/5 1996/08/30 13:05:53 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookGetLicense">]]><refmeta><refentrytitle>
|
||||
DtMmdbBookGetLicense</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbBookGetLicense</function></refname><refpurpose>obtains
|
||||
a book's license term</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>const char* <function>DtMmdbBookGetLicense</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbBookGetLicense</function> function
|
||||
returns the license term of the specified book object. Do not use the
|
||||
<function>free</function> function on the returned pointer. Table lookup is involved
|
||||
when the identifier is specified by either the
|
||||
<symbol role="Variable">primary_oid</symbol> or
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as a valid value in the <symbol role="Variable">primary_oid</symbol>, the
|
||||
<symbol role="Variable">secondary_oid</symbol>, or the
|
||||
<symbol role="Variable">sequence_num</symbol> field.
|
||||
The <symbol role="Variable">primary_oid</symbol> represents the
|
||||
DtInfo Database object identifier of the TOC section; the
|
||||
<symbol role="Variable">secondary_oid</symbol> represents the
|
||||
object identifier of the book itself; and the
|
||||
<symbol role="Variable">sequence_num</symbol> represents
|
||||
the sequence number of the book within the bookcase (0 based).
|
||||
If more than one of these fields have a valid value, the
|
||||
order of precedence is:
|
||||
<symbol role="Variable">primary_oid</symbol>,
|
||||
<symbol role="Variable">secondary_oid</symbol>, and, last,
|
||||
<symbol role="Variable">sequence_num</symbol>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the variable to receive the length of the
|
||||
returned short title, if the returned pointer to the title is not NULL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbBookGetLicense</function> completes
|
||||
successfully, it returns a pointer to the book's license term.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED.
|
||||
</para>
|
||||
<!--
|
||||
&cdeman.DtMmdbBookGetTabList;,
|
||||
&cdeman.DtMmdbBookGetTabList;
|
||||
-->
|
||||
</refsect1></refentry>
|
||||
48
cde/doc/C/guides/man/m3_Dt/MmdbClIL.sgm
Normal file
48
cde/doc/C/guides/man/m3_Dt/MmdbClIL.sgm
Normal file
@@ -0,0 +1,48 @@
|
||||
<!-- $XConsortium: MmdbClIL.sgm /main/7 1996/09/08 20:05:33 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbCloseInfoLib">]]><refmeta><refentrytitle>
|
||||
DtMmdbCloseInfoLib</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbCloseInfoLib</function></refname><refpurpose>closes an
|
||||
infolib</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>void <function>DtMmdbCloseInfoLib</function></funcdef>
|
||||
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbCloseInfoLib</function> function desclares
|
||||
that the specified infolib is no longer needed by the application.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the infolib descriptor, returned initially
|
||||
by a call to <function>DtMmdbOpenInfoLib</function>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbCloseInfoLib</function>
|
||||
call might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbCloseInfoLib(myInfoLibDescriptor);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbOpenInfoLib;</para>
|
||||
</refsect1></refentry>
|
||||
84
cde/doc/C/guides/man/m3_Dt/MmdbDGNS.sgm
Normal file
84
cde/doc/C/guides/man/m3_Dt/MmdbDGNS.sgm
Normal file
@@ -0,0 +1,84 @@
|
||||
<!-- $XConsortium: MmdbDGNS.sgm /main/6 1996/09/08 20:05:42 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbDlpGetNextSection">]]>
|
||||
<refmeta>
|
||||
<refentrytitle>
|
||||
DtMmdbDlpGetNextSectionId
|
||||
</refentrytitle>
|
||||
<manvolnum>library call</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname><function>DtMmdbDlpGetNextSectionId</function></refname>
|
||||
<refpurpose>obtains
|
||||
the object identifier of the next section</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbHandle* <function>DtMmdbDlpGetNextSectionId</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbDlpGetNextSectionId</function> function
|
||||
returns the object identifier of the next section. You can use
|
||||
this function to traverse the TOC hierarchy in a depth-first fashion.
|
||||
</para>
|
||||
<para>Use the <function>DtMmdbFreeHandleList</function>
|
||||
function to release the memory when the object identifier is no
|
||||
longer needed. Table lookup is involved.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as the id of the current section in the
|
||||
<symbol role="Variable">primary_oid</symbol> field.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbDlpGetNextSectionId</function> completes
|
||||
successfully, it returns a pointer to the object identifier
|
||||
for the next section or
|
||||
<SystemItem Class="Constant">DtMmdbGroundId</SystemItem>,
|
||||
if there is no next section.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbDlpGetNextSectionId</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbHandle* my_oid;
|
||||
DtMmdbInfoRequest request;
|
||||
request.bookcase_descriptor = DtMmdbGetBookCase(myInfoLibPtr, "myBase");
|
||||
request.primary_oid = my_oid;
|
||||
DtMmdbHandle* x = DtMmdbDlpGetNextSectionId(&request);
|
||||
if ( x == DtMMdbGroundId) {
|
||||
/* no next section */
|
||||
} else
|
||||
{
|
||||
if (x == 0) {
|
||||
/* bad request */
|
||||
}
|
||||
else
|
||||
{ /* make use of x */
|
||||
}
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbDlpGetPrevSectionId;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
73
cde/doc/C/guides/man/m3_Dt/MmdbDGPS.sgm
Normal file
73
cde/doc/C/guides/man/m3_Dt/MmdbDGPS.sgm
Normal file
@@ -0,0 +1,73 @@
|
||||
<!-- $XConsortium: MmdbDGPS.sgm /main/6 1996/09/08 20:05:50 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbDlpGetPrevSection">]]><refmeta><refentrytitle>
|
||||
DtMmdbDlpGetPrevSectionId</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbDlpGetPrevSectionId</function></refname><refpurpose>obtains
|
||||
the object identifier of the previous section</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbHandle* <function>DtMmdbDlpGetPrevSectionId</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbDlpGetPrevSectionId</function> function
|
||||
returns the object identifier of the previous section. You can use
|
||||
this function to traverse the TOC hierarchy in a depth-first fashion.
|
||||
</para>
|
||||
<para>Use the <function>DtMmdbFreeHandleList</function>
|
||||
function to release the memory when the object identifier is no
|
||||
longer needed. Table lookup is involved.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
||||
as the id of the current section in the
|
||||
<symbol role="Variable">primary_oid</symbol> field.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbDlpGetPrevSectionId</function> completes
|
||||
successfully, it returns a pointer to the object identifier
|
||||
for the previous section or
|
||||
<SystemItem Class="Constant">DtMmdbGroundId</SystemItem>,
|
||||
if there is no previous section.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbDlpGetPrevSectionId</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request here */
|
||||
DtMmdbHandle* x = DtMmdbDlpGetPrevSectionId(&request);
|
||||
if ( x == DtMMdbGroundId) {
|
||||
/* no previous section */
|
||||
} else
|
||||
{
|
||||
if (x == 0) {
|
||||
/* bad request */
|
||||
}
|
||||
else
|
||||
{ /* make use of x */
|
||||
}
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbDlpGetNextSectionId;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
53
cde/doc/C/guides/man/m3_Dt/MmdbFrGI.sgm
Normal file
53
cde/doc/C/guides/man/m3_Dt/MmdbFrGI.sgm
Normal file
@@ -0,0 +1,53 @@
|
||||
<!-- $XConsortium: MmdbFrGI.sgm /main/7 1996/09/08 20:05:58 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbFreeGraphicInfo">]]><refmeta><refentrytitle>
|
||||
DtMmdbFreeGraphicInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbFreeGraphicInfo</function></refname><refpurpose>frees
|
||||
memory used by a graphics info structure</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>void <function>DtMmdbFreeGraphicInfo</function></funcdef>
|
||||
<paramdef>DtMmdbGraphicInfo* <parameter>struct</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbFreeGraphicInfo</function> function
|
||||
frees all memory used by a
|
||||
<StructName Role="typedef">DtMmdbGraphicInfo</StructName> structure.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">struct</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the pointer to the
|
||||
<StructName Role="typedef">DtMmdbGraphicInfo</StructName> structure,
|
||||
returned by a previous call to <function>DtMmdbGraphicGetInfo</function>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbFreeGraphicInfo</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbGraphicInfo* x = ...
|
||||
DtMmdbFreeGraphicInfo(x);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbGraphicGetInfo;</para>
|
||||
</refsect1></refentry>
|
||||
|
||||
|
||||
55
cde/doc/C/guides/man/m3_Dt/MmdbFrHL.sgm
Normal file
55
cde/doc/C/guides/man/m3_Dt/MmdbFrHL.sgm
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- $XConsortium: MmdbFrHL.sgm /main/7 1996/09/08 20:06:07 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbFreeHandleList">]]><refmeta><refentrytitle>
|
||||
DtMmdbFreeHandleList</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbFreeHandleList</function></refname><refpurpose>
|
||||
frees memory used by a
|
||||
<Symbol>DtMmdbHandle</Symbol> array
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>void <function>DtMmdbFreeHandleList</function></funcdef>
|
||||
<paramdef>DtMmdbHandle** <parameter>list</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbFreeHandleList</function>
|
||||
frees all memory used by a
|
||||
<Symbol>DtMmdbHandle</Symbol> array,
|
||||
including all contained <StructName Role="typedef">DtMmdbHandle</StructName>
|
||||
structures.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">list</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the pointer to the
|
||||
<Symbol>DtMmdbHandle</Symbol> array.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbFreeHandleList</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbHandle** x = ...
|
||||
/* make use of x */
|
||||
DtMmdbFreeHandleList(x); /* free x */
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbFreeHandle;</para>
|
||||
</refsect1></refentry>
|
||||
51
cde/doc/C/guides/man/m3_Dt/MmdbFrHn.sgm
Normal file
51
cde/doc/C/guides/man/m3_Dt/MmdbFrHn.sgm
Normal file
@@ -0,0 +1,51 @@
|
||||
<!-- $XConsortium: MmdbFrHn.sgm /main/7 1996/09/08 20:06:15 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbFreeHandle">]]><refmeta><refentrytitle>
|
||||
DtMmdbFreeHandle</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbFreeHandle</function></refname><refpurpose>frees
|
||||
memory used by a <Symbol>DtMmdbHandle</Symbol>
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>void <function>DtMmdbFreeHandle</function></funcdef>
|
||||
<paramdef>DtMmdbHandle* <parameter>handle</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbFreeHandle</function> function
|
||||
frees all memory used by a <Symbol>DtMmdbHandle</Symbol>.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">handle</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the pointer to the handle.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbFreeHandle</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbHandle *x = ...
|
||||
/* make use of x */
|
||||
DtMmdbFreeHandle(x);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbFreeHandleList;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
65
cde/doc/C/guides/man/m3_Dt/MmdbGBBI.sgm
Normal file
65
cde/doc/C/guides/man/m3_Dt/MmdbGBBI.sgm
Normal file
@@ -0,0 +1,65 @@
|
||||
<!-- $XConsortium: MmdbGBBI.sgm /main/6 1996/09/08 20:06:23 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGetBookCaseByInde">]]><refmeta><refentrytitle>
|
||||
DtMmdbGetBookCaseByIndex</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbGetBookCaseByIndex</function></refname><refpurpose>obtains
|
||||
a descriptor for a bookcase based on an infolib index</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbGetBookCaseByIndex</function></funcdef>
|
||||
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
|
||||
<paramdef>int <parameter>index</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbGetBookCaseByIndex</function> function
|
||||
makes the database engine ready to provide access service for
|
||||
a bookcase. It allows you to access all bookcases in an infolib
|
||||
without knowing their names.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the infolib that contains the bookcase.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">index</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the index of the bookcase within the infolib.
|
||||
The value must be an integer in the
|
||||
range 0 to <emphasis>n</emphasis>-1, where
|
||||
<emphasis>n</emphasis> is the number of bookcases in the infolib.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbGetBookCaseByIndex</function> completes
|
||||
successfully, it returns the descriptor for the bookcase.
|
||||
If it fails, it returns -1.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbGetBookCaseByIndex</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbGetBookCaseByIndex(myInfoLibDescriptor, i);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbGetBookCaseByLoc;,
|
||||
&cdeman.DtMmdbGetBookCaseByLocs;,
|
||||
&cdeman.DtMmdbGetBookCaseByName;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
|
||||
66
cde/doc/C/guides/man/m3_Dt/MmdbGBBL.sgm
Normal file
66
cde/doc/C/guides/man/m3_Dt/MmdbGBBL.sgm
Normal file
@@ -0,0 +1,66 @@
|
||||
<!-- $XConsortium: MmdbGBBL.sgm /main/6 1996/09/08 20:06:32 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGetBookCaseByLoc">]]><refmeta><refentrytitle>
|
||||
DtMmdbGetBookCaseByLoc</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbGetBookCaseByLoc</function></refname><refpurpose>obtains
|
||||
a descriptor for a bookcase based on a hypertext link target
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbGetBookCaseByLoc</function></funcdef>
|
||||
<paramdef>int <parameter>infolib_path</parameter></paramdef>
|
||||
<paramdef>const char* <parameter>locator</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbGetBookCaseByLoc</function> function
|
||||
makes the database engine ready to provide access service for
|
||||
a bookcase. It allows you to access a bookcase by using
|
||||
a hypertext link target in the bookcase.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the infolib that contains the bookcase.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">locator</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the locator of a hypertext link target in the bookcase.
|
||||
The target can be a section or a component within a section.
|
||||
The locator serves as the logical identifier of the object.
|
||||
It is not generated by the DtInfo Database Engine.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbGetBookCaseByLoc</function> completes
|
||||
successfully, it returns the descriptor for the bookcase.
|
||||
If it fails, it returns -1, indicating that there is
|
||||
no bookcase in the infolib that contains the specified target.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbGetBookCaseByLoc</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbGetBookCaseByLoc(myInfoLibDescriptor, "abcde0123456789");
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbGetBookCaseByIndex;,
|
||||
&cdeman.DtMmdbGetBookCaseByLocs;,
|
||||
&cdeman.DtMmdbGetBookCaseByName;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
63
cde/doc/C/guides/man/m3_Dt/MmdbGBBN.sgm
Normal file
63
cde/doc/C/guides/man/m3_Dt/MmdbGBBN.sgm
Normal file
@@ -0,0 +1,63 @@
|
||||
<!-- $XConsortium: MmdbGBBN.sgm /main/6 1996/09/08 20:06:41 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGetBookCaseByName">]]><refmeta><refentrytitle>
|
||||
DtMmdbGetBookCaseByName</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbGetBookCaseByName</function></refname><refpurpose>
|
||||
obtains a descriptor for a bookcase based on the bookcase name
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbGetBookCaseByName</function></funcdef>
|
||||
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
|
||||
<paramdef>const char* <parameter>base_name</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbGetBookCaseByName</function> function
|
||||
makes the database engine ready to provide access service for
|
||||
a bookcase. It allows you to access a bookcase by supplying
|
||||
its name.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the infolib that contains the bookcase.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">base_name</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the name of the bookcase.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbGetBookCaseByName</function> completes
|
||||
successfully, it returns the descriptor for the bookcase.
|
||||
If it fails, it returns -1, indicating that there is
|
||||
no bookcase in the infolib with the specified name.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbGetBookCaseByName</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbGetBookCaseByName(myInfoLib, "thisBookCase");
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbGetBookCaseByIndex;,
|
||||
&cdeman.DtMmdbGetBookCaseByLoc;,
|
||||
&cdeman.DtMmdbGetBookCaseByLocs;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
67
cde/doc/C/guides/man/m3_Dt/MmdbGBLs.sgm
Normal file
67
cde/doc/C/guides/man/m3_Dt/MmdbGBLs.sgm
Normal file
@@ -0,0 +1,67 @@
|
||||
<!-- $XConsortium: MmdbGBLs.sgm /main/6 1996/09/08 20:06:49 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGetBookCaseByLocs">]]><refmeta><refentrytitle>
|
||||
DtMmdbGetBookCaseByLocs</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbGetBookCaseByLocs</function></refname><refpurpose>obtains
|
||||
descriptors for a set of bookcases based on hypertext link targets
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbGetBookCaseByLocs</function></funcdef>
|
||||
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
|
||||
<paramdef>const char** <parameter>locators</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbGetBookCaseByLocs</function> function
|
||||
makes the database engine ready to provide access service for
|
||||
a set of bookcases. It allows you to access multiple bookcases by
|
||||
specifying hypertext link targets that occur within the bookcases.
|
||||
Use the <function>free</function> function to release the
|
||||
array of bookcase descriptors
|
||||
when it is no longer needed.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_path</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the infolib that contains the bookcase.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">locators</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies a zero-terminated array of locators of hypertext link
|
||||
targets. Each target can be a section or a
|
||||
component within a section.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbGetBookCaseByLocs</function> completes
|
||||
successfully, it returns a pointer to a NULL-terminated array
|
||||
of bookcase descriptors. If it fails, it returns NULL.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbGetBookCaseByLocs</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>char locs[] = {"abcde0123456789", "fghij0123456789", 0 };
|
||||
int* descriptor_array = DtMmdbGetBookCaseByLocs(myInfoLibDescriptor, locs);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbGetBookCaseByIndex;,
|
||||
&cdeman.DtMmdbGetBookCaseByLoc;,
|
||||
&cdeman.DtMmdbGetBookCaseByName;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
66
cde/doc/C/guides/man/m3_Dt/MmdbGrGD.sgm
Normal file
66
cde/doc/C/guides/man/m3_Dt/MmdbGrGD.sgm
Normal file
@@ -0,0 +1,66 @@
|
||||
<!-- $XConsortium: MmdbGrGD.sgm /main/5 1996/09/08 20:06:58 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGraphicGetData">]]><refmeta><refentrytitle>
|
||||
DtMmdbGraphicGetData</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbGraphicGetData</function></refname><refpurpose>obtains
|
||||
the data for a graphic object</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>const char* <function>DtMmdbGraphicGetData</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbGraphicGetData</function> function
|
||||
returns the data for a graphic object. Do not use the
|
||||
<function>free</function> function on the returned pointer. Table lookup is involved
|
||||
because the graphic identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and the
|
||||
identifier of the graphic object in the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the variable to receive the length of the
|
||||
returned data, if the returned pointer to the title is not NULL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbGraphicGetData</function> completes
|
||||
successfully, it returns a pointer to the data for
|
||||
the graphic object.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbGraphicGetData</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request */
|
||||
DtMmdbGraphicGetData(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED</para>
|
||||
</refsect1></refentry>
|
||||
60
cde/doc/C/guides/man/m3_Dt/MmdbGrGI.sgm
Normal file
60
cde/doc/C/guides/man/m3_Dt/MmdbGrGI.sgm
Normal file
@@ -0,0 +1,60 @@
|
||||
<!-- $XConsortium: MmdbGrGI.sgm /main/7 1996/09/08 20:07:07 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbGraphicGetInfo">]]><refmeta><refentrytitle>
|
||||
DtMmdbGraphicGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbGraphicGetInfo</function></refname><refpurpose>obtains
|
||||
information about a graphic object</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbGraphicInfo* <function>DtMmdbGraphicGetInfo</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbGraphicGetInfo</function> function
|
||||
returns a structure containing the information about
|
||||
a graphic object. Use the
|
||||
<function>DtMmdbFreeGraphicInfo</function> function to release
|
||||
the memory when the structure is no longer needed. Table lookup is
|
||||
involved because the graphic identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and the
|
||||
identifier of the graphic object in the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbGraphicGetInfo</function> completes
|
||||
successfully, it returns a pointer to the graphic
|
||||
information structure.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbGraphicGetInfo</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request */
|
||||
DtMmdbGraphicGetInfo(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbFreeGraphicInfo;</para>
|
||||
</refsect1></refentry>
|
||||
53
cde/doc/C/guides/man/m3_Dt/MmdbILFI.sgm
Normal file
53
cde/doc/C/guides/man/m3_Dt/MmdbILFI.sgm
Normal file
@@ -0,0 +1,53 @@
|
||||
<!-- $XConsortium: MmdbILFI.sgm /main/6 1996/09/08 20:07:16 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbInfoLibFreeInfo">]]><refmeta><refentrytitle>
|
||||
DtMmdbInfoLibFreeInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbInfoLibFreeInfo</function></refname><refpurpose>frees
|
||||
space occupied by an infolib information structure</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>void <function>DtMmdbInfoLibFreeInfo</function></funcdef>
|
||||
<paramdef>DtMmdbInfoLib* <parameter>info_struct</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbInfoLibFreeInfo</function> function
|
||||
releases the space used by an infolib information structure.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">info_struct</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies a pointer to the infolib information structure
|
||||
returned by a previous call to the <function>DtMmdbGraphicGetInfo</function>
|
||||
function.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>None.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbInfoLibFreeInfo</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoLibInfo *x;
|
||||
x = DtMmdbInfoLibGetInfo(0);
|
||||
/* make use of x */
|
||||
DtMmdbInfoLibFreeInfo(x);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbInfoLibGetInfo;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
55
cde/doc/C/guides/man/m3_Dt/MmdbILGI.sgm
Normal file
55
cde/doc/C/guides/man/m3_Dt/MmdbILGI.sgm
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- $XConsortium: MmdbILGI.sgm /main/6 1996/09/08 20:07:24 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbInfoLibGetInfo">]]><refmeta><refentrytitle>
|
||||
DtMmdbInfoLibGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbInfoLibGetInfo</function></refname><refpurpose>obtains
|
||||
information about an infolib</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbInfoLib* <function>DtMmdbInfoLibGetInfo</function></funcdef>
|
||||
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbInfoLibGetInfo</function> function
|
||||
returns a structure containing information about a specified
|
||||
infolib.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the descriptor for the desired infolib.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbInfoLibGetInfo</function> completes
|
||||
successfully, it returns a pointer to the
|
||||
<StructName Role="typedef">DtMmdbInfoLib</StructName>
|
||||
structure. If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbInfoLibGetInfo</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoLibGetInfo(i);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbInfoLibFreeInfo;,
|
||||
&cdeman.DtMmdbInfoLibInfo;,
|
||||
&cdeman.DtMmdbOpenInfoLib;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
42
cde/doc/C/guides/man/m3_Dt/MmdbInit.sgm
Normal file
42
cde/doc/C/guides/man/m3_Dt/MmdbInit.sgm
Normal file
@@ -0,0 +1,42 @@
|
||||
<!-- $XConsortium: MmdbInit.sgm /main/5 1996/08/30 13:08:45 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDE.INFO.DtMmdbInit">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtMmdbInit</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtMmdbInit</Function></RefName>
|
||||
<RefPurpose>initializes the DtInfo database engine</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis>
|
||||
<FuncSynopsisInfo>#include <DtMmdb.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtMmdbInit</Function></FuncDef>
|
||||
<void>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtMmdbInit</Function> function makes the DtInfo database engine ready to provide access service. When the function returns, the database has been initialized.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.DtMmdbQuit;</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
|
||||
58
cde/doc/C/guides/man/m3_Dt/MmdbLGSL.sgm
Normal file
58
cde/doc/C/guides/man/m3_Dt/MmdbLGSL.sgm
Normal file
@@ -0,0 +1,58 @@
|
||||
<!-- $XConsortium: MmdbLGSL.sgm /main/5 1996/09/08 20:07:33 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbLocatorGetSectLoc">]]><refmeta><refentrytitle>
|
||||
DtMmdbLocatorGetSectionLoc</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbLocatorGetSectionLoc</function></refname><refpurpose>obtains
|
||||
the locator of a section</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>const char* <function>DtMmdbLocatorGetSectionLoc</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbLocatorGetSectionLoc</function> function
|
||||
returns the locator of the section that contains the specified
|
||||
component. Do not use the
|
||||
<function>free</function> function on the returned pointer. Table lookup is
|
||||
involved because the component identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and the
|
||||
identifier of a component within the section in the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbLocatorGetSectionLoc</function> completes
|
||||
successfully, it returns a pointer to the section
|
||||
locator. If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbLocatorGetSectionLoc</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request */
|
||||
DtMmdbLocatorGetSectionLoc(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED</para>
|
||||
</refsect1></refentry>
|
||||
58
cde/doc/C/guides/man/m3_Dt/MmdbLGSO.sgm
Normal file
58
cde/doc/C/guides/man/m3_Dt/MmdbLGSO.sgm
Normal file
@@ -0,0 +1,58 @@
|
||||
<!-- $XConsortium: MmdbLGSO.sgm /main/5 1996/09/08 20:07:41 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbLocatorGetSectObj">]]><refmeta><refentrytitle>
|
||||
DtMmdbLocatorGetSectionObjectId</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbLocatorGetSectionObjectId</function></refname><refpurpose>obtains
|
||||
the object identifier of a section</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbHandle* <function>DtMmdbLocatorGetSectionObjectId</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbLocatorGetSectionObjectId</function> function
|
||||
returns the object identifier of the specified section.
|
||||
Use the <function>DtMmdbFreeHandle</function> function
|
||||
to release the identifier when it is no longer needed. Table lookup is
|
||||
involved because the section identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and the
|
||||
logical identifier of the section in the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbLocatorGetSectionObjectId</function> completes
|
||||
successfully, it returns a pointer to the object
|
||||
identifier for the section. If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbLocatorGetSectionObjectId</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request */
|
||||
DtMmdbLocatorGetSectionObjectId(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED</para>
|
||||
</refsect1></refentry>
|
||||
75
cde/doc/C/guides/man/m3_Dt/MmdbOpIL.sgm
Normal file
75
cde/doc/C/guides/man/m3_Dt/MmdbOpIL.sgm
Normal file
@@ -0,0 +1,75 @@
|
||||
<!-- $XConsortium: MmdbOpIL.sgm /main/7 1996/09/08 20:07:50 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbOpenInfoLib">]]><refmeta><refentrytitle>
|
||||
DtMmdbOpenInfoLib</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbOpenInfoLib</function></refname><refpurpose>opens an
|
||||
infolib for service</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbOpenInfoLib</function></funcdef>
|
||||
<paramdef>const char* <parameter>infolib_path</parameter></paramdef><paramdef>const char* <parameter>selected_base_name</parameter></paramdef><paramdef>DtMmdbBool <parameter>delayed_infolib_init</parameter></paramdef></funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbOpenInfoLib</function> function opens an
|
||||
infolib for user access and returns the descriptor for the
|
||||
infolib. It makes the database engine ready to provide service
|
||||
for an infolib. To obtain information about an infolib, use
|
||||
the <function>DtMmdbInfoLibGetInfo</function> function.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">infolib_path</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the absolute path for the infolib.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">selected_base_name</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies a single bookcase to be accessed in this session. A NULL
|
||||
value indicates that all bookcases will be accessed.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">delayed_infolib_init</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies whether the bookcase activation will be delayed until access
|
||||
time. If you specify <systemitem class="Constant">DtMmdbTrue</systemitem>,
|
||||
<function>DtMmdbOpenInfoLib</function> postpones the activation. This is
|
||||
useful when you want faster Dtinfo Database Engine initialization.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<variablelist>
|
||||
<varlistentry><term>-1</term>
|
||||
<listitem>
|
||||
<para>The initialization failed.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term>>=0</term>
|
||||
<listitem>
|
||||
<para>The initialization succeeded. The returned integer represents a valid
|
||||
infolib descriptor.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbOpenInfoLib</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbOpenInfoLib(myInfoLibPath, "myBookCase", DtMmdbFalse);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbInfoLibGetInfo;, &cdeman.DtMmdbCloseInfoLib;</para>
|
||||
</refsect1></refentry><?Pub Caret>
|
||||
<?Pub *0000003874>
|
||||
44
cde/doc/C/guides/man/m3_Dt/MmdbQuit.sgm
Normal file
44
cde/doc/C/guides/man/m3_Dt/MmdbQuit.sgm
Normal file
@@ -0,0 +1,44 @@
|
||||
<!-- $XConsortium: MmdbQuit.sgm /main/6 1996/08/30 13:09:10 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDE.INFO.DtMmdbQuit">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>DtMmdbQuit</RefEntryTitle>
|
||||
<ManVolNum>library call</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Function>DtMmdbQuit</Function></RefName>
|
||||
<RefPurpose>shuts down the DtInfo database engine</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<RefSynopsisDiv>
|
||||
<FuncSynopsis>
|
||||
<FuncSynopsisInfo>#include <DtMmdb.h>
|
||||
</FuncSynopsisInfo>
|
||||
<FuncDef>void <Function>DtMmdbQuit</Function></FuncDef>
|
||||
<void>
|
||||
</FuncSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Function>DtMmdbQuit</Function> function frees all memory used by
|
||||
the database engine and instructs it to stop service. After the call,
|
||||
the database engine can no longer provide services.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RETURN VALUE</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.DtMmdbInit;</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
|
||||
64
cde/doc/C/guides/man/m3_Dt/MmdbSGBI.sgm
Normal file
64
cde/doc/C/guides/man/m3_Dt/MmdbSGBI.sgm
Normal file
@@ -0,0 +1,64 @@
|
||||
<!-- $XConsortium: MmdbSGBI.sgm /main/6 1996/09/08 20:07:59 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbSectionGetBookId">]]><refmeta><refentrytitle>
|
||||
DtMmdbSectionGetBookId</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbSectionGetBookId</function></refname><refpurpose>obtains
|
||||
the object identifier of a book
|
||||
</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>DtMmdbHandle* <function>DtMmdbSectionGetBookId</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbSectionGetBookId</function> function
|
||||
returns the object identifier of the book that contains the
|
||||
specified section. Use the <function>DtMmdbFreeHandle</function> function
|
||||
to release the identifier when it is no longer needed. Table lookup is
|
||||
involved if the section identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and
|
||||
either the section's Database Engine identifier (in the
|
||||
<symbol role="Variable">primary_oid</symbol> field) or the
|
||||
section's logical identifier (in the <symbol role="Variable">locator_ptr</symbol>
|
||||
field). If both of these fields have a value,
|
||||
<function>DtMmdbSectionGetBookId</function> uses the
|
||||
<symbol role="Variable">locator_ptr</symbol> value.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbSectionGetBookId</function> completes
|
||||
successfully, it returns a pointer to the book's object identifier.
|
||||
If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbSectionGetBookId</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request here */
|
||||
handle = DtMmdbSectionGetTocLoc(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbFreeHandle;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
62
cde/doc/C/guides/man/m3_Dt/MmdbSGDS.sgm
Normal file
62
cde/doc/C/guides/man/m3_Dt/MmdbSGDS.sgm
Normal file
@@ -0,0 +1,62 @@
|
||||
<!-- $XConsortium: MmdbSGDS.sgm /main/5 1996/09/08 20:08:07 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbSectionGetDataSiz">]]><refmeta><refentrytitle>
|
||||
DtMmdbSectionGetDataSize</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbSectionGetDataSize</function></refname><refpurpose>obtains
|
||||
the size of a section's data</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>int <function>DtMmdbSectionGetDataSize</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbSectionGetDataSize</function> function
|
||||
returns the number of bytes in the specified section's data.
|
||||
Table lookup is
|
||||
involved if the section identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and
|
||||
either the section's Database Engine identifier (in the
|
||||
<symbol role="Variable">primary_oid</symbol> field) or the
|
||||
section's logical identifier (in the <symbol role="Variable">locator_ptr</symbol>
|
||||
field). If both of these fields have a value,
|
||||
<function>DtMmdbSectionGetDataSize</function> uses the
|
||||
<symbol role="Variable">locator_ptr</symbol> value.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbSectionGetDataSize</function> completes
|
||||
successfully, it returns the size of the section's data.
|
||||
If it fails, it returns -1.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbSectionGetDataSize</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request here */
|
||||
l = DtMmdbSectionGetDataSize(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>TO BE SUPPLIED
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
70
cde/doc/C/guides/man/m3_Dt/MmdbSGLT.sgm
Normal file
70
cde/doc/C/guides/man/m3_Dt/MmdbSGLT.sgm
Normal file
@@ -0,0 +1,70 @@
|
||||
<!-- $XConsortium: MmdbSGLT.sgm /main/6 1996/09/08 20:08:15 rws $ -->
|
||||
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
|
||||
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
|
||||
<!-- (c) Copyright 1996 International Business Machines Corp. -->
|
||||
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
|
||||
<!-- (c) Copyright 1996 Novell, Inc. -->
|
||||
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
|
||||
<!-- (c) Copyright 1996 Hitachi. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbSectionGetLongTi">]]><refmeta><refentrytitle>
|
||||
DtMmdbSectionGetLongTitle</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
||||
<refname><function>DtMmdbSectionGetLongTitle</function></refname><refpurpose>obtains
|
||||
the long title for a section</refpurpose></refnamediv><refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
||||
<funcdef>const char* <function>DtMmdbSectionGetLongTitle</function></funcdef>
|
||||
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
||||
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <function>DtMmdbSectionGetLongTitle</function> function
|
||||
returns the long title for the specified section. Do not use the
|
||||
<function>free</function> function on the returned pointer. Table lookup is
|
||||
involved if the section identifier is specified by the
|
||||
<symbol role="Variable">locator_ptr</symbol> field.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ARGUMENTS</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the bookcase in the bookcase descriptor field and
|
||||
either the section's Database Engine identifier (in the
|
||||
<symbol role="Variable">primary_oid</symbol> field) or the
|
||||
section's logical identifier (in the <symbol role="Variable">locator_ptr</symbol>
|
||||
field). If both of these fields have a value,
|
||||
<function>DtMmdbSectionGetLongTitle</function> uses the
|
||||
<symbol role="Variable">locator_ptr</symbol> value.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
||||
<listitem>
|
||||
<para>Specifies the variable to receive the length of the
|
||||
returned long title, if the returned pointer to the title is not NULL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>RETURN VALUE</title>
|
||||
<para>If <function>DtMmdbSectionGetLongTitle</function> completes
|
||||
successfully, it returns a pointer to a NULL-terminated
|
||||
long title character string. If it fails, it returns a NULL pointer.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLE</title>
|
||||
<para>The following shows how a <function>DtMmdbSectionGetLongTitle</function> call
|
||||
might be coded.</para>
|
||||
<informalexample>
|
||||
<programlisting>DtMmdbInfoRequest request;
|
||||
/* fill the request field here */
|
||||
DtMmdbSectionGetLongTitle(&request);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>&cdeman.DtMmdbSectionGetShortTitle;
|
||||
</para>
|
||||
</refsect1></refentry>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user