iTunes COM Interface: IITWindow Interface Reference

iTunes COM

previous page next page
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

IITWindow Interface Reference

Inheritance diagram for IITWindow:

IITBrowserWindow IITPlaylistWindow List of all members.

Detailed Description

Represents an iTunes window.

You can retrieve all the windows using IiTunes::Windows().

Public Member Functions

Properties
HRESULT Name ([out, retval] BSTR *name)
 Returns the name (title) of the window.
HRESULT Kind ([out, retval] ITWindowKind *kind)
 Returns the kind of the window.
HRESULT Visible ([out, retval] VARIANT_BOOL *isVisible)
 Returns true if the window is visible.
HRESULT Visible ([in] VARIANT_BOOL shouldBeVisible)
 Hide or show the window.
HRESULT Resizable ([out, retval] VARIANT_BOOL *isResizable)
 Returns true if the window is resizable.
HRESULT Minimized ([out, retval] VARIANT_BOOL *isMinimized)
 Returns true if the window is minimized.
HRESULT Minimized ([in] VARIANT_BOOL shouldBeMinimized)
 Minimize or restore the window.
HRESULT Maximizable ([out, retval] VARIANT_BOOL *isMaximizable)
 Returns true if the window is maximizable.
HRESULT Maximized ([out, retval] VARIANT_BOOL *isMaximized)
 Returns true if the window is maximized.
HRESULT Maximized ([in] VARIANT_BOOL shouldBeMaximized)
 Maximize or restore the window.
HRESULT Zoomable ([out, retval] VARIANT_BOOL *isZoomable)
 Returns true if the window is zoomable.
HRESULT Zoomed ([out, retval] VARIANT_BOOL *isZoomed)
 Returns true if the window is zoomed.
HRESULT Zoomed ([in] VARIANT_BOOL shouldBeZoomed)
 Zoom or unzoom the window.
HRESULT Top ([out, retval] long *top)
 Returns the screen coordinate of the top edge of the window.
HRESULT Top ([in] long top)
 Set the screen coordinate of the top edge of the window.
HRESULT Left ([out, retval] long *left)
 Returns the screen coordinate of the left edge of the window.
HRESULT Left ([in] long left)
 Set the screen coordinate of the left edge of the window.
HRESULT Bottom ([out, retval] long *bottom)
 Returns the screen coordinate of the bottom edge of the window.
HRESULT Bottom ([in] long bottom)
 Set the screen coordinate of the bottom edge of the window.
HRESULT Right ([out, retval] long *right)
 Returns the screen coordinate of the right edge of the window.
HRESULT Right ([in] long right)
 Set the screen coordinate of the right edge of the window.
HRESULT Width ([out, retval] long *width)
 Returns the width of the window.
HRESULT Width ([in] long width)
 Set the width of the window.
HRESULT Height ([out, retval] long *height)
 Returns the height of the window.
HRESULT Height ([in] long height)
 Set the height of the window.

Member Function Documentation

HRESULT IITWindow::Bottom (  [in] long  bottom  ) 
 

Set the screen coordinate of the bottom edge of the window.

This will resize, not move, the window. Currently, only the main browser and playlist windows can be resized.

Parameters:
bottom The new screen coordinate of the bottom edge of the window.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is maximized, or is not a browser or playlist window.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Bottom (  [out, retval] long *  bottom  ) 
 

Returns the screen coordinate of the bottom edge of the window.

Parameters:
bottom Returns the screen coordinate of the bottom edge of the window.
Return values:
S_OK The operation was successful.
E_POINTER bottom is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Height (  [in] long  height  ) 
 

Set the height of the window.

This will resize, not move, the window. It is the equivalent of setting the IITWindow::Bottom property to IITWindow::Top plus height. Currently, only the main browser and playlist windows can be resized.

Parameters:
height The height of the window.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is maximized, or is not a browser or playlist window.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Height (  [out, retval] long *  height  ) 
 

Returns the height of the window.

Parameters:
height Returns the height of the window.
Return values:
S_OK The operation was successful.
E_POINTER height is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Kind (  [out, retval] ITWindowKind *  kind  ) 
 

Returns the kind of the window.

Parameters:
kind Returns the kind of the window.
Return values:
S_OK The operation was successful.
E_POINTER kind is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Left (  [in] long  left  ) 
 

Set the screen coordinate of the left edge of the window.

This will move, not resize, the window.

Parameters:
left The new screen coordinate of the left edge of the window.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is maximized.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Left (  [out, retval] long *  left  ) 
 

Returns the screen coordinate of the left edge of the window.

Parameters:
left Returns the screen coordinate of the left edge of the window.
Return values:
S_OK The operation was successful.
E_POINTER left is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Maximizable (  [out, retval] VARIANT_BOOL *  isMaximizable  ) 
 

