KWebWallet Class Reference

#include <kwebwallet.h>

Inheritance diagram for KWebWallet:

Classes
struct	WebForm

Public Types
typedef QList< WebForm >	WebFormList

Public Slots
void	acceptSaveFormDataRequest (const QString &key)
void	rejectSaveFormDataRequest (const QString &key)

Signals
void	fillFormRequestCompleted (bool ok)
void	saveFormDataCompleted (const QUrl &url, bool ok)
void	saveFormDataRequested (const QString &key, const QUrl &url)
void	walletClosed ()

Public Member Functions
	KWebWallet (QObject *parent=0, WId wid=0)
virtual	~KWebWallet ()
void	fillFormData (QWebFrame *frame, bool recursive=true)
WebFormList	formsWithCachedData (QWebFrame *frame, bool recursive=true) const
void	removeFormData (QWebFrame *frame, bool recursive)
void	removeFormData (const WebFormList &forms)
void	saveFormData (QWebFrame *frame, bool recursive=true, bool ignorePasswordFields=false)

Protected Member Functions
virtual void	fillFormDataFromCache (const KUrl::List &list)
void	fillWebForm (const KUrl &url, const WebFormList &forms)
WebFormList	formsToDelete () const
WebFormList	formsToFill (const KUrl &url) const
WebFormList	formsToSave (const QString &key) const
virtual bool	hasCachedFormData (const WebForm &form) const
virtual void	removeFormDataFromCache (const WebFormList &forms)
virtual void	saveFormDataToCache (const QString &key)

Detailed Description

A class that provides KDE wallet integration for QWebFrame.

Normally, you will use this class via KWebPage. In this case, you need to connect to the saveFormDataRequested signal and call either acceptSaveFormDataRequest or rejectSaveFormDataRequest, typically after asking the user whether they want to save the form data.

You will also need to call fillFormData when a QWebFrame has finished loading. To do this, connect to QWebPage::loadFinished and, if the page was loaded successfully, call

page->wallet()->fillFormData(page->mainFrame());

If you wish to use this directly with a subclass of QWebPage, you should call saveFormData from QWebPage::acceptNavigationRequest when a user submits a form.

See also

KWebPage

Author

Dawit Alemayehu <adawit @ kde.org>

Since

4.4

Definition at line 64 of file kwebwallet.h.

Member Typedef Documentation

typedef QList<WebForm> KWebWallet::WebFormList

A list of web forms.

Definition at line 94 of file kwebwallet.h.

Constructor & Destructor Documentation

KWebWallet::KWebWallet ( QObject *  parent = 0, WId  wid = 0  )

explicit

Constructs a KWebWallet.

parent is usually the QWebPage this wallet is being used for.

The wid parameter is used to tell KDE's wallet manager which window is requesting access to the wallet.

Parameters

parent	the owner of this wallet
wid	the window ID of the window the web page will be embedded in

Definition at line 379 of file kwebwallet.cpp.

KWebWallet::~KWebWallet ( )

virtual

Destructor.

Definition at line 394 of file kwebwallet.cpp.

Member Function Documentation

void KWebWallet::acceptSaveFormDataRequest ( const QString &  key )

slot

Accepts the save form data request associated with key.

The key parameter is the one sent through the saveFormDataRequested signal.

You must always call this function or rejectSaveFormDataRequest in order to complete the save form data request. Otherwise, the request will simply be ignored.

See also

saveFormDataRequested.

Definition at line 530 of file kwebwallet.cpp.

void KWebWallet::fillFormData	(	QWebFrame *	frame,
		bool	recursive = true
	)

Attempts to fill forms contained in frame with cached data.

If recursive is set to true, the default, then this function will attempt to fill out forms in the specified frame and all its children frames.

Definition at line 419 of file kwebwallet.cpp.

void KWebWallet::fillFormDataFromCache ( const KUrl::List &  list )

protectedvirtual

Fills form data from persistent storage.

If you reimplement this function, call formsToFill to obtain the list of forms pending to be filled. Once you fill the list with the cached data from the persistent storage, you must call fillWebForm to fill out the actual web forms.

See also

formsToFill

Definition at line 584 of file kwebwallet.cpp.

void KWebWallet::fillFormRequestCompleted ( bool  ok )

signal

This signal is emitted whenever a fill form data request is completed.

ok will be set to true if any forms were successfully filled with cached data from the persistent storage.

See also

fillFormData

Since

4.5

void KWebWallet::fillWebForm ( const KUrl &  url, const WebFormList &  forms  )

protected

Fills the web forms in frame that point to url with data from forms.

See also

fillFormDataFromCache.

