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
24
class
IMenuEventSink
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
157
virtual
adtf::disptb::mixinlib::chewbacca::IMenuEventSink
*
GetEventHandler
() = 0;
158
159
};
160
164
class
IMenu
:
virtual
public
adtf::disptb::mixinlib::chewbacca::IMenuItem
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
188
virtual
adtf::disptb::mixinlib::chewbacca::IMenuItem
*
AddSeparator
() = 0;
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
215
using
chewbacca::IMenuItem
;
216
218
using
chewbacca::IMenuEventSink
;
219
221
using
chewbacca::IMenu
;
222
223
}
// mixinlib
224
225
}
// disptb
226
227
}
// adtf
adtf::disptb::mixinlib::chewbacca::IMenuEventSink
Interface for handling context menu events.
Definition:
menu_intf.h:25
adtf::disptb::mixinlib::chewbacca::IMenuEventSink::ADTF_IID
ADTF_IID(IMenuEventSink, "menueventsink.chewbacca.mixinlib.disptb.adtf.iid")
Define an interface id for this class.
adtf::disptb::mixinlib::chewbacca::IMenuEventSink::HandleMenuEvent
virtual tResult HandleMenuEvent(const tChar *strMenuText, tVoid *pvEventData)=0
Handle an event related to menu.
adtf::disptb::mixinlib::chewbacca::IMenu
Interface for managing a (context) menu.
Definition:
menu_intf.h:165
adtf::disptb::mixinlib::chewbacca::IMenu::GetMenuItemCount
virtual tInt GetMenuItemCount() const =0
Get number of menu items.
adtf::disptb::mixinlib::chewbacca::IMenu::GetMenuItem
virtual IMenuItem * GetMenuItem(tInt nIndex)=0
Get an item.
adtf::disptb::mixinlib::chewbacca::IMenu::AddMenu
virtual IMenu * AddMenu(const tChar *strText)=0
Creates a new sub-menu for this menu.
adtf::disptb::mixinlib::chewbacca::IMenu::AddMenuItem
virtual adtf::disptb::mixinlib::chewbacca::IMenuItem * AddMenuItem(const tChar *strText)=0
Creates a new menu item.
adtf::disptb::mixinlib::chewbacca::IMenu::DeleteItems
virtual tVoid DeleteItems()=0
Removes all items from the menu.
adtf::disptb::mixinlib::chewbacca::IMenu::ADTF_IID
ADTF_IID(IMenu, "menu.chewbacca.mixinlib.disptb.adtf.iid")
Define an interface id for this class.
adtf::disptb::mixinlib::chewbacca::IMenu::AddSeparator
virtual adtf::disptb::mixinlib::chewbacca::IMenuItem * AddSeparator()=0
Creates a seperator for this menu.
adtf::disptb::mixinlib::chewbacca::IMenuItem
Interface for creating context menu entries.
Definition:
menu_intf.h:45
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetSeparator
virtual tVoid SetSeparator(tBool bSeparator)=0
Mark this item as a separator.
adtf::disptb::mixinlib::chewbacca::IMenuItem::ADTF_IID
ADTF_IID(IMenuItem, "menuitem.chewbacca.mixinlib.disptb.adtf.iid")
Define an interface id for this class.
adtf::disptb::mixinlib::chewbacca::IMenuItem::IsCheckable
virtual tBool IsCheckable() const =0
Query whether the item is checkable.
adtf::disptb::mixinlib::chewbacca::IMenuItem::IsSeparator
virtual tBool IsSeparator() const =0
Query whether the item is a separator.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetToolTip
virtual tVoid SetToolTip(const tChar *strToolTip)=0
Set the tool tip of this menu item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::GetEventHandler
virtual adtf::disptb::mixinlib::chewbacca::IMenuEventSink * GetEventHandler()=0
Get the current event handler.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetCheckable
virtual tVoid SetCheckable(tBool bCheckable)=0
Mark this item as checkable.
adtf::disptb::mixinlib::chewbacca::IMenuItem::GetStatusTip
virtual const tChar * GetStatusTip() const =0
Get the status bar tip of this menu item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetStatusTip
virtual tVoid SetStatusTip(const tChar *strStatusTip)=0
Set the status bar tip of this menu item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetVisible
virtual tVoid SetVisible(tBool bVisible)=0
Set visibility of this item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetEnabled
virtual tVoid SetEnabled(tBool bEnabled)=0
Set enabled state of this item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::GetToolTip
virtual const tChar * GetToolTip() const =0
Get the tool tip of this menu item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::IsChecked
virtual tBool IsChecked() const =0
Query whether the item is checked.
adtf::disptb::mixinlib::chewbacca::IMenuItem::IsEnabled
virtual tBool IsEnabled() const =0
Query whether the item is enabled.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetText
virtual tVoid SetText(const tChar *strText)=0
Set the text of this menu item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetChecked
virtual tVoid SetChecked(tBool bChecked)=0
Set chack state of this item.
adtf::disptb::mixinlib::chewbacca::IMenuItem::SetEventHandler
virtual tVoid SetEventHandler(IMenuEventSink *pEvent)=0
Set an event handler.
adtf::disptb::mixinlib::chewbacca::IMenuItem::IsVisible
virtual tBool IsVisible() const =0
Query whether the item is visible.
adtf::disptb::mixinlib::chewbacca::IMenuItem::GetText
virtual const tChar * GetText() const =0
Get the text of this menu item.
adtf
Main namespace.
Definition:
adtf_display_toolbox_base.h:15
Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Aug 4 2022 by doxygen 1.9.1)