The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::ComponentEditor Class Reference

A ComponentEditor is an interface used to edit an entire component at once, as opposed to a PropertyEditor which only edits a single property of a specific component or object. More...

#include <vcf/ApplicationKit/ComponentEditor.h>

Inheritance diagram for VCF::ComponentEditor:

List of all members.

Public Types
enum	ComponentAttributes { caNone = 0x00000, caSeparator = 0x10000, caHasParentIndex = 0x00001, caUsesModalDialogForEditing = 0x00002 }
Public Member Functions
virtual	~ComponentEditor ()
virtual void	initialize ()=0
	This is called immediately after the component has been created, after the caller has made the setComponent() call on the editor.
virtual int	getAttributes (const uint32 &index)=0
	This method returns a mask of potential attributes for the command at the given index.
virtual int	getCommandParentIndex (const uint32 &index)=0
	Returns the index value of the command's parent if one exists.
virtual Command *	createCommand (const uint32 &index)=0
	Retreives a new command instance associated with this index.
virtual uint32	getCommandCount ()=0
	Returns the number of unique commands associated with this component editor.
virtual int	getDefaultCommandIndex ()=0
	Returns the editors default command index.
virtual Component *	getComponent ()=0
virtual void	setComponent (Component *component)=0
	Sets the component for this editor.
virtual void	copy ()=0
bool	isSeparator (const uint32 &index)
bool	hasParentIndex (const uint32 &index)
bool	usesModalDialogForEditing (const uint32 &index)

---

Detailed Description

A ComponentEditor is an interface used to edit an entire component at once, as opposed to a PropertyEditor which only edits a single property of a specific component or object.

---

Member Enumeration Documentation

enum VCF::ComponentEditor::ComponentAttributes

Enumerator: caNone  caSeparator  caHasParentIndex  caUsesModalDialogForEditing

---

Constructor & Destructor Documentation

virtual VCF::ComponentEditor::~ComponentEditor (   )  [inline, virtual]

---

Member Function Documentation

virtual void VCF::ComponentEditor::copy (   )  [pure virtual]

Implemented in VCF::AbstractComponentEditor.

virtual Command* VCF::ComponentEditor::createCommand (  const uint32 &  index  )  [pure virtual]

Retreives a new command instance associated with this index. Parameters: uint32  index of the command to retrieve Returns: Command* returns a NEW instance of the Command object to be associated with the given index. Note: It is the callers responsibility to clean up memory and the caller owns the command after this call. Implemented in VCF::AbstractComponentEditor.

virtual int VCF::ComponentEditor::getAttributes (  const uint32 &  index  )  [pure virtual]

This method returns a mask of potential attributes for the command at the given index. Implemented in VCF::AbstractComponentEditor.

virtual uint32 VCF::ComponentEditor::getCommandCount (   )  [pure virtual]

Returns the number of unique commands associated with this component editor. Returns: uint32 the number of commands for the editor Implemented in VCF::AbstractComponentEditor.

virtual int VCF::ComponentEditor::getCommandParentIndex (  const uint32 &  index  )  [pure virtual]

Returns the index value of the command's parent if one exists. If no parent exists, then the value returned is -1. Most comamnds will not have a parent. However this is used if you have a complex set of commands that make sense to nest in a heirarchy. Implemented in VCF::AbstractComponentEditor.

virtual Component* VCF::ComponentEditor::getComponent (   )  [pure virtual]

Returns: Component the component this Editor is currently attached to. Implemented in VCF::AbstractComponentEditor.

virtual int VCF::ComponentEditor::getDefaultCommandIndex (   )  [pure virtual]

Returns the editors default command index. This is the command that will be executed when the component is double clicked on. Return a value of -1 to indicate that there is no default command index. Implemented in VCF::AbstractComponentEditor.

bool VCF::ComponentEditor::hasParentIndex (  const uint32 &  index  )  [inline]

virtual void VCF::ComponentEditor::initialize (   )  [pure virtual]

This is called immediately after the component has been created, after the caller has made the setComponent() call on the editor. Implemented in VCF::AbstractComponentEditor.

bool VCF::ComponentEditor::isSeparator (  const uint32 &  index  )  [inline]

virtual void VCF::ComponentEditor::setComponent (  Component *  component  )  [pure virtual]

Sets the component for this editor. Implemented in VCF::AbstractComponentEditor.

bool VCF::ComponentEditor::usesModalDialogForEditing (  const uint32 &  index  )  [inline]

---

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

• vcf/ApplicationKit/ComponentEditor.h

Comments or Suggestions?    License Information