Returns true if the window is maximizable.

Parameters:
isMaximizable Returns true if the window is maximizable.
Return values:
S_OK The operation was successful.
E_POINTER isMaximizable is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Maximized (  [in] VARIANT_BOOL  shouldBeMaximized  ) 
 

Maximize or restore the window.

Parameters:
shouldBeMaximized True if window should be maximized.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is not maximizable.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Maximized (  [out, retval] VARIANT_BOOL *  isMaximized  ) 
 

Returns true if the window is maximized.

Parameters:
isMaximized Returns true if the window is maximized.
Return values:
S_OK The operation was successful.
E_POINTER isMaximized is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Minimized (  [in] VARIANT_BOOL  shouldBeMinimized  ) 
 

Minimize or restore the window.

Parameters:
shouldBeMinimized True if window should be minimized.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Minimized (  [out, retval] VARIANT_BOOL *  isMinimized  ) 
 

Returns true if the window is minimized.

Parameters:
isMinimized Returns true if the window is minimized.
Return values:
S_OK The operation was successful.
E_POINTER isMinimized is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Name (  [out, retval] BSTR *  name  ) 
 

Returns the name (title) of the window.

Parameters:
name Returns the name (title) of the window.
Return values:
S_OK The operation was successful.
E_POINTER name is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Resizable (  [out, retval] VARIANT_BOOL *  isResizable  ) 
 

Returns true if the window is resizable.

Parameters:
isResizable Returns true if the window is resizable.
Return values:
S_OK The operation was successful.
E_POINTER isResizable is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Right (  [in] long  right  ) 
 

Set the screen coordinate of the right edge of the window.

This will resize, not move, the window. Currently, only the main browser and playlist windows can be resized.

Parameters:
right The new screen coordinate of the right edge of the window.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is maximized, or is not a browser or playlist window.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Right (  [out, retval] long *  right  ) 
 

Returns the screen coordinate of the right edge of the window.

Parameters:
right Returns the screen coordinate of the right edge of the window.
Return values:
S_OK The operation was successful.
E_POINTER right is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Top (  [in] long  top  ) 
 

Set the screen coordinate of the top edge of the window.

This will move, not resize, the window.

Parameters:
top The new screen coordinate of the top edge of the window.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is maximized.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Top (  [out, retval] long *  top  ) 
 

Returns the screen coordinate of the top edge of the window.

Parameters:
top Returns the screen coordinate of the top edge of the window.
Return values:
S_OK The operation was successful.
E_POINTER top is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Visible (  [in] VARIANT_BOOL  shouldBeVisible  ) 
 

Hide or show the window.

Note that the main browser window cannot be hidden using COM. However, if the user has minimized the main browser window to the system tray, it will appear to be hidden (as well as minimized). In this case, the main browser window can be restored by setting either the IITWindow::Visible property to true or the IITWindow::Minimized property to false.

Parameters:
shouldBeVisible True if the window should be shown.
Return values:
S_OK The operation was successful.
E_NOINTERFACE This is the main browser window.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Visible (  [out, retval] VARIANT_BOOL *  isVisible  ) 
 

Returns true if the window is visible.

Parameters:
isVisible Returns true if the window is visible.
Return values:
S_OK The operation was successful.
E_POINTER isVisible is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Width (  [in] long  width  ) 
 

Set the width of the window.

This will resize, not move, the window. It is the equivalent of setting the IITWindow::Right property to IITWindow::Left plus width. Currently, only the main browser and playlist windows can be resized.

Parameters:
width The width of the window.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is maximized, or is not a browser or playlist window.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Width (  [out, retval] long *  width  ) 
 

Returns the width of the window.

Parameters:
width Returns the width of the window.
Return values:
S_OK The operation was successful.
E_POINTER width is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Zoomable (  [out, retval] VARIANT_BOOL *  isZoomable  ) 
 

Returns true if the window is zoomable.

Parameters:
isZoomable Returns true if the window is zoomable.
Return values:
S_OK The operation was successful.
E_POINTER isZoomable is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Zoomed (  [in] VARIANT_BOOL  shouldBeZoomed  ) 
 

Zoom or unzoom the window.

Parameters:
shouldBeZoomed True if window should be zoomed.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTLOCKED Window is not zoomable.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITWindow::Zoomed (  [out, retval] VARIANT_BOOL *  isZoomed  ) 
 

Returns true if the window is zoomed.

Parameters:
isZoomed Returns true if the window is zoomed.
Return values:
S_OK The operation was successful.
E_POINTER isZoomed is NULL.
ITUNES_E_OBJECTDELETED This window has been deleted.
E_FAIL An unexpected error occurred.

Generated on Fri Mar 13 12:50:54 2009 for iTunes 8.1.0.52
©2004-2007 Apple Computer, Inc.

previous page start next page