Go to main content

man pages section 4: Device and Network Interfaces

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ttDesktop (4)

Name

ttDesktop - introduction to desktop messaging policy

Synopsis

Please see following description for synopsis

Description

ttDesktop(4)                    ToolTalk Policy                   ttDesktop(4)



NAME
       ttDesktop - introduction to desktop messaging policy

DESCRIPTION
       The  Desktop  message  policies  apply to any tool in a POSIX or X11(7)
       environment.  In addition to standard messages for these  environments,
       the  Desktop  policies  define data types and error codes that apply to
       all of the ToolTalk message policies.

LIST OF MESSAGES
                Do_Command(        in      string      command,
                                   out     string      results] );
                Set_Environment(   in      string      variable,
                                   in      string      value
                                                       [...] );
                Get_Environment(   in      string      variable,
                                   out     string      value
                                                       [...] );
                Set_Geometry(      inout   width       w
                                   inout   height      h
                                   inout   xOffset     x
                                   inout   yOffset     y
                                   [in     messageID   commission] );
                Set_Iconified(     in      boolean     iconic
                                   [in     messageID   commission] );
                Set_Locale(        in      string      category,
                                   in      string      locale
                                                       [...] );
                Get_Locale(        in      string      category,
                                   out     string      locale
                                                       [...] );
                Set_Mapped(        in      boolean     mapped
                                   [in     messageID   commission] );
       [file]   Modified(          in      type        ID );
       [file]   Reverted(          in      type        ID );
       [file]   Get_Modified(      in      type        ID,
                                   out     boolean     modified );
                Pause(             [in     messageID   operation] );
                Quit(              in      boolean     silent,
                                   in      boolean     force
                                   [in     messageID   operation2Quit] );
                Raise(             [in     messageID   commission] );
       [file]   Save(              in      type        ID );
       [file]   Revert(            in      type        ID );
       [file]   Saved(             in      type        ID );
                Set_Situation(     in      string      path );
                Get_Situation(     out     string      path );
                Signal(            in      string      theSignal );
                Started(           in      string      vendor,
                                   in      string      toolName,
                                   in      string      toolVersion );
                Stopped(           in      string      vendor,
                                   in      string      toolName,
                                   in      string      toolVersion );
                Status(            in      string      status,
                                   in      string      vendor,
                                   in      string      toolName,
                                   in      string      toolVersion
                                   [in     messageID   commission]);
                Get_Status(        out     string      status,
                                   out     string      vendor,

                                   out     string      toolName,
                                   out     string      toolVersion
                                   [in     messageID   operation2Query]);
                Get_Sysinfo(       out     string      sysname,
                                   out     string      nodename,
                                   out     string      release,
                                   out     string      version,
                                   out     string      machine );
                Get_XInfo(         out     string      display,
                                   out     string      visual,
                                   out     integer     depth
                                   [in     messageID   commission] );

DEFINITIONS
   boolean
       A vtype for logical values.  The underlying data  type  of  boolean  is
       integer;  that  is,  arguments of this vtype should be manipulated with
       tt_*_arg_ival[_set]() and tt_*_iarg_add().  Zero means false;  non-zero
       means true.

   messageID
       A vtype for uniquely identifying messages.  The underlying data type of
       messageID is string; that is, arguments of this vtype should be manipu-
       lated with tt_*_arg_val[_set]() and tt_*_arg_add().  The messageID of a
       Tt_message is returned by tt_message_id().

   type
       Any of the vtypes that are the name of the kind of objects in a partic-
       ular system of persistent objects.  For example, the vtype for the kind
       of objects in filesystems is File.  The vtype for ToolTalk  objects  is
       ToolTalk_Object.

   vendor
   toolName
   toolVersion
       Names  of arguments that appear in several of the messages in the Desk-
       top suite of messages.  These strings are not defined rigorously;  they
       merely should be presentable to the user as descriptions of these three
       attributes of the relevant procid.

ERRORS
       1102 ITT_DESKTOP_ENOENT
              No such file or directory

       1113 TT_DESKTOP_EACCES
              Permission denied

       1122 TT_DESKTOP_EINVAL
              Invalid argument

              An argument's value was not  valid  in  these  circumstances  --
              e.g.,  a  locale  in  Set_Locale() that is not valid on the han-
              dler's host.  However, TT_DESKTOP_EINVAL  should  only  be  used
              when  no more-specific status (e.g.  TT_DESKTOP_ENOMSG, TT_DESK-
              TOP_EPROTO ) applies.

       1135 TT_DESKTOP_ENOMSG
              No message of desired type

              A messageID does not refer to any message currently known by the
              handler.

       1171 TT_DESKTOP_EPROTO
              Protocol error

              A message does could not be understood, because
               o a required argument was omitted
               o  an  argument  had the wrong vtype, or a vtype not allowed in
                 this message -- e.g., boolean in Get_Geometry()
               o an argument had the wrong Tt_mode
               o an argument's value was not legal for its vtype -- e.g., neg-
                 ative values for width in Set_Geometry()
               o  an  argument's value was not legal for this message -- e.g.,
                 PATH=/foo as a variable in Get_Environment()

              In general, TT_DESKTOP_EPROTO means that one could see that  the
              request  is  malformed simply by comparing it with the reference
              page for the message.

       1147 TT_DESKTOP_ECANCELED
              Operation canceled

              The operation was canceled because of direct  or  indirect  user
              intervention.   An  example of indirect intervention is termina-
              tion of the handling process caused by the user, or receipt of a
              Quit()  request.  (All messages should be taken as authentically
              representing the wishes of the user whose uid  is  indicated  by
              tt_message_uid().)

       1148 TT_DESKTOP_ENOTSUP
              Operation not supported

              The  requested operation is not supported by this handler.  Nor-
              mally, a well-formed request that a  handler  does  not  support
              should  be  tt_message_reject()ed,  thus causing it to fail with
              TT_ERR_NO_MATCH  if  no  supporting  handler  can  be  found  or
              started.   But sometimes a handler can safely assume that, if it
              rejects a request, no other handler will be able to perform  the
              operation.   Examples:  a  TT_HANDLER -addressed request such as
              Set_Iconified(), or a request referring to state that is managed
              by  this  handler and no other.  In these cases, it is better to
              explicitly fail the request with TT_DESKTOP_ENOTSUP, in order to
              distinguish the case of an incompletely-implemented handler from
              the case of the absence of a handler.

              TT_ERR_UNIMP should not be used in place of  TT_DESKTOP_ENOTSUP,
              because TT_ERR_UNIMP means that a particular feature of ToolTalk
              itself is not implemented.

       1299 TT_DESKTOP_UNMODIFIED
              Operation does not apply to unmodified entities

WARNINGS
       The vtype namespace for persistent objects currently only contains File
       and  ToolTalk_Object.   Vendors who wish to define a type should either
       give it a vendor-specific name or register it through SunSoft's  Devel-
       oper  Integration  Format Registration program.  SunSoft can be reached
       at 1-800-227-9227.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/tooltalk |
       +---------------+------------------+
       |Stability      | Committed        |
       +---------------+------------------+
SEE ALSO
       ttsession(1), intro(2), X11(7), Intro(TTPolicy)




ToolTalk 1.3                     1 March 1996                     ttDesktop(4)