KeePass   KeePass Help Center Home KeePass Home | Package Downloads | Flag Translations | Blocks Plugins | Donate Donate  
Home Help Center Home | People Forums | Award Awards | Link Links | Search Search  







IKpAPI3 Struct Referenceabstract

KeePass API for plugins, provides access to all objects in KeePass (singletons, instantiable objects, utility method classes, etc). More...

#include <IKpAPI3.h>

Inheritance diagram for IKpAPI3:
IKpAPI2 IKpAPI IKpUnknown

Public Member Functions

virtual BOOL IsFileLocked ()=0
 Get whether the current file/workspace is locked or not. More...
 
virtual HRESULT LockFile (BOOL bLock)=0
 Lock or unlock the workspace. More...
 
virtual BOOL IsFileReadOnly ()=0
 
virtual HRESULT NotifyUserActivity ()=0
 
virtual HRESULT ParseAndOpenUrlWithEntryInfo (LPCTSTR lpUrl, PW_ENTRY *pEntry)=0
 
virtual BOOL CanSort ()=0
 
virtual HRESULT SortListIfAutoSort ()=0
 
virtual HRESULT SortList (DWORD dwByField, BOOL bAutoSortCall)=0
 
virtual HRESULT EntryListSaveView ()=0
 
virtual HRESULT EntryListRestoreView ()=0
 
virtual HRESULT GroupTreeSaveView (BOOL bSaveSelection)=0
 
virtual HRESULT GroupTreeRestoreView ()=0
 
virtual BOOL RemoveSearchGroup ()=0
 
virtual HRESULT UpdateTitleBar ()=0
 
virtual HRESULT UpdateTrayIcon ()=0
 
virtual HRESULT UpdateGuiToManager ()=0
 Save various view parameters (last selected group and entry, ...) into the database. More...
 
virtual HRESULT UpdateCachedGroupIDs ()=0
 
virtual BOOL IsUnsafeAllowed (HWND hWndParent)=0
 
virtual HRESULT Find (DWORD dwFindGroupId)=0
 
virtual HRESULT QuickFind (LPCTSTR lpText)=0
 
virtual HRESULT ShowToolBar (BOOL bShow)=0
 
virtual UINT GetControlMessageID ()=0
 
virtual BOOL IsInMiniMode ()=0
 
- Public Member Functions inherited from IKpAPI2
virtual BOOL IsInitialCommandLineFile ()=0
 
virtual HRESULT GetProperty (DWORD dwID, void *pOutValue)=0
 Reserved for future use. More...
 
virtual HRESULT SetProperty (DWORD dwID, void *pNewValue)=0
 Reserved for future use. More...
 
- Public Member Functions inherited from IKpAPI
virtual HRESULT CreateInstance (REFCLSID rclsid, REFIID riid, void **ppvObject)=0
 Create an object of the class associated with a specified class ID. More...
 
virtual HRESULT CreateInstanceEx (REFCLSID rclsid, REFIID riid, void **ppvObject, LPARAM lParamW, LPARAM lParamL)=0
 Create an object of the class associated with a specified class ID. More...
 
virtual HRESULT QueryInstance (REFCLSID rclsid, REFIID riid, void **ppvObject)=0
 Get an interface to a static or singleton object. More...
 
virtual HRESULT DeleteObject (void *pObject)=0
 Delete an object that has been allocated by the KeePass CRT. More...
 
virtual HRESULT DeleteArray (void *pArray)=0
 Delete an array/string that has been allocated by the KeePass CRT. More...
 
virtual DWORD GetVersion ()=0
 Get the KeePass version as integer. More...
 
virtual LPCTSTR GetVersionStr ()=0
 Get the KeePass version as string. More...
 
virtual DWORD GetCharSize ()=0
 Get the size of a TCHAR in bytes (can be used to detect whether KeePass is compiled in multi-byte or Unicode mode). More...
 
virtual DWORD GetPointerSize ()=0
 Get the size of a pointer in bytes (can be used to detect whether KeePass is compiled in 32 or 64 bit mode). More...
 
virtual DWORD GetDebugLevel ()=0
 Get a value indicating which debugging features are present. More...
 
virtual HWND GetMainWindowHandle ()=0
 Get a handle to the KeePass main window. More...
 
virtual HIMAGELIST GetClientIconsImageList ()=0
 Get a handle to the client icons image list. More...
 
virtual LPCTSTR GetTranslationName ()=0
 Get the name of the currently active translation table. More...
 
virtual LPCTSTR Translate (LPCTSTR lpDefString)=0
 Translate a string using the currently active translation file of KeePass. More...
 
virtual HRESULT GetNeverExpireTime (PW_TIME *pBuf)=0
 Get the predefined PW_TIME value that indicates infinity. More...
 
virtual HRESULT GetCurrentPwTime (PW_TIME *pBuf)=0
 Get the current local system time as PW_TIME structure. More...
 
virtual BOOL IsFileOpen ()=0
 Indicates whether there's currently a file open (if this is the case, the methods of the IKpDatabase interface can be used). More...
 
