ADTF_DISPLAY_TOOLBOX  3.8.0 (ADTF 3.14.3)
menu_intf.h
Go to the documentation of this file.
1 
7 #pragma once
8 #include <adtfucom3/adtf_ucom3.h>
9 
10 namespace adtf
11 {
12 namespace disptb
13 {
14 
15 namespace mixinlib
16 {
17 
18 namespace chewbacca
19 {
20 
25 {
26 
27 public:
29  ADTF_IID(IMenuEventSink, "menueventsink.chewbacca.mixinlib.disptb.adtf.iid");
30 
37  virtual tResult HandleMenuEvent(const tChar* strMenuText, tVoid* pvEventData) = 0;
38 
39 };
40 
44 class IMenuItem
45 {
46 
47 public:
49  ADTF_IID(IMenuItem, "menuitem.chewbacca.mixinlib.disptb.adtf.iid");
50 
55  virtual tVoid SetText(const tChar* strText) = 0;
56 
61  virtual tVoid SetToolTip(const tChar* strToolTip) = 0;
62 
67  virtual tVoid SetStatusTip(const tChar* strStatusTip) = 0;
68 
73  virtual const tChar* GetText() const = 0;
74 
79  virtual const tChar* GetToolTip() const = 0;
80 
85  virtual const tChar* GetStatusTip() const = 0;
86 
91  virtual tVoid SetSeparator(tBool bSeparator) = 0;
92 
97  virtual tVoid SetCheckable(tBool bCheckable) = 0;
98 
103  virtual tVoid SetChecked(tBool bChecked) = 0;
104 
109  virtual tVoid SetEnabled(tBool bEnabled) = 0;
110 
115  virtual tVoid SetVisible(tBool bVisible) = 0;
116 
121  virtual tBool IsCheckable() const = 0;
122 
127  virtual tBool IsChecked() const = 0;
128 
133  virtual tBool IsEnabled() const = 0;
134 
139  virtual tBool IsVisible() const = 0;
140 
145  virtual tBool IsSeparator() const = 0;
146 
151  virtual tVoid SetEventHandler(IMenuEventSink* pEvent) = 0;
152 
158 
159 };
160 
165 {
166 public:
168  ADTF_IID(IMenu, "menu.chewbacca.mixinlib.disptb.adtf.iid");
169 
175  virtual IMenu* AddMenu(const tChar* strText) = 0;
176 
182  virtual adtf::disptb::mixinlib::chewbacca::IMenuItem* AddMenuItem(const tChar* strText) = 0;
183 
189 
194  virtual tInt GetMenuItemCount() const = 0;
195 
201  virtual IMenuItem* GetMenuItem(tInt nIndex) = 0;
202 
206  virtual tVoid DeleteItems() = 0;
207 
208  virtual ~IMenu() = default;
209 
210 };
211 
212 } // chewbacca
213 
216 
219 
221 using chewbacca::IMenu;
222 
223 } // mixinlib
224 
225 } // disptb
226 
227 } // adtf
Interface for handling context menu events.
Definition: menu_intf.h:25
ADTF_IID(IMenuEventSink, "menueventsink.chewbacca.mixinlib.disptb.adtf.iid")
Define an interface id for this class.
virtual tResult HandleMenuEvent(const tChar *strMenuText, tVoid *pvEventData)=0
Handle an event related to menu.
Interface for managing a (context) menu.
Definition: menu_intf.h:165
virtual tInt GetMenuItemCount() const =0
Get number of menu items.
virtual IMenuItem * GetMenuItem(tInt nIndex)=0
Get an item.
virtual IMenu * AddMenu(const tChar *strText)=0
Creates a new sub-menu for this menu.
virtual adtf::disptb::mixinlib::chewbacca::IMenuItem * AddMenuItem(const tChar *strText)=0
Creates a new menu item.
virtual tVoid DeleteItems()=0
Removes all items from the menu.
ADTF_IID(IMenu, "menu.chewbacca.mixinlib.disptb.adtf.iid")
Define an interface id for this class.
virtual adtf::disptb::mixinlib::chewbacca::IMenuItem * AddSeparator()=0
Creates a seperator for this menu.
Interface for creating context menu entries.
Definition: menu_intf.h:45
virtual tVoid SetSeparator(tBool bSeparator)=0
Mark this item as a separator.
ADTF_IID(IMenuItem, "menuitem.chewbacca.mixinlib.disptb.adtf.iid")
Define an interface id for this class.
virtual tBool IsCheckable() const =0
Query whether the item is checkable.
virtual tBool IsSeparator() const =0
Query whether the item is a separator.
virtual tVoid SetToolTip(const tChar *strToolTip)=0
Set the tool tip of this menu item.
virtual adtf::disptb::mixinlib::chewbacca::IMenuEventSink * GetEventHandler()=0
Get the current event handler.
virtual tVoid SetCheckable(tBool bCheckable)=0
Mark this item as checkable.
virtual const tChar * GetStatusTip() const =0
Get the status bar tip of this menu item.
virtual tVoid SetStatusTip(const tChar *strStatusTip)=0
Set the status bar tip of this menu item.
virtual tVoid SetVisible(tBool bVisible)=0
Set visibility of this item.
virtual tVoid SetEnabled(tBool bEnabled)=0
Set enabled state of this item.
virtual const tChar * GetToolTip() const =0
Get the tool tip of this menu item.
virtual tBool IsChecked() const =0
Query whether the item is checked.
virtual tBool IsEnabled() const =0
Query whether the item is enabled.
virtual tVoid SetText(const tChar *strText)=0
Set the text of this menu item.
virtual tVoid SetChecked(tBool bChecked)=0
Set chack state of this item.
virtual tVoid SetEventHandler(IMenuEventSink *pEvent)=0
Set an event handler.
virtual tBool IsVisible() const =0
Query whether the item is visible.
virtual const tChar * GetText() const =0
Get the text of this menu item.
Main namespace.