Specifications
3-14
Cisco Unified IP Phone Services Application Development Notes
OL-22505-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 presents the information as a bitmap
graphic. To select a menu, the user enters a number from 1 to 12 using the numeric keypad (* and # are
not active).
Definition
<CiscoIPPhoneGraphicMenu WindowMode="Width Mode of XSI window">
<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>
<MenuItem>
<Name>The name of each menu item</Name>
<URL>The URL associated with the menu item</URL>
</MenuItem>
</CiscoIPPhoneGraphicMenu>
For the description on WindowMode attribute see CiscoIPPhoneImage, page 3-7.
For examples on the use of the WindowMode attribute, see Example, page 3-14.
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.
Example
The following XML code shows the useage of WindowMode attribute in CiscoIPPhoneGraphicMenu
object.
• Without WindowMode attribute. See Figure 3-10.
<CiscoIPPhoneGraphicMenu>
<Title>Graphic menu</Title>
<Prompt>Graphic menu</Prompt>
<LocationX>10</LocationX>
<LocationY>15</LocationY>
<Width>133</Width>
<Height>45</Height>
<Depth>1</Depth>
<Data>f0f0f0f0f0f0f0f0f0f0f0f0f0</Data>
<MenuItem>
<Name>dial_1000</Name>
<URL>Dial:1000</URL>
</MenuItem>
</CiscoIPPhoneGraphicMenu>