SoXtComponent.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      : David Mott (MMM yyyy)
** Modified by : Alain Dumesny (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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifdef SOQT
#  include <Inventor/Qt/SoQtComponent.h>
#elif defined _WIN32
#  include <Inventor/Win/SoWinComponent.h>
#else // _WIN32
 
#ifndef _SO_XT_COMPONENT_H_
#define _SO_XT_COMPONENT_H_
 
#include <X11/Intrinsic.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbString.h>
#include <Inventor/Gui/SoGuiComponent.h>
#include <Inventor/Xt/SoXtDef.h>
 
class SbDict;
class SoXtComponent;
class SoCallbackList;
 
typedef void SoXtComponentCB( void* data, SoXtComponent* v );
typedef void SoXtComponentVisibilityCB( void* data, SbBool b );
 
class  SoXtComponent
{
 
 public:
 
  static  void displayHelp( const char*  filename, UINT contextID );
 
  virtual void show();
 
  virtual void hide();
 
  SbBool isVisible();
 
  SoWidget getWidget() const { return _baseWidget; }
 
  SbBool isTopLevelShell() const { return m_guiComponent->isTopLevelShell(); }
 
  SoWidget getShellWidget() const { return m_guiComponent->isTopLevelShell() ? parentWidget : NULL; }
 
  SoWidget getParentWidget() const { return parentWidget; }
 
  void setSize( const SbVec2s& size );
 
  SbVec2s getSize();
 
  SbBool setFullScreen( const SbBool enable );
 
  SbBool isFullScreen(void) const;
 
  void setFullScreenEnable( const SbBool enable );
 
  SbBool isFullScreenEnable() const;
 
  inline Display* getDisplay();
 
  SoNONUNICODE void setTitle( const char* newTitle );
 
 
  void setTitle( const SbString& newTitle );
 
  SbString getTitle() const { 
    return m_guiComponent->getTitle(); }
 
  SoNONUNICODE void setIconTitle( const char* newIconTitle );
 
  void setIconTitle( const SbString& newIconTitle );
 
  SbString getIconTitle() const { 
    return m_guiComponent->getIconTitle(); }
 
 
  void setWindowCloseCallback( SoXtComponentCB* func, void* data = NULL )
    { windowCloseFunc = func; windowCloseData = data; }
 
  static SoXtComponent* getComponent( SoWidget w );
 
  SbString getWidgetName() const { 
    return m_guiComponent->getWidgetName(); }
 
  SbString getClassName() const { 
    return m_guiComponent->getClassName(); }
 
 
 private:
 
  virtual ~SoXtComponent();
 
  // Deprecated. Replaced by getWidget().
  SoWidget baseWidget() const { return getWidget(); }
 
  virtual void posChanged( const SbVec2i32&, const SbVec2i32& ) {};
 
  SoGuiComponent* getGuiComponent() const;
 
 private:
  //
  // If `parent` widget is suplied AND `buildInsideParent` is TRUE, this
  // component will build inside the given parent widget, else
  // it will create its own topLevelShell widget (component resides in
  // its own window).
  // The topLevelShell can either be created under the given
  // parent shell (`parent` != NULL) or under the main window.
  //
  // The name is used for looking up X resource values. If NULL,
  // then this component inherits resource values defined for its class.
  //
  // Calling setBaseWidget is needed for looking up Xt like
  // resources in the widget tree. It will use the class name of
  // the Inventor component (e.g. SoXtRenderArea) instead of
  // the class name of the Motif widget this component employs
  // (e.g. XmForm).
  //
  // Thus apps are able to do this in their app-defaults file:
  //
  // *SoXtRenderArea*BackgroundColor: salmon
  //
  SoXtComponent( SoWidget parent = NULL,
                 const char* name = NULL,
                 SbBool buildInsideParent = TRUE,
                 SbBool sync = TRUE );
 
  SoXtComponent( SoWidget parent,
                 const char* name,
                 SbBool buildInsideParent,
                 SbBool sync,
                 SoGuiComponent* guiComponent );
 
  // Subclasses need to call this method passing the top most
  // widget after it has been created.
  void setBaseWidget( SoWidget w );
 
  // Subclasses need to set the class name in the constructor
  // before the widget is built.
  void setClassName( const SbString &n ) { m_guiComponent->setClassName( n ); }
 
  // this routine is called whenever the top level shell widget receives
  // a close action (WM_DELETE_WINDOW message) from the window manager.
  // Instead of destroying the widget (default shell behavior) this
  // routine is used, which by default calls exit(0) if it is the main
  // window else calls hide() on the component.
  //
  virtual void windowCloseAction();
 
  // Support for doing things right after the widget is realized
  // for the first time.
  // The base class will set the window and icon title for shell widgets.
  virtual void afterRealizeHook();
  SbBool firstRealize;
 
  //
  // Subclasses should redefine these routines to return the appropriate
  // default information. Those are used when creating the widget to set
  // the name (used for resources), window title and window icon
  // name. Those default values are only used if the user didn't
  // explicitly specify them.
  //
  virtual SbString getDefaultWidgetName() const;
  virtual SbString getDefaultTitle() const;
  virtual SbString getDefaultIconTitle() const;
 
  //
  // Register widget - should be called by subclasses after
  // they have created their top most widget (which is passed here),
  // and before they build any child widgets. Calling this method
  // ensures that the widgets name and class will be used when
  // calls are made to get X resource values for this widget.
  //
  // *** NOTE ***
  // ALL subclasses should register their top most widget within the
  // component, whether they retrieve resources or not, so that children
  // widgets can get X resources properly.
  // Unregister the widget when the widget is destroyed.
  //
  void registerWidget( SoWidget w );
  void unregisterWidget( SoWidget w );
 
  // subclasses can add a callback to be called whenever the component
  // becomes visible or become hidden (like when it is iconified).
  // Sublcasses should use this to attach or detach any sensors they
  // have, or stop any ongoing anymation.
  void addVisibilityChangeCallback( SoXtComponentVisibilityCB* func, void* userData = NULL );
  void removeVisibilityChangeCallback( SoXtComponentVisibilityCB* func, void* userData = NULL );
 
  //
  // This method can be used by subclasses to open a component help
  // card. The name of the file should be supplied withought a path
  // name. By default the file will be searched using:
  // 1) current working directory
  // 2) SO_HELP_DIR environment variable
  // 3) /usr/share/help/Inventor
  // 4) else bring a no help card found dialog
  //
  void openHelpCard( const char* cardName );
 
  // This method is used to get label from resources for Localisation.
  static SbString getlabel( unsigned int whatisit );// const;
 
 
 
 private:
 
  void constructorCommon( SoWidget parent, const char* name, SbBool buildInsideParent, SbBool sync );
 
  // Call a web browser to open the passed URL
  SbBool callWebBrowser( const char* url ) const;
 
  // widgetDestroyed is called when the widget is destroyed.
  // There is no way to reconstruct the widget tree, so calling
  // this simply generates an error. The component should be
  // deleted to dispose of the widget.
  virtual void widgetDestroyed();
 
  SbBool createdShell; // TRUE if we created that toplevel shell
  SoWidget parentWidget; // topLevel shell if in its own window
  SoWidget _baseWidget; // returned by getWidget()
  SbVec2s size; // size of the '_baseWidget' and 'shell' (if toplevel)
 
  // visibiltity stuff
  SbBool visibleState;
  SbBool ShellMapped, widgetMapped;
  SoCallbackList* visibiltyCBList;
  void checkForVisibilityChange();
  static void widgetStructureNotifyCB( SoWidget w, SoXtComponent* p, XEvent* xe, Boolean* b );
  static void shellStructureNotifyCB( SoWidget w, SoXtComponent* p, XEvent* xe, Boolean* b );
  static void widgetDestroyedCB( SoWidget w, XtPointer clientData, XtPointer p );
 
  // window close action data
  SoXtComponentCB* windowCloseFunc;
  void* windowCloseData;
  static void windowCloseActionCB( SoWidget w, SoXtComponent* v, void* data );
 
  // The widget dictionary maps widgets to SoXtComponents. It's used
  // by getComponent(), and kept up to date by registerWidget().
  static SbDict* widgetDictionary;
 
  // For fullscreen mode.
  Dimension posX, posY, width, height;
  int m_decorationHints;
  int m_functionHints;
 
  SoGuiComponent* m_guiComponent;
 
};
 
// Inline routines
Display*
SoXtComponent::getDisplay()
{
  return (_baseWidget != NULL ? XtDisplay(_baseWidget) : NULL);
}
 
#endif // _SO_XT_COMPONENT_H_
 
#endif // _WIN32