SoWx  0.1.0
Coin3D GUI toolkit binding
Loading...
Searching...
No Matches
SoWxComponent Class Reference

The SoWxComponent class is the base class for all GUI components. More...

#include <Inventor/Wx/SoWxComponent.h>

Inheritance diagram for SoWxComponent:
SoWxObject SoWxGLWidget SoWxRenderArea SoWxViewer SoWxFullViewer SoWxConstrainedViewer SoWxExaminerViewer SoWxPlaneViewer SoWxFlyViewer

Public Member Functions

virtual ~SoWxComponent ()
 
wxWindow * getBaseWidget (void) const
 
const char * getClassName (void) const
 
const char * getIconTitle (void) const
 
wxWindow * getParentWidget (void) const
 
wxWindow * getShellWidget (void) const
 
SbVec2s getSize (void) const
 
const char * getTitle (void) const
 
wxWindow * getWidget (void) const
 
const char * getWidgetName (void) const
 
virtual void hide (void)
 
SbBool isFullScreen (void) const
 
SbBool isTopLevelShell (void) const
 
SbBool isVisible (void)
 
virtual void setComponentCursor (const SoWxCursor &cursor)
 
SbBool setFullScreen (const SbBool onoff)
 
void setIconTitle (const char *const title)
 
void setSize (const SbVec2s size)
 
void setTitle (const char *const title)
 
void setWindowCloseCallback (SoWxComponentCB *const func, void *const user=NULL)
 
virtual void show (void)
 
- Public Member Functions inherited from SoWxObject
virtual SoType getTypeId (void) const =0
 
SbBool isOfType (SoType type) const
 

Static Public Member Functions

static SoWxComponentgetComponent (wxWindow *widget)
 
static void initClasses (void)
 
static void setWidgetCursor (wxWindow *w, const SoWxCursor &cursor)
 
- Static Public Member Functions inherited from SoWxObject
static SoType getClassTypeId (void)
 
static void init (void)
 
static void initClass (void)
 

