PyIActiveDesktop.md

PyIActiveDesktop

PyIActiveDesktop Object

An interface to the ActiveDesktop

Methods

• ApplyChanges

  Applies changes to ActiveDesktop settings and persists them to the registry. 

• GetWallpaper

  Returns the current wallpaper 

• SetWallpaper

  Sets the desktop wallpaper 

• GetWallpaperOptions

  Returns wallpaper style 

• SetWallpaperOptions

  Sets wallpaper style 

• GetPattern

  Returns the wallpaper pattern 

• SetPattern

  Sets the wallpaper pattern 

• GetDesktopItemOptions

  Returns options for Active Desktop. 

• SetDesktopItemOptions

  Sets Active Desktop options 

• AddDesktopItem

  Creates a new item to display on the desktop 

• AddDesktopItemWithUI

  Adds a desktop item, allowing user interaction 

• ModifyDesktopItem

  Changes parameters for a desktop item 

• RemoveDesktopItem

  Removes an item from the Active Desktop 

• GetDesktopItemCount

  Returns number of defined desktop items. 

• GetDesktopItem

  Returns desktop item parameters by index 

• GetDesktopItemByID

  Returns desktop item parameters by Id 

• GenerateDesktopItemHtml

  Creates an HTML page for the desktop item 

• AddUrl

  Adds a web page to desktop, allowing user interaction 

• GetDesktopItemBySource

  Returns desktop item parameters by URL 

PyIActiveDesktop.AddDesktopItem

AddDesktopItem(comp, Reserved) Creates a new item to display on the desktop

Parameters

• comp : dict

  COMPONENT dictionary

• Reserved=0 : int

  Use 0 if passed in

PyIActiveDesktop.AddDesktopItemWithUI

AddDesktopItemWithUI(hwnd, comp, Flags) Adds a desktop item, allowing user interaction

Parameters

• hwnd : PyHANDLE

  Handle to parent window

• comp : dict

  COMPONENT dictionary

• Flags : int

  One of shellcon.DTI_ADDUI_* flags

PyIActiveDesktop.AddUrl

AddUrl(hwnd, Source, comp, Flags) Adds a web page to desktop, allowing user interaction

Parameters

• hwnd : PyHANDLE

  Parent windows for any user interactive

• Source : PyUNICODE

  Source URL

• comp : dict

  COMPONENT dictionary

• Flags : int

  ADDURL_SILENT, or 0

PyIActiveDesktop.ApplyChanges

ApplyChanges(Flags) Applies changes to ActiveDesktop settings and persists them to the registry.

Parameters

• Flags : int

  Combination of shellcon.AD_APPLY_* flags

PyIActiveDesktop.GenerateDesktopItemHtml

GenerateDesktopItemHtml(FileName, comp, Reserved) Creates an HTML page for the desktop item

Parameters

• FileName : PyUNICODE

  Name of file to be created

• comp : dict

  COMPONENT dictionary specifying the desktop item

• Reserved=0 : int

  Use 0 if passed in

PyIActiveDesktop.GetDesktopItem

dict = GetDesktopItem(Component, Reserved

) Returns desktop item parameters by index

Parameters

• Component : int

  The zero-based index of the component to get

• Reserved=0 : int

  Use 0 if passed in

Return Value

Returns a COMPONENT dictionary describing the item

PyIActiveDesktop.GetDesktopItemByID

dict = GetDesktopItemByID(ID, reserved

) Returns desktop item parameters by Id

Parameters

• ID : int

  The Id of the desktop item

• reserved=0 : int

  Use 0 if passed in

Return Value

Returns a COMPONENT dictionary

PyIActiveDesktop.GetDesktopItemBySource

dict = GetDesktopItemBySource(Source, Reserved

) Returns desktop item parameters by URL

Parameters

• Source : PyUNICODE

  The URL address of the item to retrieve

• Reserved=0 : int

  Use 0 if passed in

Return Value

Returns a COMPONENT dictionary

PyIActiveDesktop.GetDesktopItemCount

GetDesktopItemCount() Returns number of defined desktop items.

PyIActiveDesktop.GetDesktopItemOptions

dict = GetDesktopItemOptions() Returns options for Active Desktop.

Return Value

Returns a COMPONENTSOPT dictionary

PyIActiveDesktop.GetPattern

GetPattern(cchPattern, Reserved) Returns the wallpaper pattern

Parameters

• cchPattern=1024 : int

  Number of characters to allocate for buffer

• Reserved=0 : int

  Use 0 if passed in

Return Value

Returns a unicode string containing decimal values representing the pattern

PyIActiveDesktop.GetWallpaper

PyUNICODE = GetWallpaper(cchWallpaper, Reserved

) Returns the current wallpaper

Parameters

• cchWallpaper=MAX_PATH : int

  Number of characters to allocate for buffer

• Reserved=0 : int

  Use 0 if passed in

PyIActiveDesktop.GetWallpaperOptions

int = GetWallpaperOptions(Reserved) Returns wallpaper style

Parameters

• Reserved=0 : int

  Use 0 if passed in

Return Value

Returns one of the WPSTYLE_* values

PyIActiveDesktop.ModifyDesktopItem

ModifyDesktopItem(comp, Flags) Changes parameters for a desktop item

Parameters

• comp : dict

  COMPONENT dictionary

• Flags : int

  Combination of shellcon.COMP_ELEM_* flags

PyIActiveDesktop.RemoveDesktopItem

RemoveDesktopItem(comp, Reserved) Removes an item from the Active Desktop

Parameters

• comp : dict

  COMPONENT dictionary specifying which component to remove

• Reserved=0 : int

  Use 0 if passed in

PyIActiveDesktop.SetDesktopItemOptions

SetDesktopItemOptions(comp, Reserved) Sets Active Desktop options

Parameters

• comp : dict

  COMPONENTSOPT dictionary

• Reserved=0 : int

  Use 0 if passed in

PyIActiveDesktop.SetPattern

SetPattern(Pattern, Reserved) Sets the wallpaper pattern

Parameters

• Pattern : PyUNICODE

  String of decimal numbers representing a picture

• Reserved=0 : int

  Use 0 if passed in

PyIActiveDesktop.SetWallpaper

SetWallpaper(Wallpaper, Reserved) Sets the desktop wallpaper

Parameters

• Wallpaper : PyUNICODE

  File to be used as new wallpaper

• Reserved=0 : int

  Reserved, use 0 if passed in

PyIActiveDesktop.SetWallpaperOptions

SetWallpaperOptions(Style, Reserved) Sets wallpaper style

Parameters

• Style : int

  The wallpaper style, one of the WPSTYLE_* constants

• Reserved=0 : int

  Reserved, use 0 if passed in