gxPanel Class Reference

Abstract base class of a graphical user interface (GUI) panel. More...

#include <gxPanel.h>

List of all members.

Public Member Functions

 gxPanel ()
virtual ~gxPanel ()
virtual int activate (long parent)=0
 Activate that panel as a child of the specified window.
virtual int deactivate ()=0
 Deactivate the panel.
virtual int getRequiredWidth ()=0
 Returns the width required by the panel GUI.
virtual int getRequiredLength ()=0
 Returns the width required by the panel GUI.
virtual std::string getTitle ()=0
 Returns the title of the panel.
virtual std::string getDocString ()=0
 Returns the documentation string (if any) for the panel.
virtual std::string getHelpFile ()=0
 Returns the path to a windows help file (if any) for the panel.


Detailed Description

Abstract base class of a graphical user interface (GUI) panel.

When a filter or other component has a GUI, it provides an implementation of gxPanel. The application then activates the gxPanel as a child of the appropriate window in the application framework to display the GUI.


Constructor & Destructor Documentation

gxPanel::gxPanel  )  [inline]
 

virtual gxPanel::~gxPanel  )  [inline, virtual]
 


Member Function Documentation

virtual int gxPanel::activate long  parent  )  [pure virtual]
 

Activate that panel as a child of the specified window.

This creates and displays the panel GUI.

virtual int gxPanel::deactivate  )  [pure virtual]
 

Deactivate the panel.

This destroys the panel GUI.

virtual std::string gxPanel::getDocString  )  [pure virtual]
 

Returns the documentation string (if any) for the panel.

virtual std::string gxPanel::getHelpFile  )  [pure virtual]
 

Returns the path to a windows help file (if any) for the panel.

virtual int gxPanel::getRequiredLength  )  [pure virtual]
 

Returns the width required by the panel GUI.

An application can use this information to resize the parent window before activating the panel.

virtual int gxPanel::getRequiredWidth  )  [pure virtual]
 

Returns the width required by the panel GUI.

An application can use this information to resize the parent window before activating the panel.

virtual std::string gxPanel::getTitle  )  [pure virtual]
 

Returns the title of the panel.


The documentation for this class was generated from the following file:
Generated on Mon Nov 21 01:01:37 2005 for gxLib by  doxygen 1.4.5