OEAPI::IOEButton Interface Reference

List of all members.

Public Member Functions

HRESULT Create ([in] LONG toolbarId,[in] BSTR name,[in] BSTR bmpNormal,[in] BSTR bmpMouseOver)
HRESULT CreateSeparator ([in] LONG toolbarId)
HRESULT CreateSubButton ([in] BSTR name,[in] BSTR bmpNormal,[in] BSTR bmpMouseOver,[out, retval] IOEButton **newButton)
HRESULT CreateSubSeparator ([out, retval] IOEButton **newButton)
HRESULT Destroy ()
HRESULT GetFirstSubButtonID ([out, retval] LONG *buttonId)
HRESULT GetID ([out, retval] LONG *Id)
HRESULT GetName ([out, retval] BSTR *name)
HRESULT GetNextSubButtonID ([out, retval] LONG *buttonId)
HRESULT GetSubButtonByIndex ([in] long index,[out, retval] IOEButton **button)
HRESULT IsChecked ([out, retval] BOOL *state)
HRESULT IsEnabled ([out, retval] BOOL *visible)
HRESULT IsSeparator ([out, retval] BOOL *isSep)
HRESULT IsVisible ([out, retval] BOOL *visible)
HRESULT SetChecked ([in] BOOL checked)
HRESULT SetCheckStyle ([in] BOOL check)
HRESULT SetEnabled ([in] BOOL enabled)
HRESULT SetImageMouseOver ([in] BSTR bmp)
HRESULT SetImageNormal ([in] BSTR bmpNormal)
HRESULT SetName ([in] BSTR name)
HRESULT SetPicture ([in] IPictureDisp *normal)
HRESULT SetPictureMouseOver ([in] IPictureDisp *over)
HRESULT SetPopupStyle ([in] BOOL popup)
HRESULT SetShown ([in] BOOL show)
HRESULT SetTooltip ([in] BSTR tooltip)

Member Function Documentation

HRESULT OEAPI::IOEButton::Create ( [in] LONG  toolbarId,
[in] BSTR  name,
[in] BSTR  bmpNormal,
[in] BSTR  bmpMouseOver 
)

Create a button in the specified toolbar. The bmpNormal is the path of the image displayed in the button and the bmpMouseOver is optional for the path to display a different image when the mouse is over.

HRESULT OEAPI::IOEButton::CreateSeparator ( [in] LONG  toolbarId  ) 

Create a button with separator style.

HRESULT OEAPI::IOEButton::CreateSubButton ( [in] BSTR  name,
[in] BSTR  bmpNormal,
[in] BSTR  bmpMouseOver,
[out, retval] IOEButton **  newButton 
)

Create a sub button that is displayed if the drop down arrow is clicked by the user.

HRESULT OEAPI::IOEButton::CreateSubSeparator ( [out, retval] IOEButton **  newButton  ) 

Create a sub buttons separator that is displayed if the drop down arrow is clicked by the user.

HRESULT OEAPI::IOEButton::Destroy (  ) 

Destroy the button.

HRESULT OEAPI::IOEButton::GetFirstSubButtonID ( [out, retval] LONG *  buttonId  ) 

Get first sub button's id.

HRESULT OEAPI::IOEButton::GetID ( [out, retval] LONG *  Id  ) 

Get the button's id.

HRESULT OEAPI::IOEButton::GetName ( [out, retval] BSTR *  name  ) 

Get the button's name.

HRESULT OEAPI::IOEButton::GetNextSubButtonID ( [out, retval] LONG *  buttonId  ) 

Get next sub button's id.

HRESULT OEAPI::IOEButton::GetSubButtonByIndex ( [in] long  index,
[out, retval] IOEButton **  button 
)

Get sub button using the order in which it was created.

HRESULT OEAPI::IOEButton::IsChecked ( [out, retval] BOOL *  state  ) 

Returns TRUE if the button is checked.

HRESULT OEAPI::IOEButton::IsEnabled ( [out, retval] BOOL *  visible  ) 

Returns TRUE if the button is enabled.

HRESULT OEAPI::IOEButton::IsSeparator ( [out, retval] BOOL *  isSep  ) 

Returns TRUE if it is a separator.

HRESULT OEAPI::IOEButton::IsVisible ( [out, retval] BOOL *  visible  ) 

Returns TRUE if the button is visible.

HRESULT OEAPI::IOEButton::SetChecked ( [in] BOOL  checked  ) 

For check style buttons, set button as checked.

HRESULT OEAPI::IOEButton::SetCheckStyle ( [in] BOOL  check  ) 

Set button style to check.

HRESULT OEAPI::IOEButton::SetEnabled ( [in] BOOL  enabled  ) 

Set the button as enabled or not.

HRESULT OEAPI::IOEButton::SetImageMouseOver ( [in] BSTR  bmp  ) 

Set the image displayed in the button when the mouse pointer is over the button.

HRESULT OEAPI::IOEButton::SetImageNormal ( [in] BSTR  bmpNormal  ) 

Set the image displayed in the button.

HRESULT OEAPI::IOEButton::SetName ( [in] BSTR  name  ) 

Set the button's name.

HRESULT OEAPI::IOEButton::SetPicture ( [in] IPictureDisp *  normal  ) 

Set button's picture (normal state).
A 24 bit BMP is recommended.
NOTE: This only works for dll plugins.

HRESULT OEAPI::IOEButton::SetPictureMouseOver ( [in] IPictureDisp *  over  ) 

Set button's picture to be shown when mouse is over it.
A 24 bit BMP is recommended.
NOTE: This only works for dll plugins.

HRESULT OEAPI::IOEButton::SetPopupStyle ( [in] BOOL  popup  ) 

Set the button as with popup style or not.
Only for buttons with sub buttons: If the button has popup style when it's pressed it shows the sub buttons instead of generating an OnClick event.

HRESULT OEAPI::IOEButton::SetShown ( [in] BOOL  show  ) 

Set if the button is shown or not.

HRESULT OEAPI::IOEButton::SetTooltip ( [in] BSTR  tooltip  ) 

Set button's tooltip. To be displayed, the toolbar must have EnableTooltips set to TRUE before any button is created in it.



Developed by Nektra