OEAPI::IOEToolbar Interface Reference

List of all members.

Public Member Functions

HRESULT Create ([in] LONG oeapiId)
HRESULT CreateButton ([in] BSTR name,[in] BSTR bmpNormal,[in] BSTR bmpMouseOver,[out, retval] IOEButton **)
HRESULT CreateInMsgWnd ([in] WNDSTYLE wndStyle,[in] LONG oeapiId)
HRESULT CreateSeparator ([out, retval] IOEButton **)
HRESULT Destroy ()
HRESULT EnableTooltips ([in] BOOL bEnable)
HRESULT GetButton ([in] LONG buttonId,[out, retval] IOEButton **newButton)
HRESULT GetButtonByIndex ([in] LONG index,[out, retval] IOEButton **button)
HRESULT GetFirstButtonID ([out, retval] LONG *buttonId)
HRESULT GetHandle ([out, retval] LONG *tbHandle)
HRESULT GetID ([out, retval] LONG *)
HRESULT GetMaskColor ([out, retval] LONG *color)
HRESULT GetNextButtonID ([out, retval] LONG *buttonId)
HRESULT GetPictureSize ([out] LONG *cx,[out] LONG *cy,[out, retval] BOOL *res)
HRESULT SetLargeButtons ([in] BOOL largeBtns)
HRESULT SetMaskColor ([in] LONG color)
HRESULT SetMaxTextRows ([in] LONG rows)
HRESULT SetPictureSize ([in] LONG cx,[in] LONG cy,[out, retval] BOOL *res)
HRESULT SetShown ([in] BOOL show)

Member Function Documentation

HRESULT OEAPI::IOEToolbar::Create ( [in] LONG  oeapiId  ) 

Create toolbar.

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

Create a button in the toolbar. The bmpNormal is the image displayed in the button and the bmpMouseOver is optional to display a different image when the mouse is over.
NOTE: 24 bit BMPs are recommended.

HRESULT OEAPI::IOEToolbar::CreateInMsgWnd ( [in] WNDSTYLE  wndStyle,
[in] LONG  oeapiId 
)

Only in Enterprise Edition.
Create a toolbar in the send message window.
It will appear when the user creates / replies / forwards an email.

HRESULT OEAPI::IOEToolbar::CreateSeparator ( [out, retval] IOEButton **   ) 

Create a toolbar separator.

HRESULT OEAPI::IOEToolbar::Destroy (  ) 

Destroy the toolbar.

HRESULT OEAPI::IOEToolbar::EnableTooltips ( [in] BOOL  bEnable  ) 

Enable tooltips. For tooltips to be displayed, this option must be set right after toolbar creation, before creating the toolbar's buttons.

HRESULT OEAPI::IOEToolbar::GetButton ( [in] LONG  buttonId,
[out, retval] IOEButton **  newButton 
)

Get the button object by id.

HRESULT OEAPI::IOEToolbar::GetButtonByIndex ( [in] LONG  index,
[out, retval] IOEButton **  button 
)

Get button using the order in which buttons were created.

HRESULT OEAPI::IOEToolbar::GetFirstButtonID ( [out, retval] LONG *  buttonId  ) 

Get the toolbar's first button's id.

HRESULT OEAPI::IOEToolbar::GetHandle ( [out, retval] LONG *  tbHandle  ) 

Get toolbar handle.

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

Get the toolbar's id.

HRESULT OEAPI::IOEToolbar::GetMaskColor ( [out, retval] LONG *  color  ) 

Get toolbar buttons images' transparent color.
NOTE: The format of the color returned is h00BBGGRR, where BB = blue, GG = green and RR = red.

HRESULT OEAPI::IOEToolbar::GetNextButtonID ( [out, retval] LONG *  buttonId  ) 

Get the toolbar's next button's id.

HRESULT OEAPI::IOEToolbar::GetPictureSize ( [out] LONG *  cx,
[out] LONG *  cy,
[out, retval] BOOL *  res 
)

Get the toolbar pictures' size in pixels.

HRESULT OEAPI::IOEToolbar::SetLargeButtons ( [in] BOOL  largeBtns  ) 

If TRUE the toolbar displays large buttons.
NOTE: This property must be set before toolbar creation. If you call it after you've created the toolbar, it loses its transparency.
If you want to set small buttons create the toolbar object, call this function and then call IOEToolbar.Create.

HRESULT OEAPI::IOEToolbar::SetMaskColor ( [in] LONG  color  ) 

Set the toolbar buttons images' transparent color.
NOTES: The color's format is h00BBGGRR, where BB = blue, GG = green and RR = red.
OEAPI's default transparent color is h000000FF (red).
The special value hFF000000 tells OEAPI to use the image's top-left pixel color as transparent.

HRESULT OEAPI::IOEToolbar::SetMaxTextRows ( [in] LONG  rows  ) 

Set the toolbar buttons' maximum text rows. Setting it to 0 shows no text.

HRESULT OEAPI::IOEToolbar::SetPictureSize ( [in] LONG  cx,
[in] LONG  cy,
[out, retval] BOOL *  res 
)

Set the toolbar pictures' size in pixels.
NOTE: This only works for custom toolbars, and must be setted before adding a button.

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

Show or hide toolbar.
Used in OE toolbar works but if the user changes the state using OE, it doesn't work the first time.



Developed by Nektra