Cisco Systems OL-20949-01 CiscoIPPhoneGraphicMenu, CiscoIPPhoneGraphicFileMenu

3-11

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

CiscoIPPhoneGraphicMenu

Graphic menus serve the same purpose as text menus: they allow a user to select a URL from a list. Use

graphic menus in situations when the items may not be easy to display in a text list.

For example, users might prefer to have their choices presented in a non-ASCII character set such as

Kanji or Arabic. When using non-ASCII character sets, the system pr es e nt s the in f or m ation as a b itm ap

graphic. To select a menu, the user enters a number from 1 to 12 using the num er ic keypad (* and # are

not active).

Definition

<Title>Menu title goes here</Title>

<Prompt>Prompt text goes here</Prompt>

<LocationX>Position information of graphic</LocationX>

<LocationY>Position information of graphic</LocationY>

<Width>Size information for the graphic</Width>

<Height>Size information for the graphic</Height>

<Depth>Number of bits per pixel</Depth>

<Data>Packed Pixel Data</Data>

<URL>The URL associated with the menu item</URL>

</MenuItem>

</CiscoIPPhoneGraphicMenu>

Note The 6900 series IP phones does not display the Title and Prompt menu fields at the same time.

If both Title and Prompt fields are defined at the same time, then these phones display only the

Prompt field.

Menu items in the graphic menu have a name, like the text menu counterparts. Although the name does

not display to the user, it still performs a function. The name of the menu item provides the default title

that is used when the URL for the chosen item is loaded. If the loaded page has a title of its own, the

phone uses that title instead.

The XML tags in GraphicMenu use the tag definitions for CiscoIPPhoneImage and CiscoIPPhoneMenu.

Although the semantics of the tags are identical, you can have only 12 MenuItem objects in a

CiscoIPPhoneGraphicMenu object. See “CiscoIPPhoneMenu” and “CiscoIPPhoneImage” for detailed

descriptions.

CiscoIPPhoneGraphicFileMenu

Some of the Cisco Unified IP Phone models, such as the Cisco Unified IP Phone 7970G and

Cisco IP Communicator, have pointer devices. The Cisco Unified IP Phone 7970G uses a touchscreen

overlay on the display, and the PC-based Cisco IP Communicator uses the standard Windows mouse

pointer.

Because these devices can receive and process “pointer” events, a CiscoIPPhoneGraphicFileMenu

object exposes the capability to application developers. The CiscoIPPhoneGraphicFileMenu behaves

similar to the CiscoIPPhoneGraphicMenu, in that a group of options are presented by an image. When

one of those objects is selected, a URL action initiates. However, the new FileMenu does not use the

keypad, but uses rectangular touch areas. This rectangular touch area, <TouchArea>, is defined by

coordinates relative to the upper-left corner of the Services display. The (X1,Y1) points specify the

upper-left corner of the <TouchArea>, and (X2,Y2) specify the lower-right corner of the <TouchArea>.