Nitf::Properties Class Reference

A plug-in interface used to specify a GUI for displaying and (optionally) editing TRE and DES data. More...

#include <NitfProperties.h>

Inheritance diagram for Nitf::Properties:

List of all members.

Public Member Functions
virtual std::string	getTypeName () const =0
virtual bool	canDisplayMetadata (const DynamicObject &metadata)=0
Static Public Member Functions
static std::string	SubType ()
Protected Member Functions
virtual	~Properties ()

---

Detailed Description

A plug-in interface used to specify a GUI for displaying and (optionally) editing TRE and DES data.

Data can be viewed and edited using the normal metadata editor but some data benefit from a more taylored GUI. Implementers of this interface will not need to write a second plug-in to attach the GUI to a specific DataElement. Any DataElement with an associated TRE or DES will be automatically displayed in that element's properties dialog.

Definition at line 26 of file NitfProperties.h.

---

Constructor & Destructor Documentation

virtual Nitf::Properties::~Properties

(

)

[protected, virtual]

Since the Properties interface is usually used in conjunction with the PlugIn interface, this should be destroyed by casting to the PlugIn interface and calling PlugInManagerServices::destroyPlugIn().

Reimplemented from Properties.

Definition at line 65 of file NitfProperties.h.

---

Member Function Documentation

static std::string Nitf::Properties::SubType

(

)

[static]

The type that should be returned from PlugIn::getSubtype() for properties plug-ins.

This subtype is needed to automatically attach this property widget to a DataElement.

Returns:

Returns the type used for properties plug-ins.

Definition at line 36 of file NitfProperties.h.

virtual std::string Nitf::Properties::getTypeName

(

)

const [pure virtual]

The name of the TRE or DES this plug-in displays.

Returns:

The name of the TRE or DES. This must exactly match the TRE or DES name as it appears in the DataElement metadata.

Implemented in Nitf::PropertiesQWidgetWrapper< PropertiesWidget >.

virtual bool Nitf::Properties::canDisplayMetadata

(

const DynamicObject &

metadata

)

[pure virtual]

Determine if this plug-in can display and/or edit the specified metadata.

Parameters:

metadata

The element metadata sub-tree for the named TRE or DES. This will be rooted at the metadata TRE or DES node with the same name as SubType().

Returns:

True if the metadata can be displayed and/or edited, otherwise false.

Implemented in Nitf::PropertiesQWidgetWrapper< PropertiesWidget >.