Skip to content

Latest commit

 

History

History
254 lines (127 loc) · 5.79 KB

PyIShellBrowser.md

File metadata and controls

254 lines (127 loc) · 5.79 KB

PyIShellBrowser

PyIShellBrowser Object

Exposed by Windows Explorer and the Open File common dialog box to provide services for namespace extensions.

Methods

PyIShellBrowser.BrowseObject

BrowseObject(pidl, wFlags) Navigates to a different location

Parameters

  • pidl : PyIDL

    Item id list that specifies the new browse location, can be None

  • wFlags : int

    Combination of shellcon.SBSP_* flags

PyIShellBrowser.EnableModelessSB

EnableModelessSB(fEnable) Enables or disables modeless dialogs

Parameters

  • fEnable : boolean

    Use True to enable or False to disable modeless dialog boxes

PyIShellBrowser.GetControlWindow

GetControlWindow(id) Returns a handle to one of the browser's control elements

Parameters

  • id : int

    One of shellcon.FCW_* values

PyIShellBrowser.GetViewStateStream

PyIStream = GetViewStateStream(grfMode) Returns a stream that can be used to access view state information

Parameters

  • grfMode : int

    Read/write mode, one of STGM_READ,STGM_WRITE,STGM_READWRITE

PyIShellBrowser.InsertMenusSB

PyOLEMENUGROUPWIDTHS = InsertMenusSB(hmenuShared, lpMenuWidths

) Updates a composite menu with container's options

Parameters

  • hmenuShared : PyHANDLE

    Newly created menu that contains no items

  • lpMenuWidths : PyOLEMENUGROUPWIDTHS

    Tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned.

PyIShellBrowser.OnViewWindowActive

OnViewWindowActive(pshv) Callback triggered when a view window is activated

Parameters

PyIShellBrowser.QueryActiveShellView

PyIShellView = QueryActiveShellView() Returns the currently displayed view

PyIShellBrowser.RemoveMenusSB

RemoveMenusSB(hmenuShared) Asks container to remove any items it added to a composite menu

Parameters

  • hmenuShared : PyHANDLE

    Handle to the composite menu

PyIShellBrowser.SendControlMsg

int = SendControlMsg(id, uMsg

, wParam

, lParam

) Sends a control msg to browser's toolbar or status bar

Parameters

  • id : int

    shellcon.FCW_TOOLBAR or FCW_STATUS

  • uMsg : int

    The message to send

  • wParam : int

    Value is dependent on the message

  • lParam : long

    Value is dependent on the message

PyIShellBrowser.SetMenuSB

SetMenuSB(hmenuShared, holemenuRes, hwndActiveObject) Attaches a shared menu to a shell view window

Parameters

  • hmenuShared : PyHANDLE

    Handle to the shared menu

  • holemenuRes : PyHANDLE

    Reserved, use only None (or 0)

  • hwndActiveObject : PyHANDLE

    Handle to the shell window

PyIShellBrowser.SetStatusTextSB

SetStatusTextSB(pszStatusText) Sets the status text in view's status bar

Parameters

  • pszStatusText : str

    New status to be displayed

PyIShellBrowser.SetToolbarItems

SetToolbarItems(lpButtons, uFlags) Adds toolbar buttons to the browser's toolbar

Parameters

  • lpButtons : PyLPTBBUTTONSB

    Sequence of tuples describing the buttons to be added

  • uFlags : int

    Indicates button positions, combination of shellcon.FCT_*

PyIShellBrowser.TranslateAcceleratorSB

TranslateAcceleratorSB(pmsg, wID) Translates keystrokes used as menu item activators

Parameters

  • pmsg : PyMSG

    Keystroke message to be translated

  • wID : int

    Menu command id for the keystroke