com.jniwrapper.win32.shell
Interface IActiveDesktop

All Known Implementing Classes:
IActiveDesktopImpl

public interface IActiveDesktop

Allows to manage the desktop items and wallpaper on a local computer.


Field Summary
static java.lang.String INTERFACE_IDENTIFIER
           
 
Method Summary
 void addDesktopItem(ActiveDesktopItem value)
          Adds a desktop item.
 void addDesktopItemWithUI(Wnd wnd, ActiveDesktopItem value)
          Adds a desktop item to the Active Desktop after displaying user interfaces that confirm the addition of the desktop item, verify security zone permissions, and ask if the user wants to create a subscription.
 void addUrl(Wnd wnd, java.net.URL source, ActiveDesktopItem item)
          Adds the desktop item associated with the specified URL.
 void applyChanges(ApplyChangesOptions value)
          Applies changes to the Active Desktop and saves them in the registry.
 void generateDesktopItemHtml(java.io.File file, ActiveDesktopItem item)
          Generates a generic HTML page containing the given desktop item.
 ActiveDesktopItem getDesktopItem(int index)
          Returns the specified desktop item.
 ActiveDesktopItem getDesktopItemByID(int id)
          Returns the desktop item that matches the given identification.
 ActiveDesktopItem getDesktopItemBySource(java.net.URL source)
          Retrieves a desktop item using its source URL.
 int getDesktopItemCount()
          Returns a count of the desktop items.
 DesktopItemOptions getDesktopItemOptions()
          Returns the desktop item's options.
 java.lang.String getPattern()
          Returns the pattern currently being used.
 java.io.File getWallpaper()
          Returns the file of the wallpaper currently being used.
 WallpaperOptions getWallpaperOptions()
          Returns the wallpaper options.
 void modifyDesktopItem(ActiveDesktopItem value, ModifyDesktopItemOptions options)
          Modifies the desktop item.
 void removeDesktopItem(ActiveDesktopItem value)
          Removes the specified desktop item from the desktop.
 void setDesktopItemOptions(DesktopItemOptions value)
          Sets the item's options.
 void setPattern(java.lang.String value)
          Sets the Active Desktop pattern.
 void setWallpaper(java.io.File value)
          Sets the file of the wallpaper to be set.
 void setWallpaperOptions(WallpaperOptions value)
          Sets the wallpaper options.
 

Field Detail

INTERFACE_IDENTIFIER

public static final java.lang.String INTERFACE_IDENTIFIER
See Also:
Constant Field Values
Method Detail

applyChanges

public void applyChanges(ApplyChangesOptions value)
                  throws com.jniwrapper.win32.com.ComException
Applies changes to the Active Desktop and saves them in the registry.

Parameters:
value - value that contains the changes to be applied. Can be one of the values from the ApplyChangesOptions class
Throws:
com.jniwrapper.win32.com.ComException

getWallpaper

public java.io.File getWallpaper()
                          throws com.jniwrapper.win32.com.ComException
Returns the file of the wallpaper currently being used.

Returns:
the file of the wallpaper currently being used
Throws:
com.jniwrapper.win32.com.ComException

setWallpaper

public void setWallpaper(java.io.File value)
                  throws com.jniwrapper.win32.com.ComException
Sets the file of the wallpaper to be set.

Parameters:
value - the file of the wallpaper to be set
Throws:
com.jniwrapper.win32.com.ComException

getWallpaperOptions

public WallpaperOptions getWallpaperOptions()
                                     throws com.jniwrapper.win32.com.ComException
Returns the wallpaper options.

Returns:
the wallpaper options
Throws:
com.jniwrapper.win32.com.ComException

setWallpaperOptions

public void setWallpaperOptions(WallpaperOptions value)
                         throws com.jniwrapper.win32.com.ComException
Sets the wallpaper options.

Parameters:
value - the options to be set
Throws:
com.jniwrapper.win32.com.ComException

getPattern

public java.lang.String getPattern()
                            throws com.jniwrapper.win32.com.ComException
Returns the pattern currently being used.

Returns:
string of decimals whose bit pattern represents a picture. Each decimal represents the on/off state of the 8 pixels in that row
Throws:
com.jniwrapper.win32.com.ComException

setPattern

public void setPattern(java.lang.String value)
                throws com.jniwrapper.win32.com.ComException
