k3d::ipath_property Class Reference

Abstract interface for properties that represent external filesystem resources (typically used to alter presentation). More...

#include <ipath_property.h>

Inheritance diagram for k3d::ipath_property:
Inheritance graph
[legend]

List of all members.

Classes

struct  pattern_filter
 Defines a "pattern filter" that the UI layer can use to filter files using GLOB style syntax. More...

Public Types

enum  mode_t { READ, WRITE }
 

Enumerates the mode of the underlying file.

More...
enum  reference_t { ABSOLUTE_REFERENCE, RELATIVE_REFERENCE, INLINE_REFERENCE }
 

Enumerates how the external resource should be referenced - by absolute path, relative path, or inline.

More...
typedef std::vector
< pattern_filter
pattern_filters_t
typedef sigc::signal< void > path_reference_changed_signal_t
 Defines a signal that will be emitted anytime the path reference is modified.

Public Member Functions

virtual mode_t property_path_mode ()=0
 Returns the path "mode", which indicates whether the path will be used for an input or an output file.
virtual const std::string property_path_type ()=0
 Returns the path "type", used to categorize the purpose of the path and store most-recent-used paths.
virtual reference_t property_path_reference ()=0
 Returns the path "reference", which indicates how the external resource will be referenced - by absolute path, relative path, or inline.
virtual void set_property_path_reference (const reference_t)=0
virtual
path_reference_changed_signal_t
property_path_reference_changed_signal ()=0
virtual const pattern_filters_t pattern_filters ()=0
 Returns a collection of pattern filters to be (optionally) used by the UI when prompting the user for a file.

Protected Member Functions

 ipath_property ()
 ipath_property (const ipath_property &Other)
ipath_propertyoperator= (const ipath_property &)
virtual ~ipath_property ()

Detailed Description

Abstract interface for properties that represent external filesystem resources (typically used to alter presentation).


Member Typedef Documentation

Defines a signal that will be emitted anytime the path reference is modified.


Member Enumeration Documentation

Enumerates the mode of the underlying file.

Enumerator:
READ 
WRITE 

Enumerates how the external resource should be referenced - by absolute path, relative path, or inline.

Enumerator:
ABSOLUTE_REFERENCE 
RELATIVE_REFERENCE 
INLINE_REFERENCE 

Constructor & Destructor Documentation

k3d::ipath_property::ipath_property (  )  [inline, protected]
k3d::ipath_property::ipath_property ( const ipath_property Other  )  [inline, protected]
virtual k3d::ipath_property::~ipath_property (  )  [inline, protected, virtual]

Member Function Documentation

ipath_property& k3d::ipath_property::operator= ( const ipath_property  )  [inline, protected]
virtual const pattern_filters_t k3d::ipath_property::pattern_filters (  )  [pure virtual]

Returns a collection of pattern filters to be (optionally) used by the UI when prompting the user for a file.

Implemented in k3d::data::path_property< value_t, name_policy_t >.

virtual mode_t k3d::ipath_property::property_path_mode (  )  [pure virtual]

Returns the path "mode", which indicates whether the path will be used for an input or an output file.

Implemented in k3d::data::path_property< value_t, name_policy_t >.

virtual reference_t k3d::ipath_property::property_path_reference (  )  [pure virtual]

Returns the path "reference", which indicates how the external resource will be referenced - by absolute path, relative path, or inline.

Implemented in k3d::data::path_property< value_t, name_policy_t >.

virtual path_reference_changed_signal_t& k3d::ipath_property::property_path_reference_changed_signal (  )  [pure virtual]
virtual const std::string k3d::ipath_property::property_path_type (  )  [pure virtual]

Returns the path "type", used to categorize the purpose of the path and store most-recent-used paths.

Implemented in k3d::data::path_property< value_t, name_policy_t >.

virtual void k3d::ipath_property::set_property_path_reference ( const   reference_t  )  [pure virtual]

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

Generated on Mon Mar 21 07:41:55 2011 for K-3D by doxygen 1.6.3