The in-key character token provided to SGIHelpMsg() is the fully qualified instance name hierarchy for the widget The user can then click any widget in the application, which calls SGIHelpMsg(). When the user chooses this item, the cursor changes into a question mark.
VIEWKIT SGI BOOK PROFESSIONAL
For information on writing SGIHelp, see the Iris InSight Professional Publisher User's Guide. In the IRIX Interactive User Interface Guidelines. Your application will seldom have to call these functions directly (see “ViewKit Programmatic Interface to a Help Library”).įor general and stylistic information about using SGIHelp, see Chapter 4, “IRIX Interactive Desktop Services,” Keep in mind, however, that in most instances, ViewKit makes the calls to SGIHelpInit(), SGIHelpMsg(), and SGIHelpIndexMsg() for you. In the IRIX Interactive Desktop Integration Guide.
VIEWKIT SGI BOOK HOW TO
libhelpmsg depends on the libX11 library, so you must specify -lhelpmsg before -lX11 in the compilation or linking command.įor example, to compile a file hellohelp.c++ to produce the executable hellohelp, you would enter the following:ĬC -o hellohelp hellohelp.c++ -lhelpmsg -lX11įor specific information and examples about how to implement SGIHelp, see Chapter 9, “Providing Online Help with SGIHelp,” *overview*helpText provides a message that the application displays when the user chooses Overview from the Help menu.Īs documented in the IRIX Interactive Desktop Integration Guide, the Silicon Graphics help library, libhelpmsg, handles communication with the help server. The *row2*start*helpText specification provides a help message for a start widget, a descendant of the row2 widget. For example, you could use a specification like this to provide a help message for a group of toggles or push buttons in a RowColumn widget. The *row1*helpText and *row2*helpText resource specifications provide help messages for these widgets and their descendants. If a widget does not have a more specific help message resource specification, the application displays this default help message. In this example, the *helpText resource specification provides a default help message for the entire application. *overview*helpText: Overview help message *row2*start*helpText: Special help message for start, a child widget of row2 *row2*helpText: Help message for the row2 widgets and its descendants *row1*helpText: Help message for the row1 widgets and its descendants *helpText: Application default help message The following lines show how you create the help message specifications for an application: If these functions cannot find an appropriate resource value, they display the message Sorry, no help available on this topic in the dialog. They then display the retrieved help text in an Motif information dialog. This may be sufficient for your needs.īoth SGIHelpMsg() and SGIHelpIndexMsg() are defined to accept the in_key character token argument and look up the resource in_key.helpText in the X resource database. The ViewKit library, libvk, includes a simple help capability that allows you to provide help messages for your application by defining them in the X resource database. The other argument to SGIHelpIndexMsg() is reserved for future Silicon Graphics use. The subsections that follow describe how the value is determined. The value of in_key depends on how the user requested help. In_key is a character token that SGIHelpIndexMsg() uses to look up a help index. Int SGIHelpIndexMsg(char * in_key, char *) A return value of 0 indicates failure.Ī ViewKit application calls SGIHelpIndexMsg() to display an index of help available: The other arguments to SGIHelpMsg() are reserved for future Silicon Graphics use. In_key is a character token that SGIHelpMsg() uses to look up help material. Int SGIHelpMsg(char * in_key, char *, char *) A return value of 0 indicates failure.Ī ViewKit application calls SGIHelpMsg() when it needs to request help: The third argument to SGIHelpInit() is reserved for future Silicon Graphics use. display is the application's Display structure, and appClass is the application's class name. VkApp calls SGIHelpInit() from its constructor. Int SGIHelpInit(Display * display, char * appClass, char *) SGIHelpInit() initializes the help system: The only exception would be if you create a help button in your application without using the VkDialogManager class (see “Application Help Button Procedures”). Your application should never need to call SGIHelpInit(), SGIHelpMsg(), or SGIHelpIndexMsg() directly.
Note: ViewKit makes all calls to the help system.
0 kommentar(er)
