---

PasswordCodecPrototype Class Reference

Password encoding/decoding prototype. More...

#include <PasswordCodecPrototype.h>

Inheritance diagram for PasswordCodecPrototype:

List of all members.

Public Methods
virtual	~PasswordCodecPrototype ()
	Destructor of the password encoding/decoding prototype. More...
virtual PasswordCodecPrototype *	clone (void) const=0
	Create a new password encoding/decoding prototype that is a exact copy of the current one. More...
virtual bool	loadFile (string filename, string password)=0
	Decrypts the password informations and add them in the list in order they can be retreived by the app. More...
virtual bool	saveFile (string password)=0
	Encrypts and saves all the password informations present in the list in the file defined by loadFile() or newFile(). More...
virtual bool	loadDefaultFile (string password)
	Decrypts the password informations, stored in the default filename of the plugin, and add them in the list in order they can be retreived by the app. More...
virtual bool	saveFileAs (string filename, string password)
	Encrypts and saves all the password informations present in the list in another file. More...
virtual bool	newFile (string filename, string password)
	Prepares a new file for the backup of password informations. More...
virtual bool	hasDefaultFilename (void)
	Informs if the plugin has a default filename to use if no one setted by the user. More...
virtual string	getDefaultFilename (void)
	Returns the default filename to use if no one was setted by the user. More...
virtual string	getCurrentFilename (void)
	Returns the current filename setted by the user. More...
virtual bool	setFilenameToDefault (void)
	Set the current filename with the default filename value. More...
virtual PasswordInfos *	popPasswordInfos (void)
	Removes the first password structure from the list and then returns it. More...
virtual bool	pushPasswordInfos (PasswordInfos *password_infos)
	Inserts password_infos at the end of the list if the password informations are editable. More...
virtual bool	isEditable (void)
	Informs if the passwords informations are editable. More...
virtual bool	getEditability (void)
	Requests the right to edit the password informations. More...
virtual void	releaseEditability (void)
	Releases the right to edit the password informations. More...
virtual bool	isModified (void) const
	Informs if the passwords informations are modified. More...
virtual bool	hasFixedField (void) const=0
	Defines if this encrypted format supports variable number of field to describe passwords. More...
virtual int	getNbField (void) const=0
	Returns the number of fields that describe the password (password and description are not included). More...
virtual PasswordInfos	getFieldsName (void) const=0
	Returns the fields name describing what represents each elements of the password informations. More...
virtual bool	setFieldsName (PasswordInfos fields_name_infos)=0
	Defines the fields name describing what represents each elements of the password informations. More...
Protected Methods
	PasswordCodecPrototype ()
	Constructor of the password encoding/decoding prototype. More...
	PasswordCodecPrototype (const PasswordCodecPrototype &password_codec_prototype)
	Copy constructor of the password encoding/decoding prototype. More...
Protected Attributes
list< PasswordInfos * >	_password_infos_list
string	_filename
bool	_is_modified
bool	_is_editable
bool	_is_edited
string	_default_filename

---

Detailed Description

Password encoding/decoding prototype.

---

Constructor & Destructor Documentation

PasswordCodecPrototype::~PasswordCodecPrototype (    )  [virtual]

Destructor of the password encoding/decoding prototype. Returns: none

PasswordCodecPrototype::PasswordCodecPrototype (    )  [protected]

Constructor of the password encoding/decoding prototype. Returns: none

PasswordCodecPrototype::PasswordCodecPrototype (  const PasswordCodecPrototype &    password_codec_prototype )  [protected]

Copy constructor of the password encoding/decoding prototype. Parameters: password_codec_prototype  the password encoding/decoding prototype to copy Returns: none

---

Member Function Documentation

PasswordCodecPrototype * PasswordCodecPrototype::clone (  void    )  const [pure virtual]

Create a new password encoding/decoding prototype that is a exact copy of the current one. Returns: the new password encoding/decoding prototype clone

string PasswordCodecPrototype::getCurrentFilename (  void    )  [virtual]

Returns the current filename setted by the user. Returns: the current filename or an empty string if not setted

string PasswordCodecPrototype::getDefaultFilename (  void    )  [virtual]