Definition at line 540 of file kwebwallet.cpp.

WebFormList KWebWallet::formsToDelete ( ) const

protected

Returns forms to be removed from persistent storage.

KWebWallet::WebFormList KWebWallet::formsToFill ( const KUrl &  url ) const

protected

Returns a list of forms for url that are waiting to be filled.

This function returns an empty list if there is no pending requests for filling forms associated with url.

Definition at line 567 of file kwebwallet.cpp.

KWebWallet::WebFormList KWebWallet::formsToSave ( const QString &  key ) const

protected

Returns a list of for key that are waiting to be saved.

This function returns an empty list if there are no pending requests for saving forms associated with key.

Definition at line 572 of file kwebwallet.cpp.

KWebWallet::WebFormList KWebWallet::formsWithCachedData	(	QWebFrame *	frame,
		bool	recursive = true
	)		const

Returns a list of forms in frame that have cached data in the peristent storage.

If recursive is set to true, the default, then this function will will also return the cached form data for all the children frames of frame.

If the site currently rendered in frame does not contain any forms or there is no cached data for the forms found in frame, then this function will return an empty list.

Note that this function will only return the information about the forms in frame and not their cached data, i.e. the fields member variable in the returned WebForm list will always be empty.

Definition at line 399 of file kwebwallet.cpp.

bool KWebWallet::hasCachedFormData ( const WebForm &  form ) const

protectedvirtual

Returns true when there is data associated with form in the persistent storage.

Definition at line 577 of file kwebwallet.cpp.

void KWebWallet::rejectSaveFormDataRequest ( const QString &  key )

slot

Rejects the save form data request associated with key.

The key parameter is the one sent through the saveFormDataRequested signal.

See also

saveFormDataRequested.

Definition at line 535 of file kwebwallet.cpp.

void KWebWallet::removeFormData	(	QWebFrame *	frame,
		bool	recursive
	)

Removes the form data specified by forms from the persistent storage.

This function is provided for convenience and simply calls formsWithCachedData and removeFormData(WebFormList). Note that this function will remove all cached data for forms found in frame. If recursive is set to true, then all cached data for all of the child frames of frame will be removed from the persistent storage as well.

See also

formsWithCachedData

removeFormData

Definition at line 518 of file kwebwallet.cpp.

void KWebWallet::removeFormData

(

const WebFormList &

forms

)

Removes the form data specified by forms from the persistent storage.

Call formsWithCachedData to obtain a list of forms with data cached in persistent storage.

See also

formsWithCachedData

Definition at line 524 of file kwebwallet.cpp.

void KWebWallet::removeFormDataFromCache ( const WebFormList &  forms )

protectedvirtual

Removes all cached form data associated with forms from persistent storage.

If you reimplement this function, call formsToDelete to obtain the list of form data pending to be removed from persistent storage.

See also

formsToDelete

Definition at line 608 of file kwebwallet.cpp.

void KWebWallet::saveFormData	(	QWebFrame *	frame,
		bool	recursive = true,
		bool	ignorePasswordFields = false
	)

Attempts to save the form data from frame and its children frames.

If recursive is set to true, the default, then form data from all the child frames of frame will be saved. Set ignorePasswordFields to true if you do not want data from password fields to not be saved.

You must connect to the saveFormDataRequested signal and call either rejectSaveFormDataRequest or acceptSaveFormDataRequest signals in order to complete the save request. Otherwise, you request will simply be ignored.

Definition at line 478 of file kwebwallet.cpp.

void KWebWallet::saveFormDataCompleted ( const QUrl &  url, bool  ok  )

signal

This signal is emitted whenever a save form data request is completed.

ok will be set to true if the save form data request for url was completed successfully.

See also

saveFormDataRequested

void KWebWallet::saveFormDataRequested ( const QString &  key, const QUrl &  url  )

signal

This signal is emitted whenever a save form data request is received.

Unless you connect to this signal and and call acceptSaveFormDataRequest or rejectSaveFormDataRequest slots, the save form data requested through saveFormData will simply be ignored.

key is a value that uniquely identifies the save request and url is the address for which the form data is being saved.

See also

acceptSaveFormDataRequest

rejectSaveFormDataRequest

void KWebWallet::saveFormDataToCache ( const QString &  key )

protectedvirtual

Stores form data associated with key to a persistent storage.

If you reimplement this function, call formsToSave to obtain the list of form data pending to be saved to persistent storage.

See also

formsToSave

Definition at line 599 of file kwebwallet.cpp.

void KWebWallet::walletClosed ( )

signal

This signal is emitted whenever the current wallet is closed.

---

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

• kwebwallet.h
• kwebwallet.cpp