Sets the Active Desktop pattern.

Parameters:
value - string value that contains a string of decimals whose bit pattern represents a picture. Each decimal represents the on/off state of the 8 pixels in that row
Throws:
com.jniwrapper.win32.com.ComException

getDesktopItemOptions

public DesktopItemOptions getDesktopItemOptions()
                                         throws com.jniwrapper.win32.com.ComException
Returns the desktop item's options.

Returns:
the desktop item's options
Throws:
com.jniwrapper.win32.com.ComException

setDesktopItemOptions

public void setDesktopItemOptions(DesktopItemOptions value)
                           throws com.jniwrapper.win32.com.ComException
Sets the item's options.

Parameters:
value - the options to set
Throws:
com.jniwrapper.win32.com.ComException

addDesktopItem

public void addDesktopItem(ActiveDesktopItem value)
                    throws com.jniwrapper.win32.com.ComException
Adds a desktop item.

Throws:
com.jniwrapper.win32.com.ComException

addDesktopItemWithUI

public void addDesktopItemWithUI(Wnd wnd,
                                 ActiveDesktopItem value)
                          throws com.jniwrapper.win32.com.ComException
Adds a desktop item to the Active Desktop after displaying user interfaces that confirm the addition of the desktop item, verify security zone permissions, and ask if the user wants to create a subscription.

Parameters:
wnd - Handle of the parent window. If NULL, the desktop item is added without displaying any user interface, in accordance with the corresponding security zone permissions
value - details of the desktop item to be added
Throws:
com.jniwrapper.win32.com.ComException

modifyDesktopItem

public void modifyDesktopItem(ActiveDesktopItem value,
                              ModifyDesktopItemOptions options)
                       throws com.jniwrapper.win32.com.ComException
Modifies the desktop item.

Parameters:
value - structure containing the modifications
options - the flags used for the modification
Throws:
com.jniwrapper.win32.com.ComException

removeDesktopItem

public void removeDesktopItem(ActiveDesktopItem value)
                       throws com.jniwrapper.win32.com.ComException
Removes the specified desktop item from the desktop.

Parameters:
value - specifies the item to be removed
Throws:
com.jniwrapper.win32.com.ComException

getDesktopItemCount

public int getDesktopItemCount()
                        throws com.jniwrapper.win32.com.ComException
Returns a count of the desktop items.

Returns:
a count of the desktop items
Throws:
com.jniwrapper.win32.com.ComException

getDesktopItem

public ActiveDesktopItem getDesktopItem(int index)
                                 throws com.jniwrapper.win32.com.ComException
Returns the specified desktop item.

Parameters:
index - integer value that contains the desktop item's index. The index values start at zero
Returns:
the retrieved desktop item
Throws:
com.jniwrapper.win32.com.ComException

getDesktopItemByID

public ActiveDesktopItem getDesktopItemByID(int id)
                                     throws com.jniwrapper.win32.com.ComException
Returns the desktop item that matches the given identification.

Parameters:
id - integer value that contains the desktop item's identification
Returns:
the retrieved desktop item
Throws:
com.jniwrapper.win32.com.ComException

generateDesktopItemHtml

public void generateDesktopItemHtml(java.io.File file,
                                    ActiveDesktopItem item)
                             throws com.jniwrapper.win32.com.ComException
Generates a generic HTML page containing the given desktop item.

Parameters:
file - the file to store the HTML file in
item - the desktop item to insert in the HTML page
Throws:
com.jniwrapper.win32.com.ComException

addUrl

public void addUrl(Wnd wnd,
                   java.net.URL source,
                   ActiveDesktopItem item)
            throws com.jniwrapper.win32.com.ComException
Adds the desktop item associated with the specified URL.

Parameters:
wnd - Handle to the parent window for the user interface
source - the URL of the desktop item
item - the details of the desktop item to be added
Throws:
com.jniwrapper.win32.com.ComException

getDesktopItemBySource

public ActiveDesktopItem getDesktopItemBySource(java.net.URL source)
                                         throws com.jniwrapper.win32.com.ComException
Retrieves a desktop item using its source URL.

Parameters:
source - the source URL of the desktop item
Returns:
the details about the desktop item
Throws:
com.jniwrapper.win32.com.ComException