Inventor/Xt/SoXt.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Nick Thompson (MMM yyyy)
** Modified by : Paul Isaacs (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/

#ifdef SOQT
#  include <Inventor/Qt/SoQt.h>
#elif defined(_WIN32)
#  include <Inventor/Win/SoXt2SoWin.h>
#  include <Inventor/Win/SoWin.h>
#else

#ifndef _SO_XT_
#define _SO_XT_

#include <SbTypes.h>
#include <Xm/Xm.h>
#include <Inventor/SbBasic.h>
#include <Inventor/SbLinear.h>
#include <Inventor/Xt/SoXtDef.h>
#include <Inventor/Xt/SoXtLocalisation.h>
#include <Inventor/Xt/SoInventorXtLibName.h>

#include <Inventor/SoModule.h>
SO_MODULE_HEADER(SoInventorXt, __INVENTORXTDLL)

class SbPList;
class SoXtEventHandler;
class SoAction;

class  SoXt {

 public:
  static SoWidget init(const char *appName,
                     const char *className = "Inventor");

  static void init(SoWidget topLevelWidget);

#if 1             
   /*
    * @UNICODE_WARNING
    */
SoDEPRECATED
  static SoWidget threadInit(const char *appName,
                           const char *className = "Inventor");
SoDEPRECATED
  static void threadInit(SoWidget topLevelWidget);
#endif 
  static bool isInitialized();

  static void finish();

  static int mainLoop();

  static void exit(int returnCode = 0);

  static void nextEvent(XtAppContext appContext, XEvent *event)
    { XtAppNextEvent(appContext, event); }

  static Boolean dispatchEvent(XEvent *event);

  static XtAppContext getAppContext();

  static Display *getDisplay();

  static SoWidget getTopLevelWidget();

  //
  // Convenience routines
  //

  static void show(SoWidget widget);

  static void hide(SoWidget widget);

  static XmString encodeString(char *s);

  static char *decodeString(XmString xs);

  static void setWidgetSize(SoWidget w, const SbVec2s &size);

  static SbVec2s getWidgetSize(SoWidget w);

  static SoWidget getShellWidget(SoWidget w);

  static void createSimpleErrorDialog(SoWidget widget, char *dialogTitle,
                                      char *errorStr1, char *errorStr2 = NULL);

  static void getPopupArgs(Display *d, int scr, ArgList args, int *n);

  static void registerColormapLoad(SoWidget widget, SoWidget shell);

  static void addColormapToShell(SoWidget widget, SoWidget shell);

  static void removeColormapFromShell(SoWidget widget, SoWidget shell);

 private:
  // Add/remove the passed event handler for X extension device events
  // (Xt does not handle extension events.)
  // Extension event types are queried from the server at runtime.
  static void addExtensionEventHandler(SoWidget w,
                                       int extensionEventType,
                                       XtEventHandler proc,
                                       XtPointer clientData);
  static void removeExtensionEventHandler(SoWidget w,
                                          int extensionEventType,
                                          XtEventHandler proc,
                                          XtPointer clientData);

  // This method is an acces method to label (Widgets).

  // This method is an acces method to label ( Widgets ).
  // Begin
  static SoWidget getwidget( unsigned int whatisit );
  // End

  static void canExit(SbBool ce);

  static void setEventHandler();

  static SoXtEventHandler *eventHandler;

 private:
  static void             getExtensionEventHandler(
                                                   XEvent *event,
                                                   SoWidget &w,
                                                   XtEventHandler &proc,
                                                   XtPointer &clientData);

 private:
  static void activeLoop();
  
  static int s_returnCode;

  static SoWidget           mainWidget;
  static bool             m_internalApp;
  static SbBool           m_canExit;

  static SbPList          *handlerList;

  // Begin
  // Widgets for localisation.
  static SoWidget label[155];

  static void localisationlabel(SoWidget parent);
  // End

  // setup display in Inventor for GL extensions check
  static void setupInventorGLDisplay();
  
  static int s_initRefCount;
  static const char *s_versionString;
};

#endif  /* _SO_XT_ */

#endif // SOQT

---

Open Inventor Toolkit reference manual, generated on 4 Sep 2023
Copyright © Thermo Fisher Scientific All rights reserved. https://www.openinventor.com/