4midl_pragma warning(disable:2111)
9import "EnumDefinition.idl";
18 uuid(FEF554E8-F0B8-4397-850B-A6F63A921B0A),
21 pointer_default(unique)
212 uuid(30E4BDC2-FF3F-490A-BF15-52332FA7CFEF),
215 pointer_default(unique)
594 uuid(779E10A8-9370-4F87-9EE7-FD051EF33DA7),
597 pointer_default(unique)
852 uuid(16767327-DD46-4EA7-AD9A-0844E008A4B2),
855 pointer_default(unique)
1042 uuid(da667cd1-2b49-4144-84b4-99c27502ee1a),
1045 pointer_default(unique)
1239 uuid(424CCD51-1FDC-4CC5-83C3-D9D42A8376D4),
1242 pointer_default(unique)
EwRibbonButtonSize
Ribbon bar button's styles.
Definition: EnumDefinition.idl:265
EwRibbonButtonStyle
Ribbon bar button's styles.
Definition: EnumDefinition.idl:249
EwRibbonControlType
Type of the control that can be used in a ribbon.
Definition: EnumDefinition.idl:228
EwRibbonMainTabType
Enum used to get main tabs of ribbon of the Application.
Definition: EnumDefinition.idl:361
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
Use this interface to manage the ComboBox control on Ribbon.
Definition: EwApplicationRibbon.idl:24
EwErrorCode setSelectedIndex(int iIndex)
Set the index of the item to be selected in the ComboBox.
int findText(int iIndexStart, BSTR strFindItemText, EwErrorCode *errorCode)
Find a text item in the ComboBox.
EwErrorCode setItemData(int iIndex, ULONGLONG pItemData)
Set the item data value associated with the specified combo box item.
BSTR getSelectedText(EwErrorCode *errorCode)
Return the selected item text from the ComboBox.
EwErrorCode addItemText(BSTR strItemText)
Add text item to the ComboBox.
EwErrorCode setEditText(BSTR strEditText)
Set the edit text.
EwErrorCode addItemTextAt(int iIndex, BSTR strItemText)
Add text item to the ComboBox at a specific position or index.
BSTR getEditText(EwErrorCode *errorCode)
Get the edit text.
int getItemCount(EwErrorCode *errorCode)
Return the number of items in this ComboBox.
EwErrorCode removeContent()
Removes all items from the ComboBox.
int getSelectedIndex(EwErrorCode *errorCode)
Get the index of the current selected item in the ComboBox.
EwErrorCode enableAutoComplete(VARIANT_BOOL bAutoComplete)
Enables or disables auto completion.
EwErrorCode setEditHintText(BSTR strHintText)
Set grayed-out text displayed in the edit control that displayed a helpful description of what the co...
BSTR getEditHintText(EwErrorCode *errorCode)
Get grayed-out text displayed in the edit control that displayed a helpful description of what the co...
ULONGLONG getItemData(int iIndex, EwErrorCode *errorCode)
Get the item data value associated with the specified combo box item.
EwErrorCode deleteItemAt(int iIndex)
Delete a text item from the ComboBox.
Use this interface to manage the control on Ribbon tab.
Definition: EwApplicationRibbon.idl:218
EwErrorCode setCheck(VARIANT_BOOL bCheck)
Check or uncheck the control.
long getID(EwErrorCode *errorCode)
Get the Id's of control.
EwErrorCode setStyle(EwRibbonButtonStyle eRibbonButtonStyle)
Set the style of the control.
EwRibbonButtonStyle getStyle(EwErrorCode *errorCode)
Get the control's style.
EwErrorCode setIconFromImage(BSTR strImageFilePath, EwRibbonButtonSize eRibbonButtonSize, COLORREF crMask)
Add an icon from file.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this control.
VARIANT_BOOL isOnQuickAccess(EwErrorCode *errorCode)
Get whether the control is a part of Quick access panel.
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the control.
BSTR getCategory(EwErrorCode *errorCode)
Return the category of the control.
EwErrorCode setDescription(BSTR strDescription)
Set a description for this control.
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the control is enabled.
int getIndex(EwErrorCode *errorCode)
Return the index of the control.
EwErrorCode setCommand(BSTR strCommand)
Set the name of the command associated with this ribbon control.
EwErrorCode setOnQuickAccess(VARIANT_BOOL bOnQuickAccess)
Set whether the control is a part of Quick access panel.
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the control is enabled.
EwRibbonControlType getControlType(EwErrorCode *errorCode)
Get the control's Type.
BSTR getDescription(EwErrorCode *errorCode)
Return the description of this control.
BSTR getShortcutText(EwErrorCode *errorCode)
Get the control's shortcut.
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the control is visible.
VARIANT_BOOL isBeginGroup(EwErrorCode *errorCode)
Determine if the control is a separator.
BSTR getToolTip(EwErrorCode *errorCode)
Return the ToolTip of this control.
VARIANT_BOOL getCheck(EwErrorCode *errorCode)
Determine if the control is checked.
EwErrorCode setCategory(BSTR strCategory)
Set a category for the control.
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control to a pop-up button.
EwErrorCode setShortcutText(BSTR strShortcutText)
Set the shortcut string of the control.
BSTR getCommand(EwErrorCode *errorCode)
Return the text of parameter strCommand used when calling EwRibbonGroupX::addControl.
IEwRibbonComboBoxControlX addComboBoxControl(EwErrorCode *errorCode)
Add the ComboBox Control in the pop-up button ribbon control.
EwErrorCode setBeginGroup(VARIANT_BOOL bBeginGroup)
Begin a new group using a separator.
EwErrorCode setToolTip(BSTR strToolTip)
Set a new ToolTip for this control.
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this control.
Use this interface to manage the Ribbon group.
Definition: EwApplicationRibbon.idl:600
EwRibbonGroupReductionLevels getAllowReduce(EwErrorCode *errorCode)
Get the current reduce level for the ribbon group.
EwErrorCode setControlsGrouping(VARIANT_BOOL bControlsGrouping)
Group buttons in the group, false by default.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this ribbon group.
EwErrorCode removeControl(int iIndex)
Remove a control specified by the index.
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this ribbon group.
IEwRibbonControlX getControlAt(int iIndex, EwErrorCode *errorCode)
Return the specified control of the current group.
EwErrorCode removeAll()
Remove all controls.
IEwRibbonComboBoxControlX insertComboBoxControl(int nPosition, EwErrorCode *errorCode)
Insert the ComboBox Control in the Ribbon Group.
long getID(EwErrorCode *errorCode)
Get the Id's of group.
VARIANT_BOOL getControlsGrouping(EwErrorCode *errorCode)
Determines if control grouping is used.
IEwRibbonControlX insertControl(int nPosition, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Insert a new control to a pop-up button in a ribbon.
EwErrorCode setAllowReduce(EwRibbonGroupReductionLevels eRibbonGroupReductionLevels)
Set this method to prevent group to be reduced.
int getIndex(EwErrorCode *errorCode)
Return the index of the group.
VARIANT_BOOL getControlsCentering(EwErrorCode *errorCode)
Determine if controls are automatically center in group.
EwErrorCode setControlsCentering(VARIANT_BOOL bControlsCentering)
Automatically center controls in group, false by default.
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control at the end of the ribbon group.
IEwRibbonComboBoxControlX addComboBoxControl(EwErrorCode *errorCode)
Add the ComboBox Control in the Ribbon Group.
int getControlCount(EwErrorCode *errorCode)
Return the number of control in the current group.
Use this interface to manage the quick access control on Ribbon.
Definition: EwApplicationRibbon.idl:1048
EwErrorCode resetQuickAccessToolbar()
Resets default controls in Quick Access Toolbar.
EwErrorCode removeControlByID(int iControlID)
Remove a control specified by the ID in Quick Access Toolbar.
IEwRibbonComboBoxControlX insertComboBoxControl(int nPosition, EwErrorCode *errorCode)
Insert the ComboBox Control in Quick Access Toolbar.
EwErrorCode removeAll()
Remove all controls from Quick Access Toolbar.
IEwRibbonControlX insertControlAt(int iIndex, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Insert a new control in Quick Access Toolbar.
VARIANT getQuickAccessControlIDArray(EwErrorCode *errorCode)
Call this member to get array of control IDs in Quick Access Toolbar.
int getControlCount(EwErrorCode *errorCode)
Return the number of controls in Quick Access Toolbar.
IEwRibbonControlX findControlByID(int iControlId, EwErrorCode *errorCode)
Call this member to find the specified control in Quick Access Toolbar.
EwErrorCode removeControlAt(int iIndex)
Remove a control specified by the index in Quick Access Toolbar.
IEwRibbonComboBoxControlX addComboBoxControl(EwErrorCode *errorCode)
Add the ComboBox Control in Quick Access Toolbar.
IEwRibbonControlX getControlAt(int iIndex, EwErrorCode *errorCode)
Return the specified control of Quick Access Toolbar.
EwErrorCode addToDefaultControls(int iControlID)
Add control to the list of default controls in Quick Access Toolbar.
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control at the end of Quick Access Toolbar.
IEwRibbonControlX addRibbonControl(int iControlID, EwRibbonControlType eType, BSTR strCommand, EwErrorCode *errorCode)
Add an existing ribbon control at the end of Quick Access Toolbar.
Use this interface to manage the Ribbon tabs.
Definition: EwApplicationRibbon.idl:858
EwErrorCode removeGroup(int iIndex)
Remove a group specified by the index.
IEwRibbonGroupX insertGroup(BSTR strCaption, int iIndex, EwErrorCode *errorCode)
Add a new group at the specified index of the ribbon tab.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this tab.
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this tab.
int getGroupCount(EwErrorCode *errorCode)
Return the number of group in the current tab.
int getIndex(EwErrorCode *errorCode)
Return the index of the tab.
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the tab.
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the tab is enabled.
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the tab is visible.
long getID(EwErrorCode *errorCode)
Get the Id's of Tab.
IEwRibbonGroupX getGroupAt(int iIndex, EwErrorCode *errorCode)
Return the specified group of the current tab.
IEwRibbonGroupX addGroup(BSTR strCaption, EwErrorCode *errorCode)
Add a new group at the end of the ribbon tab.
EwErrorCode removeAllGroup()
Remove all groups.
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the tab is enabled.
Use this interface to manage the Ribbon Bar.
Definition: EwApplicationRibbon.idl:1245
int getTabCount(EwErrorCode *errorCode)
Return the number of tab of this ribbon bar.
IEwRibbonTabX getSelectedTab(EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the selected Ribbon Tab.
IEwRibbonTabX addTab(BSTR strCaption, EwErrorCode *errorCode)
Return an IEwRibbonTabX added to the Ribbon Tab.
IEwRibbonTabX insertTab(BSTR strCaption, int iIndex, EwErrorCode *errorCode)
Insert new tab for ribbon bar to specified position and return the IEwRibbonTabX inserted.
IEwRibbonTabX findTabByEnum(EwRibbonMainTabType eRibbonMainTabType, EwErrorCode *errorCode)
Return an IEwRibbonTabX object find by the input EwRibbonMainTabType enumeration.
EwErrorCode removeTab(int iIndex)
Remove a Ribbon Tab specified by the index.
IEwRibbonTabX findTabByID(int iID, EwErrorCode *errorCode)
Return an IEwRibbonTabX object that has the ID passed as parameter.
EwErrorCode setSelectedTab(int iIndex)
Select a Ribbon Tab.
IEwRibbonQuickAccessControlX getQuickAccessControl(EwErrorCode *errorCode)
Return an IEwRibbonQuickAccessControlX object.
IEwRibbonTabX getTabAt(int iIndex, EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the Ribbon Tab specified by index.