Returns the default filename to use if no one was setted by the user. Returns: the default filename or an empty string if not setted Note: This function must generally returns the default filename of the original application of which the plugin is the native

bool PasswordCodecPrototype::getEditability (  void    )  [virtual]

Requests the right to edit the password informations. Returns: true if the right is granted / false otherwise

PasswordInfos PasswordCodecPrototype::getFieldsName (  void    )  const [pure virtual]

Returns the fields name describing what represents each elements of the password informations. Returns: a PasswordInfos structure in which each element holds the name of fields

int PasswordCodecPrototype::getNbField (  void    )  const [pure virtual]

Returns the number of fields that describe the password (password and description are not included). Returns: the number of fields

bool PasswordCodecPrototype::hasDefaultFilename (  void    )  [virtual]

Informs if the plugin has a default filename to use if no one setted by the user. Returns: true if there is a default filename, false otherwise

bool PasswordCodecPrototype::hasFixedField (  void    )  const [pure virtual]

Defines if this encrypted format supports variable number of field to describe passwords. Returns: true if the number is fixed / false if it is variable

bool PasswordCodecPrototype::isEditable (  void    )  [virtual]

Informs if the passwords informations are editable. Returns: true if they are editable / false otherwise

bool PasswordCodecPrototype::isModified (  void    )  const [virtual]

Informs if the passwords informations are modified. Returns: true if they are modified / false otherwise

bool PasswordCodecPrototype::loadDefaultFile (  string    password )  [virtual]

Decrypts the password informations, stored in the default filename of the plugin, and add them in the list in order they can be retreived by the app. Parameters: password  the password to decrypt the file Returns: true if the decryption is ok / false otherwise

bool PasswordCodecPrototype::loadFile (  string    filename, string    password )  [pure virtual]

Decrypts the password informations and add them in the list in order they can be retreived by the app. Parameters: filename  the filename where encrypted passwords are. password  the password to decrypt the file Returns: true if the decryption is ok / false otherwise

bool PasswordCodecPrototype::newFile (  string    filename, string    password )  [virtual]

Prepares a new file for the backup of password informations. Parameters: filename  the new filename where passwords will be encrypted password  the password to encrypt the data Returns: true if the it succeeds / false otherwise

PasswordInfos * PasswordCodecPrototype::popPasswordInfos (  void    )  [virtual]

Removes the first password structure from the list and then returns it. Returns: the first password structure of the list or NULL if no more available Warning: you must delete the password structure returned when it becomes useless

bool PasswordCodecPrototype::pushPasswordInfos (  PasswordInfos *    password_infos )  [virtual]

Inserts password_infos at the end of the list if the password informations are editable. Parameters: password_infos  the password structure to insert Returns: true if the element has been inserted successfully / false otherwise.

void PasswordCodecPrototype::releaseEditability (  void    )  [virtual]

Releases the right to edit the password informations. Returns: none

bool PasswordCodecPrototype::saveFile (  string    password )  [pure virtual]

Encrypts and saves all the password informations present in the list in the file defined by loadFile() or newFile(). Parameters: password  the password to encrypt the data Returns: true if the save succeeds / false otherwise

bool PasswordCodecPrototype::saveFileAs (  string    filename, string    password )  [virtual]

Encrypts and saves all the password informations present in the list in another file. Parameters: filename  the filename where encrypted passwords must be saved instead of the previous one. password  the password to encrypt the data Returns: true if the save succeeds / false otherwise

void PasswordCodecPrototype::setFieldsName (  PasswordInfos    fields_name_infos )  [pure virtual]

Defines the fields name describing what represents each elements of the password informations. Parameters: fields_name_infos  a PasswordInfos structure in which each element holds the name of fields Returns: true if formats of PasswordInfos structures are compatible / false otherwise.

bool PasswordCodecPrototype::setFilenameToDefault (  void    )  [virtual]

Set the current filename with the default filename value. Returns: true if there is a default filename, false otherwise Note: if there is no default filename, the current filename is not changed

---

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

• PasswordCodecPrototype.h
• PasswordCodecPrototype.cpp

---