debian man page for soxtresource

SoXtResource(3IV)()													       SoXtResource(3IV)()

NAME
       SoXtResource -- used to retrieve X resources for SoXtComponents and widgets

INHERITS FROM
       SoXtResource

SYNOPSIS
       #include <Inventor/Xt/SoXtResource.h>

	  Methods from class SoXtResource:

			 SoXtResource(Widget w)
			 ~SoXtResource()
     SbBool		 getResource(char *resName, char *resClass, SbColor &c)
     SbBool		 getResource(char *resName, char *resClass, short &i)
     SbBool		 getResource(char *resName, char *resClass, unsigned short &u)
     SbBool		 getResource(char *resName, char *resClass, char *&s)
     SbBool		 getResource(char *resName, char *resClass, SbBool &b)
     SbBool		 getResource(char *resName, char *resClass, float &f)

DESCRIPTION
       This class provides an easy to use interface for retrieving X resource values for widgets and components. Rather than use standard Xt calls
       to traverse up a widget hierarchy, this class performs its own traversal so that it may provide special care for widgets which are Inventor
       components. For instance, the Inventor Material Editor top level widget is a Motif form widget. Its class name is thus XmForm. SoXtResource
       knows that the editor is an Inventor component, though, so it uses the class name provided by the editor (in  this  case  "SoXtMaterialEdi-
       tor") when looking up resource values.

       EXAMPLE:
	  SoXtResource xr( materialEditor->getWidget() );
	  xr.getResource("tile1Color", "Tile1Color", color);
	  xr.getResource("updateFrequency", "UpdateFrequency", freq);

METHODS
			 SoXtResource(Widget w)
			 ~SoXtResource()
	  Constructor and destructor. The constructor takes the widget for which it will retrieve resource values.

     SbBool		 getResource(char *resName, char *resClass, SbColor &c)
     SbBool		 getResource(char *resName, char *resClass, short &i)
     SbBool		 getResource(char *resName, char *resClass, unsigned short &u)
     SbBool		 getResource(char *resName, char *resClass, char *&s)
     SbBool		 getResource(char *resName, char *resClass, SbBool &b)
     SbBool		 getResource(char *resName, char *resClass, float &f)
	  This	returns  the X resource value for the specified resource name and class. There is no need to specify the widget hierarchy; this is
	  automatically computed in the constructor.

NOTES
       Components will typically look up their own resources during buildWidget(). In order for a component to have its Inventor class name recog-
       nized  by  SoXtResource,  it  must call SoXtComponent::registerWidget() in its buildWidget() method. (This is done in every Inventor compo-
       nent.)

SEE ALSO
       X Resources (Xrm), X Intrinsics (Xt), SoXt, SoXtComponent

															       SoXtResource(3IV)()