ui_extension::menu_window Class Reference

Subclass of ui_extension::window, specifically for menubars. More...

#include <window.h>

Inheritance diagram for ui_extension::menu_window:

ui_extension::window ui_extension::extension_base service_base List of all members.

Public Member Functions

virtual void hide_accelerators ()=0
 Indicates that you should stop underlining menu access keys in your menu.
virtual bool is_menu_focused () const =0
 Retrieve whether the menu has the keyboard focus..
virtual bool on_menuchar (unsigned short chr)=0
 Called by host when a menu accelerator is pressed.
virtual void set_focus ()=0
 Called by host to indicate you should focus your menu.
virtual void show_accelerators ()=0
 Indicates that you should underline menu access keys in your menu.

Public Attributes

 menu_window
 window

Detailed Description

Subclass of ui_extension::window, specifically for menubars.


Member Function Documentation

virtual void ui_extension::menu_window::hide_accelerators  )  [pure virtual]
 

Indicates that you should stop underlining menu access keys in your menu.

Remarks:
Applicable only if your menu underlines menu access keys only when activated by the keyboard. This is typically determined by the SPI_GETKEYBOARDCUES system parameter.

Do not change the state within this function call. Use PostMessage.

Implementation example
 BOOL b_showkeyboardcues = TRUE; 
 SystemParametersInfo(SPI_GETKEYBOARDCUES, 0, &b_showkeyboardcues, 0);
 PostMessage(wnd_menu, WM_UPDATEUISTATE, MAKEWPARAM(b_showkeyboardcues ? UIS_CLEAR : UIS_SET , UISF_HIDEACCEL), 0);

virtual bool ui_extension::menu_window::is_menu_focused  )  const [pure virtual]
 

Retrieve whether the menu has the keyboard focus..

Precondition:
May only be called on hosted extensions.
Returns:
whether your menu has keyboard focus

virtual bool ui_extension::menu_window::on_menuchar unsigned short  chr  )  [pure virtual]
 

Called by host when a menu accelerator is pressed.

Called by host in its WM_MENUCHAR handler to notify extension that a menu was requested to be opened. You should check whether the accelerator key pressed is one of yours.

Precondition:
May only be called on hosted extensions.
Parameters:
[in] chr character that was pressed
Returns:
whether you claimed the accelerator key, and showed/will show your menu

virtual void ui_extension::menu_window::set_focus  )  [pure virtual]
 

Called by host to indicate you should focus your menu.

Precondition:
May only be called on hosted extensions.

virtual void ui_extension::menu_window::show_accelerators  )  [pure virtual]
 

Indicates that you should underline menu access keys in your menu.

Remarks:
Applicable only if your menu underlines menu access keys only when activated by the keyboard. This is typically determined by the SPI_GETKEYBOARDCUES system parameter.

Do not change the state within this function call. Use PostMessage.

Implementation example
 PostMessage(wnd_menu, WM_UPDATEUISTATE, MAKEWPARAM(UIS_CLEAR , UISF_HIDEACCEL), 0);


The documentation for this class was generated from the following file:
Generated on Fri Apr 28 15:02:31 2006 for Columns UI SDK by  doxygen 1.4.6-NO