1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/motif/toolbar.cpp
4 // Author: Julian Smart
5 // Modified by: 13.12.99 by VZ during toolbar classes reorganization
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
24 #define XtDisplay XTDISPLAY
27 #include "wx/toolbar.h"
33 #include "wx/settings.h"
37 #pragma message disable nosimpint
40 #include <Xm/PushBG.h>
43 #include <Xm/ToggleB.h>
44 #include <Xm/ToggleBG.h>
47 #pragma message enable nosimpint
50 #include "wx/motif/private.h"
51 #include "wx/motif/bmpmotif.h"
53 // ----------------------------------------------------------------------------
55 // ----------------------------------------------------------------------------
57 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
)
59 // ----------------------------------------------------------------------------
61 // ----------------------------------------------------------------------------
63 static void wxToolButtonCallback (Widget w
, XtPointer clientData
,
65 static void wxToolButtonPopupCallback (Widget w
, XtPointer client_data
,
66 XEvent
*event
, Boolean
*continue_to_dispatch
);
68 // ----------------------------------------------------------------------------
70 // ----------------------------------------------------------------------------
72 class wxToolBarTimer
: public wxTimer
75 virtual void Notify();
77 static Widget help_popup
;
78 static Widget buttonWidget
;
79 static wxString helpString
;
82 class wxToolBarTool
: public wxToolBarToolBase
85 wxToolBarTool(wxToolBar
*tbar
,
87 const wxString
& label
,
88 const wxBitmap
& bmpNormal
,
89 const wxBitmap
& bmpToggled
,
92 const wxString
& shortHelp
,
93 const wxString
& longHelp
)
94 : wxToolBarToolBase(tbar
, id
, label
, bmpNormal
, bmpToggled
, kind
,
95 clientData
, shortHelp
, longHelp
)
100 wxToolBarTool(wxToolBar
*tbar
, wxControl
*control
, const wxString
& label
)
101 : wxToolBarToolBase(tbar
, control
, label
)
106 virtual ~wxToolBarTool();
109 void SetWidget(Widget widget
) { m_widget
= widget
; }
110 Widget
GetButtonWidget() const { return m_widget
; }
112 Pixmap
GetArmPixmap()
114 m_bitmapCache
.SetBitmap( GetNormalBitmap() );
115 return (Pixmap
)m_bitmapCache
.GetArmPixmap( (WXWidget
)m_widget
);
118 Pixmap
GetInsensPixmap()
120 m_bitmapCache
.SetBitmap( GetNormalBitmap() );
121 return (Pixmap
)m_bitmapCache
.GetInsensPixmap( (WXWidget
)m_widget
);
127 wxBitmapCache m_bitmapCache
;
130 // ----------------------------------------------------------------------------
132 // ----------------------------------------------------------------------------
134 static wxToolBarTimer
* wxTheToolBarTimer
= (wxToolBarTimer
*) NULL
;
136 Widget
wxToolBarTimer::help_popup
= (Widget
) 0;
137 Widget
wxToolBarTimer::buttonWidget
= (Widget
) 0;
138 wxString
wxToolBarTimer::helpString
;
140 // ============================================================================
142 // ============================================================================
144 // ----------------------------------------------------------------------------
146 // ----------------------------------------------------------------------------
148 wxToolBarToolBase
*wxToolBar::CreateTool(int id
,
149 const wxString
& label
,
150 const wxBitmap
& bmpNormal
,
151 const wxBitmap
& bmpToggled
,
153 wxObject
*clientData
,
154 const wxString
& shortHelp
,
155 const wxString
& longHelp
)
157 return new wxToolBarTool(this, id
, label
, bmpNormal
, bmpToggled
, kind
,
158 clientData
, shortHelp
, longHelp
);
163 wxToolBar::CreateTool(wxControl
*control
, const wxString
& label
)
165 return new wxToolBarTool(this, control
, label
);
168 void wxToolBarTool::Init()
170 m_widget
= (Widget
)0;
173 wxToolBarTool::~wxToolBarTool()
176 XtDestroyWidget(m_widget
);
179 // ----------------------------------------------------------------------------
180 // wxToolBar construction
181 // ----------------------------------------------------------------------------
183 void wxToolBar::Init()
188 m_defaultHeight
= 22;
190 m_toolSeparation
= 8;
197 bool wxToolBar::Create(wxWindow
*parent
,
202 const wxString
& name
)
204 if( !wxControl::CreateControl( parent
, id
, pos
, size
, style
,
205 wxDefaultValidator
, name
) )
210 m_backgroundColour
= wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
);
212 Widget parentWidget
= (Widget
) parent
->GetClientWidget();
214 Widget toolbar
= XtVaCreateManagedWidget("toolbar",
215 xmBulletinBoardWidgetClass
, (Widget
) parentWidget
,
218 XmNresizePolicy
, XmRESIZE_NONE
,
221 Widget toolbar = XtVaCreateManagedWidget("toolbar",
222 xmFormWidgetClass, (Widget) m_clientWidget,
223 XmNtraversalOn, False,
224 XmNhorizontalSpacing, 0,
225 XmNverticalSpacing, 0,
233 m_mainWidget
= (WXWidget
) toolbar
;
240 if( rPos
.x
== -1 ) rPos
.x
= 0;
241 if( rPos
.y
== -1 ) rPos
.y
= 0;
242 if( rSize
.x
== -1 && GetParent() )
243 rSize
.x
= GetParent()->GetSize().x
;
245 AttachWidget (parent
, m_mainWidget
, (WXWidget
) NULL
,
246 rPos
.x
, rPos
.y
, rSize
.x
, rSize
.y
);
248 ChangeBackgroundColour();
253 wxToolBar::~wxToolBar()
255 delete wxTheToolBarTimer
;
256 wxTheToolBarTimer
= NULL
;
259 bool wxToolBar::Realize()
261 if ( m_tools
.GetCount() == 0 )
267 bool isVertical
= GetWindowStyle() & wxTB_VERTICAL
;
270 const int separatorSize
= GetToolSeparation(); // 8;
271 wxSize margins
= GetToolMargins();
272 int packing
= GetToolPacking();
273 int marginX
= margins
.x
;
274 int marginY
= margins
.y
;
276 int currentX
= marginX
;
277 int currentY
= marginY
;
279 int buttonHeight
= 0, buttonWidth
= 0;
282 Pixmap pixmap
, insensPixmap
;
283 wxBitmap bmp
, insensBmp
;
285 wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
288 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
290 switch ( tool
->GetStyle() )
292 case wxTOOL_STYLE_CONTROL
:
294 wxControl
* control
= tool
->GetControl();
295 wxSize sz
= control
->GetSize();
296 wxPoint pos
= control
->GetPosition();
297 // Allow a control to specify a y[x]-offset by setting
298 // its initial position, but still don't allow it to
299 // position itself above the top[left] margin.
300 int controlY
= (pos
.y
> 0) ? pos
.y
: currentY
;
301 int controlX
= (pos
.x
> 0) ? pos
.x
: currentX
;
302 control
->Move( isVertical
? controlX
: currentX
,
303 isVertical
? currentY
: controlY
);
305 currentY
+= sz
.y
+ packing
;
307 currentX
+= sz
.x
+ packing
;
311 case wxTOOL_STYLE_SEPARATOR
:
312 // skip separators for vertical toolbars
315 currentX
+= separatorSize
;
319 case wxTOOL_STYLE_BUTTON
:
322 if ( tool
->CanBeToggled() && !tool
->GetButtonWidget() )
324 button
= XtVaCreateWidget("toggleButton",
325 xmToggleButtonWidgetClass
, (Widget
) m_mainWidget
,
326 XmNx
, currentX
, XmNy
, currentY
,
327 XmNindicatorOn
, False
,
328 XmNshadowThickness
, 2,
333 XmNmultiClick
, XmMULTICLICK_KEEP
,
334 XmNlabelType
, XmPIXMAP
,
336 XtAddCallback ((Widget
) button
,
337 XmNvalueChangedCallback
,
338 (XtCallbackProc
) wxToolButtonCallback
,
341 XtVaSetValues ((Widget
) button
,
343 m_backgroundColour
.AllocColour
344 (XtDisplay((Widget
) button
)),
347 else if( !tool
->GetButtonWidget() )
349 button
= XtVaCreateWidget("button",
350 xmPushButtonWidgetClass
, (Widget
) m_mainWidget
,
351 XmNx
, currentX
, XmNy
, currentY
,
352 XmNpushButtonEnabled
, True
,
353 XmNmultiClick
, XmMULTICLICK_KEEP
,
354 XmNlabelType
, XmPIXMAP
,
356 XtAddCallback (button
,
358 (XtCallbackProc
) wxToolButtonCallback
,
362 if( !tool
->GetButtonWidget() )
364 wxDoChangeBackgroundColour((WXWidget
) button
,
365 m_backgroundColour
, true);
367 tool
->SetWidget(button
);
371 button
= (Widget
)tool
->GetButtonWidget();
372 XtVaSetValues( button
,
373 XmNx
, currentX
, XmNy
, currentY
,
377 // For each button, if there is a mask, we must create
378 // a new wxBitmap that has the correct background colour
379 // for the button. Otherwise the background will just be
380 // e.g. black if a transparent XPM has been loaded.
381 bmp
= tool
->GetNormalBitmap();
382 insensBmp
= tool
->GetDisabledBitmap();
383 if ( bmp
.GetMask() || insensBmp
.GetMask() )
385 WXPixel backgroundPixel
;
386 XtVaGetValues(button
, XmNbackground
, &backgroundPixel
,
390 col
.SetPixel(backgroundPixel
);
392 if( bmp
.Ok() && bmp
.GetMask() )
394 bmp
= wxCreateMaskedBitmap(bmp
, col
);
395 tool
->SetNormalBitmap(bmp
);
398 if( insensBmp
.Ok() && insensBmp
.GetMask() )
400 insensBmp
= wxCreateMaskedBitmap(insensBmp
, col
);
401 tool
->SetDisabledBitmap(insensBmp
);
405 // Create a selected/toggled bitmap. If there isn't a 2nd
406 // bitmap, we need to create it (with a darker, selected
408 WXPixel backgroundPixel
;
409 if ( tool
->CanBeToggled() )
410 XtVaGetValues(button
, XmNselectColor
, &backgroundPixel
,
413 XtVaGetValues(button
, XmNarmColor
, &backgroundPixel
,
416 col
.SetPixel(backgroundPixel
);
418 pixmap
= (Pixmap
) bmp
.GetDrawable();
420 wxBitmap tmp
= tool
->GetDisabledBitmap();
422 insensPixmap
= tmp
.Ok() ?
423 (Pixmap
)tmp
.GetDrawable() :
424 tool
->GetInsensPixmap();
427 if (tool
->CanBeToggled())
430 Pixmap pixmap2
= tool
->GetArmPixmap();
431 Pixmap insensPixmap2
= tool
->GetInsensPixmap();
433 XtVaSetValues (button
,
434 XmNfillOnSelect
, True
,
435 XmNlabelPixmap
, pixmap
,
436 XmNselectPixmap
, pixmap2
,
437 XmNlabelInsensitivePixmap
, insensPixmap
,
438 XmNselectInsensitivePixmap
, insensPixmap2
,
439 XmNlabelType
, XmPIXMAP
,
444 Pixmap pixmap2
= tool
->GetArmPixmap();
447 XtVaSetValues(button
,
448 XmNlabelPixmap
, pixmap
,
449 XmNlabelInsensitivePixmap
, insensPixmap
,
450 XmNarmPixmap
, pixmap2
,
454 XtManageChild(button
);
457 Dimension width
, height
;
458 XtVaGetValues(button
,
463 currentY
+= height
+ packing
;
465 currentX
+= width
+ packing
;
466 buttonHeight
= wxMax(buttonHeight
, height
);
467 buttonWidth
= wxMax(buttonWidth
, width
);
470 XtAddEventHandler (button
, EnterWindowMask
| LeaveWindowMask
,
471 False
, wxToolButtonPopupCallback
, (XtPointer
) this);
476 node
= node
->GetNext();
480 isVertical
? buttonWidth
+ 2 * marginX
: -1,
481 isVertical
? -1 : buttonHeight
+ 2*marginY
);
486 wxToolBarToolBase
*wxToolBar::FindToolForPosition(wxCoord
WXUNUSED(x
),
487 wxCoord
WXUNUSED(y
)) const
489 wxFAIL_MSG( _T("TODO") );
491 return (wxToolBarToolBase
*)NULL
;
494 bool wxToolBar::DoInsertTool(size_t WXUNUSED(pos
), wxToolBarToolBase
*tool
)
501 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos
), wxToolBarToolBase
*tool
)
505 bool isVertical
= GetWindowStyle() & wxTB_VERTICAL
;
506 const int separatorSize
= GetToolSeparation(); // 8;
507 int packing
= GetToolPacking();
510 for( wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
511 node
; node
= node
->GetNext() )
513 wxToolBarTool
*t
= (wxToolBarTool
*)node
->GetData();
517 switch ( t
->GetStyle() )
519 case wxTOOL_STYLE_CONTROL
:
521 wxSize size
= t
->GetControl()->GetSize();
522 offset
= isVertical
? size
.y
: size
.x
;
526 case wxTOOL_STYLE_SEPARATOR
:
527 offset
= isVertical
? 0 : separatorSize
;
529 case wxTOOL_STYLE_BUTTON
:
531 Widget w
= t
->GetButtonWidget();
532 Dimension width
, height
;
539 offset
= isVertical
? height
: width
;
547 switch ( t
->GetStyle() )
549 case wxTOOL_STYLE_CONTROL
:
551 wxPoint location
= t
->GetControl()->GetPosition();
554 location
.y
-= offset
;
556 location
.x
-= offset
;
558 t
->GetControl()->Move( location
);
561 case wxTOOL_STYLE_SEPARATOR
:
563 case wxTOOL_STYLE_BUTTON
:
566 XtVaGetValues( t
->GetButtonWidget(),
572 y
= (Dimension
)(y
- offset
);
574 x
= (Dimension
)(x
- offset
);
576 XtVaSetValues( t
->GetButtonWidget(),
589 void wxToolBar::DoEnableTool(wxToolBarToolBase
*toolBase
, bool enable
)
591 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
592 if (tool
->GetButtonWidget()){
593 XtSetSensitive(tool
->GetButtonWidget(), (Boolean
) enable
);
594 } else if (wxTOOL_STYLE_CONTROL
== tool
->GetStyle()){
595 // Controls (such as wxChoice) do not have button widgets
596 tool
->GetControl()->Enable(enable
);
600 void wxToolBar::DoToggleTool(wxToolBarToolBase
*toolBase
, bool toggle
)
602 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
604 XmToggleButtonSetState(tool
->GetButtonWidget(), (Boolean
) toggle
, False
);
607 void wxToolBar::DoSetToggle(wxToolBarToolBase
* WXUNUSED(tool
),
608 bool WXUNUSED(toggle
))
613 void wxToolBar::DoSetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
615 int old_width
, old_height
;
616 GetSize(&old_width
, &old_height
);
618 // Correct width and height if needed.
619 if ( width
== -1 || height
== -1 )
621 wxSize defaultSize
= GetSize();
624 width
= defaultSize
.x
;
626 height
= defaultSize
.y
;
629 wxToolBarBase::DoSetSize(x
, y
, width
, height
, sizeFlags
);
631 // We must refresh the frame size when the toolbar changes size
632 // otherwise the toolbar can be shown incorrectly
633 if ( old_width
!= width
|| old_height
!= height
)
635 // But before we send the size event check it
636 // we have a frame that is not being deleted.
637 wxFrame
*frame
= wxDynamicCast(GetParent(), wxFrame
);
638 if ( frame
&& !frame
->IsBeingDeleted() )
640 frame
->SendSizeEvent();
645 // ----------------------------------------------------------------------------
647 // ----------------------------------------------------------------------------
649 wxToolBarToolBase
*wxToolBar::FindToolByWidget(WXWidget w
) const
651 wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
654 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
655 if ( tool
->GetButtonWidget() == w
)
660 node
= node
->GetNext();
663 return (wxToolBarToolBase
*)NULL
;
666 static void wxToolButtonCallback(Widget w
,
667 XtPointer clientData
,
668 XtPointer
WXUNUSED(ptr
))
670 wxToolBar
*toolBar
= (wxToolBar
*) clientData
;
671 wxToolBarToolBase
*tool
= toolBar
->FindToolByWidget((WXWidget
) w
);
675 if ( tool
->CanBeToggled() )
678 if ( !toolBar
->OnLeftClick(tool
->GetId(), tool
->IsToggled()) )
686 static void wxToolButtonPopupCallback(Widget w
,
687 XtPointer client_data
,
689 Boolean
*WXUNUSED(continue_to_dispatch
))
691 // TODO: retrieve delay before popping up tooltip from wxSystemSettings.
692 static const int delayMilli
= 800;
694 wxToolBar
* toolBar
= (wxToolBar
*) client_data
;
695 wxToolBarToolBase
*tool
= toolBar
->FindToolByWidget((WXWidget
) w
);
700 wxString tooltip
= tool
->GetShortHelp();
704 if (!wxTheToolBarTimer
)
705 wxTheToolBarTimer
= new wxToolBarTimer
;
707 wxToolBarTimer::buttonWidget
= w
;
708 wxToolBarTimer::helpString
= tooltip
;
710 /************************************************************/
711 /* Popup help label */
712 /************************************************************/
713 if (event
->type
== EnterNotify
)
715 if (wxToolBarTimer::help_popup
!= (Widget
) 0)
717 XtDestroyWidget (wxToolBarTimer::help_popup
);
718 XtPopdown (wxToolBarTimer::help_popup
);
720 wxToolBarTimer::help_popup
= (Widget
) 0;
723 wxTheToolBarTimer
->Start(delayMilli
, true);
726 /************************************************************/
727 /* Popdown help label */
728 /************************************************************/
729 else if (event
->type
== LeaveNotify
)
731 if (wxTheToolBarTimer
)
732 wxTheToolBarTimer
->Stop();
733 if (wxToolBarTimer::help_popup
!= (Widget
) 0)
735 XtDestroyWidget (wxToolBarTimer::help_popup
);
736 XtPopdown (wxToolBarTimer::help_popup
);
738 wxToolBarTimer::help_popup
= (Widget
) 0;
742 void wxToolBarTimer::Notify()
746 /************************************************************/
747 /* Create shell without window decorations */
748 /************************************************************/
749 help_popup
= XtVaCreatePopupShell ("shell",
750 overrideShellWidgetClass
, (Widget
) wxTheApp
->GetTopLevelWidget(),
753 /************************************************************/
754 /* Get absolute position on display of toolbar button */
755 /************************************************************/
756 XtTranslateCoords (buttonWidget
,
761 // Move the tooltip more or less above the button
762 int yOffset
= 20; // TODO: What should be really?
763 y
= (Position
)(y
- yOffset
);
764 if (y
< yOffset
) y
= 0;
766 /************************************************************/
767 /* Set the position of the help popup */
768 /************************************************************/
769 XtVaSetValues (help_popup
,
774 /************************************************************/
775 /* Create help label */
776 /************************************************************/
777 XmString text
= XmStringCreateSimple ((char*) (const char*) helpString
);
778 XtVaCreateManagedWidget ("help_label",
779 xmLabelWidgetClass
, help_popup
,
780 XmNlabelString
, text
,
782 XmNforeground
, XtRString
, "black",
785 XmNbackground
, XtRString
, "LightGoldenrod",
786 strlen("LightGoldenrod")+1,
790 /************************************************************/
791 /* Popup help label */
792 /************************************************************/
793 XtPopup (help_popup
, XtGrabNone
);