Plugin Icons - How to Toggle/Rollover?

[Skipper Web]

Hello,

I'm new to OpenCPN plugins world. Trying to figure out how to toggle a toolbar's icon when it's pressed, as well as switch the image on mouse-over event. Am I on the right track with using these two functions?

SetToolbarItemState()
SetToolbarToolBitmaps()

Tried calling them but there don't seem to be any changes.

Thank you.

[nohal]

Skipper Web...
SetToolbarItemState() sets the pressed/depressed state of your toolbar icon. That is the only thing you can control in regards of mouse events on the toolbar and typically is called from

void myplugin_pi::OnToolbarToolCallback ( int id )
{
    m_iconpressed = !m_iconpressed;
    SetToolbarItemState( id, m_iconpressed );
}

To receive this callback, you must return WANTS_TOOLBAR_CALLBACK from myplugin_pi::Init()

The ability to define the hover state icon was disabled in the core when the UI styles were introduced and currently the toolbar generates the icon representaion from the first bitmap parameter of InsertPlugInTool() - the API is unchanged for backward compatibility.

You don't need SetToolbarToolBitmaps at all unless you want to change your icons based on the state of the plugin at runtime.

If you need more help, push your code to github or similar place.

Pavel

[Skipper Web]

Thank you! That worked. Well, almost. In the clicked state the icon shifts to the left upper corner. Is it correct to assume that the icon is supposed to be 32x32 pixels, with alpha background?

[nohal]

Yes, 32x32 with alpha. The "shift" is a result of the toggled icon creation in the core code. If it annoys you enough (it so far does not to me), you may send a patch for the process starting at https://github.com/OpenCPN/OpenCPN/b...tyles.cpp#L352

Pavel

[Skipper Web]

Thank you. That code is above my level for now. I'll settle on a non-alpha version to avoid shifts.

Since I have your attention, a somewhat unrelated question. Is it possible to change cursor from within plugin? Love what Create Route tool does with a pencil. Tried calling and got nowhere with this as a test:

::wxSetCursor(*wxCROSS_CURSOR)

[nohal]

I don't see your code, but suppose you should change the cursor on the canvas window.
Something like

int myplugin_pi::Init()
{
...
m_parent_window = GetOCPNCanvasWindow();
...
}

void myplugin_pi::Whatever()
{
...
m_parent_window->SetCursor(wxCURSOR_CROSS);
...
m_parent_window->SetCursor(wxCURSOR_DEFAULT);
...
}

[Skipper Web]

Makes sense. I didn't realize the need to use canvas. Thank you!

I will share the code as soon as it's presentable. Not much to look at just yet.