MrSID Decode SDK for Raster Reference Manual  9.5.1.4427
MrSIDPasswordDelegate Class Referenceabstract

delegate for locked MrSID images More...

#include <MrSIDPasswordDelegate.h>

Inheritance diagram for MrSIDPasswordDelegate:

Public Member Functions

 MrSIDPasswordDelegate ()
 constructor More...
 
virtual ~MrSIDPasswordDelegate ()
 destructor More...
 
virtual LT_STATUS reportIncorrectPassword ()=0
 user function for user notification More...
 
virtual LT_STATUS getPassword ()=0
 user function for getting the password More...
 

Protected Member Functions

char * getPasswordBuffer ()
 get password buffer More...
 
lt_uint32 getPasswordBufferLength ()
 get password buffer length More...
 

Friends

class MrSIDImageReaderInterface
 
class MG2ImageWriter
 
class MG3ImageWriter
 
class MG4ImageWriter
 

Detailed Description

This abstract class is used with MrSIDImageReaderBase::setPasswordDelegate() to supply a user-callback mechanism for supplying text passwords to the internal MrSID decoder logic.

Users should derive their own class from this, supplying their own reportIncorrectPassword() and getPassword() methods.

Definition at line 30 of file MrSIDPasswordDelegate.h.

Constructor & Destructor Documentation

MrSIDPasswordDelegate::MrSIDPasswordDelegate ( )
virtual MrSIDPasswordDelegate::~MrSIDPasswordDelegate ( )
virtual

Member Function Documentation

virtual LT_STATUS MrSIDPasswordDelegate::getPassword ( )
pure virtual

This function is called by the decoder to request a password from the user. Derived classes must implement this function, e.g. to pop up a text-entry dialog box.

The implementation of this function must copy the password into the buffer pointed by getPasswordBuffer().

Returns
success or failure in getting password from user

Implemented in MrSIDSimplePasswordDelegate.

char* MrSIDPasswordDelegate::getPasswordBuffer ( )
protected

This function returns a pointer to the allocated area for the password obtained from the user.

Returns
pointer to the password buffer
lt_uint32 MrSIDPasswordDelegate::getPasswordBufferLength ( )
protected

This function returns the length of the buffer returned from getPasswordBuffer().

Returns
length of the password buffer
virtual LT_STATUS MrSIDPasswordDelegate::reportIncorrectPassword ( )
pure virtual

This function is called by the decoder if the password entered was incorrect. Derived classes must implement this function, e.g. to pop up a message box, abort the operation, etc.

Returns
success or failure in reporting to user

Implemented in MrSIDSimplePasswordDelegate.

Friends And Related Function Documentation

friend class MG2ImageWriter
friend

Definition at line 97 of file MrSIDPasswordDelegate.h.

friend class MG3ImageWriter
friend

Definition at line 98 of file MrSIDPasswordDelegate.h.

friend class MG4ImageWriter
friend

Definition at line 99 of file MrSIDPasswordDelegate.h.

friend class MrSIDImageReaderInterface
friend

Definition at line 96 of file MrSIDPasswordDelegate.h.


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

LizardTech