virtual LPCTSTR GetAbsoluteDatabasePath ()=0
 
virtual DWORD GetEntryListItemCount ()=0
 
virtual DWORD GetSelectedGroupId ()=0
 
virtual BOOL IsFileModified ()=0
 Get the 'modified' bit of the current database. More...
 
virtual HRESULT SetFileModified (BOOL bModified)=0
 Set the 'modified' bit of the current database. More...
 
virtual BOOL IsDisplayingDialog ()=0
 Get a bit indicating whether KeePass is currently showing a modal dialog. More...
 
virtual HRESULT SetDisplayDialog (BOOL bDialogDisplayed)=0
 Set a bit indicating whether KeePass is currently showing a modal dialog. More...
 
virtual HRESULT EntryListEnsureVisible (INT nItem, BOOL bPartialOK)=0
 
virtual HRESULT UpdateUI ()=0
 Update group tree and entry list (preserving current view if possible). More...
 
virtual HRESULT UpdateGroupTree ()=0
 
virtual HRESULT UpdateEntryList ()=0
 
virtual HRESULT UpdateToolBar ()=0
 Update the toolbar state. More...
 
virtual HRESULT SetStatusBarText (LPCTSTR lpText)=0
 
virtual HRESULT ShowDialog (DWORD dwDialogId, DWORD dwVersion, void *pConfig, INT *pnResult, void *pOutput)=0
 Show one of the KeePass dialogs. More...
 
virtual HRESULT AutoType (PW_ENTRY *pEntry, LONG_PTR lFlags)=0
 
virtual HRESULT AddImportMenuItem (LPCTSTR lpText, UINT uId, INT nIconId)=0
 
- Public Member Functions inherited from IKpUnknown
virtual HRESULT QueryInterface (REFIID riid, void **ppvObject)=0
 COM infrastructure, provides access to all interfaces supported by this object. More...
 
virtual ULONG AddRef ()=0
 COM infrastructure, increments the reference count for this object. More...
 
virtual ULONG Release ()=0
 COM infrastructure, decrements the reference count for this object and eventually deletes it. More...
 

Detailed Description

KeePass API for plugins, provides access to all objects in KeePass (singletons, instantiable objects, utility method classes, etc).

Member Function Documentation

virtual BOOL IKpAPI3::CanSort ( )
pure virtual
virtual HRESULT IKpAPI3::EntryListRestoreView ( )
pure virtual
virtual HRESULT IKpAPI3::EntryListSaveView ( )
pure virtual
virtual HRESULT IKpAPI3::Find ( DWORD  dwFindGroupId)
pure virtual
virtual UINT IKpAPI3::GetControlMessageID ( )
pure virtual
virtual HRESULT IKpAPI3::GroupTreeRestoreView ( )
pure virtual
virtual HRESULT IKpAPI3::GroupTreeSaveView ( BOOL  bSaveSelection)
pure virtual
virtual BOOL IKpAPI3::IsFileLocked ( )
pure virtual

Get whether the current file/workspace is locked or not.

virtual BOOL IKpAPI3::IsFileReadOnly ( )
pure virtual
virtual BOOL IKpAPI3::IsInMiniMode ( )
pure virtual
virtual BOOL IKpAPI3::IsUnsafeAllowed ( HWND  hWndParent)
pure virtual
virtual HRESULT IKpAPI3::LockFile ( BOOL  bLock)
pure virtual

Lock or unlock the workspace.

virtual HRESULT IKpAPI3::NotifyUserActivity ( )
pure virtual
virtual HRESULT IKpAPI3::ParseAndOpenUrlWithEntryInfo ( LPCTSTR  lpUrl,
PW_ENTRY pEntry 
)
pure virtual
virtual HRESULT IKpAPI3::QuickFind ( LPCTSTR  lpText)
pure virtual
virtual BOOL IKpAPI3::RemoveSearchGroup ( )
pure virtual
virtual HRESULT IKpAPI3::ShowToolBar ( BOOL  bShow)
pure virtual
virtual HRESULT IKpAPI3::SortList ( DWORD  dwByField,
BOOL  bAutoSortCall 
)
pure virtual
virtual HRESULT IKpAPI3::SortListIfAutoSort ( )
pure virtual
virtual HRESULT IKpAPI3::UpdateCachedGroupIDs ( )
pure virtual
virtual HRESULT IKpAPI3::UpdateGuiToManager ( )
pure virtual

Save various view parameters (last selected group and entry, ...) into the database.

virtual HRESULT IKpAPI3::UpdateTitleBar ( )
pure virtual
virtual HRESULT IKpAPI3::UpdateTrayIcon ( )
pure virtual

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



Documentation generated with Doxygen.




Valid XHTML 1.0 Transitional Document

Get KeePass

Flattr this


KeePass is OSI Certified Open Source Software
Copyright © 2003-2014
Dominik Reichl, [Legal Contact / Imprint] [Disclaimer] [Acknowledgements] [Donate], Downloads hosted at

Get KeePass Password Safe at
SourceForge.net. Fast, secure and Free Open Source software downloads