PoXtLegendEditor Class Reference
[Editors]

Abstract class for all legend editors. More...

#include <MeshViz/graph/editors/PoXtLegendEditor.h>

Inheritance diagram for PoXtLegendEditor:

List of all members.

Public Types
enum	LegendMask {   NO_LEGEND_MASK = 0x00000000,   TITLE_VISIBILITY = 0x00000001,   TITLE_POSITION = 0x00000002,   TITLE_PATH = 0x00000004,   TITLE_FONT_NAME = 0x00000008,   TITLE_FONT_SIZE = 0x00000010,   TITLE_STRING = 0x00000020,   TITLE,   VALUE_VISIBILITY = 0x00000040,   VALUE_POSITION = 0x00000080,   VALUE_FONT_NAME = 0x00000100,   VALUE_ADD_STRING_VISIBILITY = 0x00000200,   VALUE_ADD_STRING = 0x00000400,   VALUE,   MARGIN_TYPE = 0x00000800,   MARGIN_LEFT = 0x00001000,   MARGIN_RIGHT = 0x00002000,   MARGIN_BOTTOM = 0x00004000,   MARGIN_TOP = 0x00008000,   MARGIN,   INCREMENT_TYPE = 0x00010000,   NUM_COLUMNS = 0x00020000,   BOX_RATIO = 0x00040000,   MISC_TEXT_ATTR = 0x00080000,   MISC = INCREMENT_TYPE | NUM_COLUMNS | BOX_RATIO | MISC_TEXT_ATTR,   ALL_LEGEND_MASK = TITLE | VALUE | MARGIN | MISC }
enum	Presentation {   TOGGLE_FOLD,   TOGGLE_UNFOLD,   LABEL_UNFOLD }
enum	UpdateFrequency {   CONTINUOUS,   AFTER_ACCEPT }
typedef void	PoXtLegendEditorCB (void *userData, PoLegend *data)
Public Member Functions
virtual void	attach (PoLegend *legend)
void	detach ()
SbBool	isAttached () const
void	addLegendChangedCallback (PoXtLegendEditorCB *func, void *userData)
void	removeLegendChangedCallback (PoXtLegendEditorCB *func, void *userData)
virtual void	setPresentation (Presentation type)
Presentation	getPresentation () const
void	setUpdateFrequency (UpdateFrequency freq)
UpdateFrequency	getUpdateFrequency () const
void	setLegendFilter (unsigned long inclusionMask, unsigned long exclusionMask)
void	getLegendFilter (unsigned long &inclusionMask, unsigned long &exclusionMask) const
virtual void	show ()
virtual void	hide ()

---

Detailed Description

Abstract class for all legend editors.

NOTE: This class does not exist in Open Inventor 10.0 and later.

Deprecated:

Deprecated since Open Inventor 9600
MeshViz editors are no longer supported.

---

Member Typedef Documentation

typedef void PoXtLegendEditor::PoXtLegendEditorCB(void *userData, PoLegend *data)

---

Member Enumeration Documentation

enum PoXtLegendEditor::LegendMask

Enumerator:

NO_LEGEND_MASK
TITLE_VISIBILITY
TITLE_POSITION
TITLE_PATH
TITLE_FONT_NAME
TITLE_FONT_SIZE
TITLE_STRING
TITLE
VALUE_VISIBILITY
VALUE_POSITION
VALUE_FONT_NAME
VALUE_ADD_STRING_VISIBILITY
VALUE_ADD_STRING
VALUE
MARGIN_TYPE
MARGIN_LEFT
MARGIN_RIGHT
MARGIN_BOTTOM
MARGIN_TOP
MARGIN
INCREMENT_TYPE
NUM_COLUMNS
BOX_RATIO
MISC_TEXT_ATTR
MISC	Family mask.
ALL_LEGEND_MASK

enum PoXtLegendEditor::Presentation

Enumerator:

TOGGLE_FOLD
TOGGLE_UNFOLD
LABEL_UNFOLD

enum PoXtLegendEditor::UpdateFrequency

Enumerator:

CONTINUOUS	Updates the attached object at each modification.
AFTER_ACCEPT	Updates the attached object when hitting the accept button.

---

Member Function Documentation

void PoXtLegendEditor::addLegendChangedCallback	(	PoXtLegendEditorCB *	func,
		void *	userData
	)

Adds callbacks which are called on legend changes.

(See the method setUpdateFrequency to define the moment when the callbacks are called).

virtual void PoXtLegendEditor::attach

(

PoLegend *

legend

)

[virtual]

Attach the editor to a legend node.

void PoXtLegendEditor::detach

(

)

Detach the editor from a legend node.

void PoXtLegendEditor::getLegendFilter	(	unsigned long &	inclusionMask,
		unsigned long &	exclusionMask
	)			const

Gets editing filters defining which legend attributes will be displayed in the editor.

Presentation PoXtLegendEditor::getPresentation

(

)

const

Gets the presentation of the editor.

UpdateFrequency PoXtLegendEditor::getUpdateFrequency

(

)

const

Gets the update frequency.

virtual void PoXtLegendEditor::hide

(

)

[virtual]

This hides the component.

Reimplemented from SoXtComponent.

SbBool PoXtLegendEditor::isAttached

(

)

const

Returns TRUE if the editor is attached.

void PoXtLegendEditor::removeLegendChangedCallback	(	PoXtLegendEditorCB *	func,
		void *	userData
	)

Removes the callbacks called on legend changes.

void PoXtLegendEditor::setLegendFilter	(	unsigned long	inclusionMask,
		unsigned long	exclusionMask
	)

Sets editing filters defining which legend attributes will be displayed in the editor.

(By default inclusionMask = ALL_LEGEND_MASK and exclusionMask = NO_LEGEND_MASK).

virtual void PoXtLegendEditor::setPresentation

(

Presentation

type

)

[virtual]

Sets the presentation of the editor.

(type = TOGGLE_FOLD by default).

void PoXtLegendEditor::setUpdateFrequency

(

UpdateFrequency

freq

)

Sets the update frequency.

(By default freq = CONTINUOUS).

virtual void PoXtLegendEditor::show

(

)

[virtual]

This shows the component.

Reimplemented from SoXtComponent.

---

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

• MeshViz/graph/editors/PoXtLegendEditor.h