Protected Member Functions

 SoWxComponent (wxWindow *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
 
void addVisibilityChangeCallback (SoWxComponentVisibilityCB *const func, void *const user=NULL)
 
virtual void afterRealizeHook (void)
 
virtual const char * getDefaultIconTitle (void) const
 
virtual const char * getDefaultTitle (void) const
 
virtual const char * getDefaultWidgetName (void) const
 
void registerWidget (wxWindow *widget)
 
void removeVisibilityChangeCallback (SoWxComponentVisibilityCB *const func, void *const user=NULL)
 
void setBaseWidget (wxWindow *widget)
 
void setClassName (const char *const name)
 
virtual void sizeChanged (const SbVec2s &size)
 
void unregisterWidget (wxWindow *widget)
 

Protected Attributes

SbBool firstRealize
 

Detailed Description

The SoWxComponent class is the base class for all GUI components.

Components in the SoWx component library all inherit this abstract base class. It provides basic methods for setting and querying about the relationship between the component object and its underlying Wx object(s).

Application programmers should not need to interface any code against this class, unless they want to extend the SoWx library in entirely new directions. For making new viewer components, for instance, other classes further down the inheritance hierarchy would be better suited for subclassing.

Note that the relationship between all SoWxComponent derived classes and Wx widgets is one of "has-A", not "is-A" – i.e. SoWxComponent contains a wxWindow*, it doesn't derive from or subclass it.

Constructor & Destructor Documentation

◆ ~SoWxComponent()

SoWxComponent::~SoWxComponent ( )
virtual

Destructor.

◆ SoWxComponent()

SoWxComponent::SoWxComponent ( wxWindow *const parent = NULL,
const char *const name = NULL,
const SbBool embed = TRUE )
protected

This is a protected constructor, used only by derived classes.

The parent argument is the parent widget of the component. If you don't supply a parent, the main window (the one given to or returned from SoWx::init()) is used (and the embed argument is considered to be FALSE).

The name argument is the name of the component. If you don't supply one, the name will default to something, depending on the inheritance hierarchy.

The embed argument tells whether the component should be embedded in the parent widget or should create its own shell. This flag is only checked if the parent widget argument is specified (not NULL).

If you create a non-embedded component, the component will create its own shell, which will be a top level shell type. If you embed the component, the component will create a form widget type widget inside the parent widget, which you can get the handle of by calling SoWxComponent::getBaseWidget().

Member Function Documentation

◆ addVisibilityChangeCallback()

void SoWxComponent::addVisibilityChangeCallback ( SoWxComponentVisibilityCB *const func,
void *const user = NULL )
protected

Add a callback which will be called whenever the widget component changes visibility status (because of iconification or deiconification, for instance).

See also
removeVisibilityChangeCallback(), isVisible()

◆ afterRealizeHook()

void SoWxComponent::afterRealizeHook ( void )
protectedvirtual

A function "hook" / callback invoked just after the window for the component has been realized.

Override this if you need specific initialization for your own component or viewer class to happen right after it has been made visible, but remember to call upwards in the inheritance hierarchy:

void
MyLittleViewer::afterRealizeHook(void)
{
<superclass>::afterRealizeHook();
// [own initialization here]
}
virtual void afterRealizeHook(void)
Definition SoWxComponent.cpp:127

Reimplemented in SoWxRenderArea, SoWxExaminerViewer, SoWxFlyViewer, and SoWxPlaneViewer.

◆ getBaseWidget()

wxWindow * SoWxComponent::getBaseWidget ( void ) const

An SoWxComponent may be composed of any number of widgets in parent-children relationships in a tree structure with any depth. This method will return the root widget in that tree.

See also
setBaseWidget()

◆ getClassName()

const char * SoWxComponent::getClassName ( void ) const

Returns class name of widget.

◆ getComponent()

SoWxComponent * SoWxComponent::getComponent ( wxWindow * widget)
static

Finds and returns the SoWxComponent corresponding to the given wxWindow*, if any. If the widget does not seem to belong to any SoWxComponent, NULL will be returned.

◆ getDefaultIconTitle()

const char * SoWxComponent::getDefaultIconTitle ( void ) const
protectedvirtual

This method returns the default icon title of the component.

It should be overridden by derived non-abstract classes so icons will get proper titles.

Reimplemented in SoWxRenderArea, SoWxExaminerViewer, SoWxFlyViewer, and SoWxPlaneViewer.

◆ getDefaultTitle()

const char * SoWxComponent::getDefaultTitle ( void ) const
protectedvirtual

This method returns the default window caption string of the component.

It should be overridden by derived non-abstract classes so the window and pop-up menu will get a proper title.

Reimplemented in SoWxRenderArea, SoWxExaminerViewer, SoWxFlyViewer, and SoWxPlaneViewer.

◆ getDefaultWidgetName()

const char * SoWxComponent::getDefaultWidgetName ( void ) const
protectedvirtual

This method returns the default name of a component widget class.

It should be overridden by derived non-abstract classes for the topmost widget in the component to have a proper name.

Reimplemented in SoWxRenderArea, SoWxExaminerViewer, SoWxFlyViewer, and SoWxPlaneViewer.

◆ getIconTitle()

const char * SoWxComponent::getIconTitle ( void ) const

Returns the title the window has when iconified.

If an icon title has been set, that icon title is returned. If no icon title has been set, the default icon title is returned.

See also
setIconTitle(), isTopLevelShell()

◆ getParentWidget()

wxWindow * SoWxComponent::getParentWidget ( void ) const

Returns the widget which is the parent of (i.e. contains) this component's base widget.

See also
getWidget(), baseWidget(), isTopLevelShell()

◆ getShellWidget()

wxWindow * SoWxComponent::getShellWidget ( void ) const

This method returns the shell widget of the component, but only if it was created as a top level shell. NULL will be returned for embedded components.

(The top level shell is the desktop window which contains the component.)

To get the top level shell of embedded components, you can use the SoWx::getShellWidget() method.

See also
isTopLevelShell(), getWidget()

◆ getSize()

SbVec2s SoWxComponent::getSize ( void ) const

Returns the component widget size.

The size that is returned is a cached size value, not a value fetched from the GUI system.

See also
setSize()

◆ getTitle()

const char * SoWxComponent::getTitle ( void ) const

Returns the window title.

If a title has been set, that title will be returned. If no title has been set, the default title is returned.

See also
setTitle(), isTopLevelShell()

◆ getWidget()

wxWindow * SoWxComponent::getWidget ( void ) const

Returns a pointer to the component's window system widget.

See also
getShellWidget(), getParentWidget()

◆ getWidgetName()

const char * SoWxComponent::getWidgetName ( void ) const

Returns name of the widget.

◆ hide()

void SoWxComponent::hide ( void )
virtual

This will hide the widget.

See also
show(), isVisible()

◆ initClasses()

void SoWxComponent::initClasses ( void )
static

This function initializes the type system for all the component classes. It is called indirectly for you when you call SoWx::init().

See also
SoWx::init(), SoWxDevice::initClasses()

◆ isFullScreen()

SbBool SoWxComponent::isFullScreen ( void ) const

Returns whether this widget/component is in full screen mode or not.

◆ isTopLevelShell()

SbBool SoWxComponent::isTopLevelShell ( void ) const

Returns TRUE if this component is a top level shell, i.e. it has a window representation on the desktop.

See also
getShellWidget()

◆ isVisible()

SbBool SoWxComponent::isVisible ( void )

Returns visibility status on the widget. If any parents of this widget or this widget itself is hidden, returns FALSE.

Note that a widget which is just obscured by other windows on the desktop is not hidden in this sense, and TRUE will be returned.

See also
show(), hide()

◆ registerWidget()

void SoWxComponent::registerWidget ( wxWindow * widget)
protected

This method should be used by subclasses to register the widgets they set up from the underlying native toolkit, so they can be "reverse" mapped to the owner component.

Subclasses failing to register the widgets they use will cause the SoWxComponent::getComponent() method to fail with those widgets.

See also
unregisterWidget(), getComponent()

◆ removeVisibilityChangeCallback()

void SoWxComponent::removeVisibilityChangeCallback ( SoWxComponentVisibilityCB *const func,
void *const data = NULL )
protected

Remove one of the callbacks from the list of visibility notification callbacks.

See also
addVisibilityChangeCallback(), isVisible()

◆ setBaseWidget()

void SoWxComponent::setBaseWidget ( wxWindow * widget)
protected

Set the core widget for this SoWx component. It is important that subclasses get this correct, as the widget set here will be the widget returned from query methods.

See also
baseWidget()

◆ setClassName()

void SoWxComponent::setClassName ( const char *const name)
protected

Set class name of component.

See also
getClassName(), componentClassName()

◆ setComponentCursor()

void SoWxComponent::setComponentCursor ( const SoWxCursor & cursor)
virtual

Sets the cursor for this component.

Note: not part of the original SGI InventorXt API.

Reimplemented in SoWxFullViewer.

◆ setFullScreen()

SbBool SoWxComponent::setFullScreen ( const SbBool onoff)

Toggle full screen mode for this component, if possible.

Returns FALSE if operation failed. This might happen if the toolkit doesn't support attempts at making the component cover the complete screen or if the component is not a top level window.

◆ setIconTitle()

void SoWxComponent::setIconTitle ( const char *const title)

This method sets the title of the icon representation of the window.

The title will appear on the window icon, if the component manages its own window.

See also
getIconTitle(), setTitle(), isTopLevelShell()

◆ setSize()

void SoWxComponent::setSize ( const SbVec2s size)

Resize the component widget.

The method assumes the caller knows what he is doing.

See also
getSize()

◆ setTitle()

void SoWxComponent::setTitle ( const char *const title)

Set the window title of this component. The title will appear on the window title bar, if the component manages its own window.

See also
getTitle(), setIconTitle(), isTopLevelShell()

◆ setWidgetCursor()

void SoWxComponent::setWidgetCursor ( wxWindow * w,
const SoWxCursor & cursor )
static

Set cursor for a native widget in the underlying toolkit.

Note: not part of the original SGI InventorXt API.

◆ setWindowCloseCallback()

void SoWxComponent::setWindowCloseCallback ( SoWxComponentCB *const func,
void *const data = NULL )

Set up a callback function to use when the component gets closed. A component must be a top level shell for this to have any effect.

For top level shells with no close callback set, the window will simply be hidden. The typical action to take in the callback would be to delete the component.

See also
isTopLevelShell()

◆ show()

void SoWxComponent::show ( void )
virtual

This will show the widget, de-iconifying and raising it if necessary.

See also
hide(), isVisible()

◆ sizeChanged()

void SoWxComponent::sizeChanged ( const SbVec2s & size)
protectedvirtual

Called internally from within the SoWx library when the widget embedded in a component changes its size, which is usually triggered by end-user interaction.

This method is then invoked to notify the component that the size has changed. It is called from the top and all the way down to the bottom, the size being adjusted to take into account extra decorations having been added at each level in the component class hierarchy.

Reimplemented in SoWxGLWidget, SoWxRenderArea, SoWxFullViewer, and SoWxViewer.

◆ unregisterWidget()

void SoWxComponent::unregisterWidget ( wxWindow * widget)
protected

Remove a previously registered native toolkit widget from the widget-to-component mappings used by SoWxComponent::getComponent().

See also
registerWidget()

The documentation for this class was generated from the following files: