]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/gtk/menu.cpp
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Applied patch [ 583922 ] Make generic/wxListCtrl avail. in WIN32
[wxWidgets.git] / src / gtk / menu.cpp
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: menu.cpp
3// Purpose:
4// Author: Robert Roebling
5// Id: $Id$
6// Copyright: (c) 1998 Robert Roebling
7// Licence: wxWindows licence
8/////////////////////////////////////////////////////////////////////////////
9
10#ifdef __GNUG__
11#pragma implementation "menu.h"
12#pragma implementation "menuitem.h"
13#endif
14
15#include "wx/log.h"
16#include "wx/intl.h"
17#include "wx/app.h"
18#include "wx/bitmap.h"
19#include "wx/menu.h"
20
21#if wxUSE_ACCEL
22 #include "wx/accel.h"
23#endif // wxUSE_ACCEL
24
25#include "wx/gtk/private.h"
26
27#include <gdk/gdkkeysyms.h>
28
29// FIXME: is this right? somehow I don't think so (VZ)
30#ifdef __WXGTK20__
31 #include <glib-object.h>
32
33 #define gtk_accel_group_attach(g, o) _gtk_accel_group_attach((g), (o))
34 #define gtk_accel_group_detach(g, o) _gtk_accel_group_detach((g), (o))
35 #define gtk_menu_ensure_uline_accel_group(m) gtk_menu_get_accel_group(m)
36
37 #define ACCEL_OBJECT GObject
38 #define ACCEL_OBJECTS(a) (a)->acceleratables
39 #define ACCEL_OBJ_CAST(obj) G_OBJECT(obj)
40#else // GTK+ 1.x
41 #define ACCEL_OBJECT GtkObject
42 #define ACCEL_OBJECTS(a) (a)->attach_objects
43 #define ACCEL_OBJ_CAST(obj) GTK_OBJECT(obj)
44#endif
45
46//-----------------------------------------------------------------------------
47// idle system
48//-----------------------------------------------------------------------------
49
50extern void wxapp_install_idle_handler();
51extern bool g_isIdle;
52
53#if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
54 static wxString GetHotKey( const wxMenuItem& item );
55#endif
56
57//-----------------------------------------------------------------------------
58// substitute for missing GtkPixmapMenuItem
59//-----------------------------------------------------------------------------
60
61// FIXME: I can't make this compile with GTK+ 2.0, disabling for now (VZ)
62#ifndef __WXGTK20__
63 #define USE_MENU_BITMAPS
64#endif
65
66#ifdef USE_MENU_BITMAPS
67
68#define GTK_TYPE_PIXMAP_MENU_ITEM (gtk_pixmap_menu_item_get_type ())
69#define GTK_PIXMAP_MENU_ITEM(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_PIXMAP_MENU_ITEM, GtkPixmapMenuItem))
70#define GTK_PIXMAP_MENU_ITEM_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_PIXMAP_MENU_ITEM, GtkPixmapMenuItemClass))
71#define GTK_IS_PIXMAP_MENU_ITEM(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_PIXMAP_MENU_ITEM))
72#define GTK_IS_PIXMAP_MENU_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PIXMAP_MENU_ITEM))
73//#define GTK_PIXMAP_MENU_ITEM_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_PIXMAP_MENU_ITEM))
74#define GTK_PIXMAP_MENU_ITEM_GET_CLASS(obj) (GTK_PIXMAP_MENU_ITEM_CLASS( GTK_OBJECT_GET_CLASS(obj)))
75
76#ifndef GTK_MENU_ITEM_GET_CLASS
77#define GTK_MENU_ITEM_GET_CLASS(obj) (GTK_MENU_ITEM_CLASS( GTK_OBJECT_GET_CLASS(obj)))
78#endif
79
80typedef struct _GtkPixmapMenuItem GtkPixmapMenuItem;
81typedef struct _GtkPixmapMenuItemClass GtkPixmapMenuItemClass;
82
83struct _GtkPixmapMenuItem
84{
85 GtkMenuItem menu_item;
86
87 GtkWidget *pixmap;
88};
89
90struct _GtkPixmapMenuItemClass
91{
92 GtkMenuItemClass parent_class;
93
94 guint orig_toggle_size;
95 guint have_pixmap_count;
96};
97
98
99GtkType gtk_pixmap_menu_item_get_type (void);
100GtkWidget* gtk_pixmap_menu_item_new (void);
101void gtk_pixmap_menu_item_set_pixmap (GtkPixmapMenuItem *menu_item,
102 GtkWidget *pixmap);
103
104#endif // USE_MENU_BITMAPS
105
106//-----------------------------------------------------------------------------
107// idle system
108//-----------------------------------------------------------------------------
109
110static wxString wxReplaceUnderscore( const wxString& title )
111{
112 const wxChar *pc;
113
114 /* GTK 1.2 wants to have "_" instead of "&" for accelerators */
115 wxString str;
116 for ( pc = title; *pc != wxT('\0'); pc++ )
117 {
118 if (*pc == wxT('&'))
119 {
120#if GTK_CHECK_VERSION(1, 2, 1)
121 str << wxT('_');
122 }
123 else if (*pc == wxT('/'))
124 {
125 str << wxT('\\');
126#endif
127 }
128 else
129 {
130#if __WXGTK12__
131 if ( *pc == wxT('_') )
132 {
133 // underscores must be doubled to prevent them from being
134 // interpreted as accelerator character prefix by GTK
135 str << *pc;
136 }
137#endif // GTK+ 1.2
138
139 str << *pc;
140 }
141 }
142 return str;
143}
144
145//-----------------------------------------------------------------------------
146// wxMenuBar
147//-----------------------------------------------------------------------------
148
149IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
150
151wxMenuBar::wxMenuBar( long style )
152{
153 /* the parent window is known after wxFrame::SetMenu() */
154 m_needParent = FALSE;
155 m_style = style;
156 m_invokingWindow = (wxWindow*) NULL;
157
158 if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
159 !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
160 {
161 wxFAIL_MSG( wxT("wxMenuBar creation failed") );
162 return;
163 }
164
165 m_menus.DeleteContents( TRUE );
166
167 /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
168#if GTK_CHECK_VERSION(1, 2, 1)
169 m_accel = gtk_accel_group_new();
170 m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
171 m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
172#else
173 m_menubar = gtk_menu_bar_new();
174#endif
175
176 if (style & wxMB_DOCKABLE)
177 {
178 m_widget = gtk_handle_box_new();
179 gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_menubar) );
180 gtk_widget_show( GTK_WIDGET(m_menubar) );
181 }
182 else
183 {
184 m_widget = GTK_WIDGET(m_menubar);
185 }
186
187 PostCreation();
188
189 ApplyWidgetStyle();
190}
191
192wxMenuBar::wxMenuBar()
193{
194 /* the parent window is known after wxFrame::SetMenu() */
195 m_needParent = FALSE;
196 m_style = 0;
197 m_invokingWindow = (wxWindow*) NULL;
198
199 if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
200 !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("menubar") ))
201 {
202 wxFAIL_MSG( wxT("wxMenuBar creation failed") );
203 return;
204 }
205
206 m_menus.DeleteContents( TRUE );
207
208 /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
209#if GTK_CHECK_VERSION(1, 2, 1)
210 m_accel = gtk_accel_group_new();
211 m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
212 m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
213#else
214 m_menubar = gtk_menu_bar_new();
215#endif
216
217 m_widget = GTK_WIDGET(m_menubar);
218
219 PostCreation();
220
221 ApplyWidgetStyle();
222}
223
224wxMenuBar::~wxMenuBar()
225{
226// gtk_object_unref( GTK_OBJECT(m_factory) ); why not ?
227}
228
229static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
230{
231 menu->SetInvokingWindow( (wxWindow*) NULL );
232
233#if GTK_CHECK_VERSION(1, 2, 0)
234 wxWindow *top_frame = win;
235 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
236 top_frame = top_frame->GetParent();
237
238 /* support for native hot keys */
239 gtk_accel_group_detach( menu->m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
240#endif
241
242 wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
243 while (node)
244 {
245 wxMenuItem *menuitem = node->GetData();
246 if (menuitem->IsSubMenu())
247 wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu(), win );
248 node = node->GetNext();
249 }
250}
251
252static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
253{
254 menu->SetInvokingWindow( win );
255
256#if GTK_CHECK_VERSION(1, 2, 1)
257 wxWindow *top_frame = win;
258 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
259 top_frame = top_frame->GetParent();
260
261 /* support for native hot keys */
262 ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
263 if ( !g_slist_find( ACCEL_OBJECTS(menu->m_accel), obj ) )
264 gtk_accel_group_attach( menu->m_accel, obj );
265#endif // GTK+ 1.2.1+
266
267 wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
268 while (node)
269 {
270 wxMenuItem *menuitem = node->GetData();
271 if (menuitem->IsSubMenu())
272 wxMenubarSetInvokingWindow( menuitem->GetSubMenu(), win );
273 node = node->GetNext();
274 }
275}
276
277void wxMenuBar::SetInvokingWindow( wxWindow *win )
278{
279 m_invokingWindow = win;
280#if GTK_CHECK_VERSION(1, 2, 1)
281 wxWindow *top_frame = win;
282 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
283 top_frame = top_frame->GetParent();
284
285 /* support for native key accelerators indicated by underscroes */
286 ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
287 if ( !g_slist_find( ACCEL_OBJECTS(m_accel), obj ) )
288 gtk_accel_group_attach( m_accel, obj );
289#endif // GTK+ 1.2.1+
290
291 wxMenuList::Node *node = m_menus.GetFirst();
292 while (node)
293 {
294 wxMenu *menu = node->GetData();
295 wxMenubarSetInvokingWindow( menu, win );
296 node = node->GetNext();
297 }
298}
299
300void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
301{
302 m_invokingWindow = (wxWindow*) NULL;
303#if GTK_CHECK_VERSION(1, 2, 1)
304 wxWindow *top_frame = win;
305 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
306 top_frame = top_frame->GetParent();
307
308 /* support for native key accelerators indicated by underscroes */
309 gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
310#endif // GTK+ 1.2.1+
311
312 wxMenuList::Node *node = m_menus.GetFirst();
313 while (node)
314 {
315 wxMenu *menu = node->GetData();
316 wxMenubarUnsetInvokingWindow( menu, win );
317 node = node->GetNext();
318 }
319}
320
321bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
322{
323 if ( !wxMenuBarBase::Append( menu, title ) )
324 return FALSE;
325
326 return GtkAppend(menu, title);
327}
328
329bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title)
330{
331 wxString str( wxReplaceUnderscore( title ) );
332
333 /* this doesn't have much effect right now */
334 menu->SetTitle( str );
335
336 /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
337#if GTK_CHECK_VERSION(1, 2, 1)
338
339 /* local buffer in multibyte form */
340 wxString buf;
341 buf << wxT('/') << str.c_str();
342
343 char *cbuf = new char[buf.Length()+1];
344 strcpy(cbuf, buf.mbc_str());
345
346 GtkItemFactoryEntry entry;
347 entry.path = (gchar *)cbuf; // const_cast
348 entry.accelerator = (gchar*) NULL;
349 entry.callback = (GtkItemFactoryCallback) NULL;
350 entry.callback_action = 0;
351 entry.item_type = (char *)"<Branch>";
352
353 gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 ); /* what is 2 ? */
354 /* in order to get the pointer to the item we need the item text _without_ underscores */
355 wxString tmp = wxT("<main>/");
356 const wxChar *pc;
357 for ( pc = str; *pc != wxT('\0'); pc++ )
358 {
359 // contrary to the common sense, we must throw out _all_ underscores,
360 // (i.e. "Hello__World" => "HelloWorld" and not "Hello_World" as we
361 // might naively think). IMHO it's a bug in GTK+ (VZ)
362 while (*pc == wxT('_'))
363 pc++;
364 tmp << *pc;
365 }
366 menu->m_owner = gtk_item_factory_get_item( m_factory, tmp.mb_str() );
367 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
368 delete [] cbuf;
369#else
370
371 menu->m_owner = gtk_menu_item_new_with_label( str.mb_str() );
372 gtk_widget_show( menu->m_owner );
373 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
374
375 gtk_menu_bar_append( GTK_MENU_BAR(m_menubar), menu->m_owner );
376
377#endif
378
379 // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
380 // adding menu later on.
381 if (m_invokingWindow)
382 wxMenubarSetInvokingWindow( menu, m_invokingWindow );
383
384 return TRUE;
385}
386
387bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
388{
389 if ( !wxMenuBarBase::Insert(pos, menu, title) )
390 return FALSE;
391
392#if __WXGTK12__
393 // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
394 // of version 1.2.6), so we first append the item and then change its
395 // index
396 if ( !GtkAppend(menu, title) )
397 return FALSE;
398
399 if (pos+1 >= m_menus.GetCount())
400 return TRUE;
401
402 GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
403 gpointer data = g_list_last(menu_shell->children)->data;
404 menu_shell->children = g_list_remove(menu_shell->children, data);
405 menu_shell->children = g_list_insert(menu_shell->children, data, pos);
406
407 return TRUE;
408#else // GTK < 1.2
409 // this should be easy to do with GTK 1.0 - can use standard functions for
410 // this and don't need any hacks like above, but as I don't have GTK 1.0
411 // any more I can't do it
412 wxFAIL_MSG( wxT("TODO") );
413
414 return FALSE;
415#endif // GTK 1.2/1.0
416}
417
418wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
419{
420 // remove the old item and insert a new one
421 wxMenu *menuOld = Remove(pos);
422 if ( menuOld && !Insert(pos, menu, title) )
423 {
424 return (wxMenu*) NULL;
425 }
426
427 // either Insert() succeeded or Remove() failed and menuOld is NULL
428 return menuOld;
429}
430
431wxMenu *wxMenuBar::Remove(size_t pos)
432{
433 wxMenu *menu = wxMenuBarBase::Remove(pos);
434 if ( !menu )
435 return (wxMenu*) NULL;
436
437/*
438 GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
439
440 printf( "factory entries before %d\n", (int)g_slist_length(m_factory->items) );
441 printf( "menu shell entries before %d\n", (int)g_list_length( menu_shell->children ) );
442*/
443
444 // unparent calls unref() and that would delete the widget so we raise
445 // the ref count to 2 artificially before invoking unparent.
446 gtk_widget_ref( menu->m_menu );
447 gtk_widget_unparent( menu->m_menu );
448
449 gtk_widget_destroy( menu->m_owner );
450
451/*
452 printf( "factory entries after %d\n", (int)g_slist_length(m_factory->items) );
453 printf( "menu shell entries after %d\n", (int)g_list_length( menu_shell->children ) );
454*/
455
456 return menu;
457}
458
459static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
460{
461 if (wxMenuItem::GetLabelFromText(menu->GetTitle()) == wxMenuItem::GetLabelFromText(menuString))
462 {
463 int res = menu->FindItem( itemString );
464 if (res != wxNOT_FOUND)
465 return res;
466 }
467
468 wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
469 while (node)
470 {
471 wxMenuItem *item = node->GetData();
472 if (item->IsSubMenu())
473 return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
474
475 node = node->GetNext();
476 }
477
478 return wxNOT_FOUND;
479}
480
481int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
482{
483 wxMenuList::Node *node = m_menus.GetFirst();
484 while (node)
485 {
486 wxMenu *menu = node->GetData();
487 int res = FindMenuItemRecursive( menu, menuString, itemString);
488 if (res != -1)
489 return res;
490 node = node->GetNext();
491 }
492
493 return wxNOT_FOUND;
494}
495
496// Find a wxMenuItem using its id. Recurses down into sub-menus
497static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
498{
499 wxMenuItem* result = menu->FindChildItem(id);
500
501 wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
502 while ( node && result == NULL )
503 {
504 wxMenuItem *item = node->GetData();
505 if (item->IsSubMenu())
506 {
507 result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
508 }
509 node = node->GetNext();
510 }
511
512 return result;
513}
514
515wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
516{
517 wxMenuItem* result = 0;
518 wxMenuList::Node *node = m_menus.GetFirst();
519 while (node && result == 0)
520 {
521 wxMenu *menu = node->GetData();
522 result = FindMenuItemByIdRecursive( menu, id );
523 node = node->GetNext();
524 }
525
526 if ( menuForItem )
527 {
528 *menuForItem = result ? result->GetMenu() : (wxMenu *)NULL;
529 }
530
531 return result;
532}
533
534void wxMenuBar::EnableTop( size_t pos, bool flag )
535{
536 wxMenuList::Node *node = m_menus.Item( pos );
537
538 wxCHECK_RET( node, wxT("menu not found") );
539
540 wxMenu* menu = node->GetData();
541
542 if (menu->m_owner)
543 gtk_widget_set_sensitive( menu->m_owner, flag );
544}
545
546wxString wxMenuBar::GetLabelTop( size_t pos ) const
547{
548 wxMenuList::Node *node = m_menus.Item( pos );
549
550 wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
551
552 wxMenu* menu = node->GetData();
553
554 wxString label;
555 wxString text( menu->GetTitle() );
556#if GTK_CHECK_VERSION(1, 2, 0)
557 for ( const wxChar *pc = text.c_str(); *pc; pc++ )
558 {
559 if ( *pc == wxT('_') || *pc == wxT('&') )
560 {
561 // '_' is the escape character for GTK+ and '&' is the one for
562 // wxWindows - skip both of them
563 continue;
564 }
565
566 label += *pc;
567 }
568#else // GTK+ 1.0
569 label = text;
570#endif // GTK+ 1.2/1.0
571
572 return label;
573}
574
575void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
576{
577 wxMenuList::Node *node = m_menus.Item( pos );
578
579 wxCHECK_RET( node, wxT("menu not found") );
580
581 wxMenu* menu = node->GetData();
582
583 wxString str( wxReplaceUnderscore( label ) );
584
585 menu->SetTitle( str );
586
587 if (menu->m_owner)
588 {
589 GtkLabel *label = GTK_LABEL( GTK_BIN(menu->m_owner)->child );
590
591 /* set new text */
592 gtk_label_set( label, str.mb_str());
593
594 /* reparse key accel */
595 (void)gtk_label_parse_uline (GTK_LABEL(label), str.mb_str() );
596 gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
597 }
598
599}
600
601//-----------------------------------------------------------------------------
602// "activate"
603//-----------------------------------------------------------------------------
604
605static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
606{
607 if (g_isIdle)
608 wxapp_install_idle_handler();
609
610 int id = menu->FindMenuIdByMenuItem(widget);
611
612 /* should find it for normal (not popup) menu */
613 wxASSERT_MSG( (id != -1) || (menu->GetInvokingWindow() != NULL),
614 _T("menu item not found in gtk_menu_clicked_callback") );
615
616 if (!menu->IsEnabled(id))
617 return;
618
619 wxMenuItem* item = menu->FindChildItem( id );
620 wxCHECK_RET( item, wxT("error in menu item callback") );
621
622 if (item->IsCheckable())
623 {
624 bool isReallyChecked = item->IsChecked(),
625 isInternallyChecked = item->wxMenuItemBase::IsChecked();
626
627 // ensure that the internal state is always consistent with what is
628 // shown on the screen
629 item->wxMenuItemBase::Check(isReallyChecked);
630
631 // we must not report the events for the radio button going up nor the
632 // events resulting from the calls to wxMenuItem::Check()
633 if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
634 (isInternallyChecked == isReallyChecked) )
635 {
636 return;
637 }
638
639 // the user pressed on the menu item: report the event below
640 }
641
642 menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
643}
644
645//-----------------------------------------------------------------------------
646// "select"
647//-----------------------------------------------------------------------------
648
649static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
650{
651 if (g_isIdle) wxapp_install_idle_handler();
652
653 int id = menu->FindMenuIdByMenuItem(widget);
654
655 wxASSERT( id != -1 ); // should find it!
656
657 if (!menu->IsEnabled(id))
658 return;
659
660 wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, id );
661 event.SetEventObject( menu );
662
663 if (menu->GetEventHandler()->ProcessEvent(event))
664 return;
665
666 wxWindow *win = menu->GetInvokingWindow();
667 if (win) win->GetEventHandler()->ProcessEvent( event );
668}
669
670//-----------------------------------------------------------------------------
671// "deselect"
672//-----------------------------------------------------------------------------
673
674static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
675{
676 if (g_isIdle) wxapp_install_idle_handler();
677
678 int id = menu->FindMenuIdByMenuItem(widget);
679
680 wxASSERT( id != -1 ); // should find it!
681
682 if (!menu->IsEnabled(id))
683 return;
684
685 wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
686 event.SetEventObject( menu );
687
688 if (menu->GetEventHandler()->ProcessEvent(event))
689 return;
690
691 wxWindow *win = menu->GetInvokingWindow();
692 if (win)
693 win->GetEventHandler()->ProcessEvent( event );
694}
695
696//-----------------------------------------------------------------------------
697// wxMenuItem
698//-----------------------------------------------------------------------------
699
700IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
701
702wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
703 int id,
704 const wxString& name,
705 const wxString& help,
706 wxItemKind kind,
707 wxMenu *subMenu)
708{
709 return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
710}
711
712wxMenuItem::wxMenuItem(wxMenu *parentMenu,
713 int id,
714 const wxString& text,
715 const wxString& help,
716 wxItemKind kind,
717 wxMenu *subMenu)
718 : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
719{
720 Init(text);
721}
722
723wxMenuItem::wxMenuItem(wxMenu *parentMenu,
724 int id,
725 const wxString& text,
726 const wxString& help,
727 bool isCheckable,
728 wxMenu *subMenu)
729 : wxMenuItemBase(parentMenu, id, text, help,
730 isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
731{
732 Init(text);
733}
734
735void wxMenuItem::Init(const wxString& text)
736{
737 m_labelWidget = (GtkWidget *) NULL;
738 m_menuItem = (GtkWidget *) NULL;
739
740 DoSetText(text);
741}
742
743wxMenuItem::~wxMenuItem()
744{
745 // don't delete menu items, the menus take care of that
746}
747
748// return the menu item text without any menu accels
749/* static */
750wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
751{
752 wxString label;
753
754 for ( const wxChar *pc = text.c_str(); *pc; pc++ )
755 {
756 if ( *pc == wxT('_') )
757 {
758 // wxGTK escapes "xxx_xxx" to "xxx__xxx"
759 pc++;
760 label += *pc;
761 continue;
762 }
763
764 if ( *pc == wxT('&') )
765 {
766 // wxMSW escapes &
767 continue;
768 }
769
770 label += *pc;
771 }
772
773 return label;
774}
775
776void wxMenuItem::SetText( const wxString& str )
777{
778 // Some optimization to avoid flicker
779 wxString oldLabel = m_text;
780 oldLabel = wxStripMenuCodes(oldLabel.BeforeFirst('\t'));
781 oldLabel.Replace(wxT("_"), wxT(""));
782 wxString label1 = wxStripMenuCodes(str.BeforeFirst('\t'));
783 if (oldLabel == label1)
784 return;
785
786 DoSetText(str);
787
788 if (m_menuItem)
789 {
790 GtkLabel *label;
791 if (m_labelWidget)
792 label = (GtkLabel*) m_labelWidget;
793 else
794 label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
795
796 /* set new text */
797 gtk_label_set( label, m_text.mb_str());
798
799 /* reparse key accel */
800 (void)gtk_label_parse_uline (GTK_LABEL(label), m_text.mb_str() );
801 gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
802 }
803}
804
805// it's valid for this function to be called even if m_menuItem == NULL
806void wxMenuItem::DoSetText( const wxString& str )
807{
808 /* '\t' is the deliminator indicating a hot key */
809 m_text.Empty();
810 const wxChar *pc = str;
811 for (; (*pc != wxT('\0')) && (*pc != wxT('\t')); pc++ )
812 {
813 if (*pc == wxT('&'))
814 {
815#if GTK_CHECK_VERSION(1, 2, 0)
816 m_text << wxT('_');
817 }
818 else if ( *pc == wxT('_') ) // escape underscores
819 {
820 m_text << wxT("__");
821 }
822 else if (*pc == wxT('/')) /* we have to filter out slashes ... */
823 {
824 m_text << wxT('\\'); /* ... and replace them with back slashes */
825#endif // GTK+ 1.2.0+
826 }
827 else
828 m_text << *pc;
829 }
830
831 /* only GTK 1.2 knows about hot keys */
832 m_hotKey = wxT("");
833
834#if GTK_CHECK_VERSION(1, 2, 0)
835 if(*pc == wxT('\t'))
836 {
837 pc++;
838 m_hotKey = pc;
839 }
840#endif // GTK+ 1.2.0+
841}
842
843#if wxUSE_ACCEL
844
845wxAcceleratorEntry *wxMenuItem::GetAccel() const
846{
847 if ( !GetHotKey() )
848 {
849 // nothing
850 return (wxAcceleratorEntry *)NULL;
851 }
852
853 // as wxGetAccelFromString() looks for TAB, insert a dummy one here
854 wxString label;
855 label << wxT('\t') << GetHotKey();
856
857 return wxGetAccelFromString(label);
858}
859
860#endif // wxUSE_ACCEL
861
862void wxMenuItem::Check( bool check )
863{
864 wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
865
866 if (check == m_isChecked)
867 return;
868
869 wxMenuItemBase::Check( check );
870
871 switch ( GetKind() )
872 {
873 case wxITEM_CHECK:
874 case wxITEM_RADIO:
875 gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
876 break;
877
878 default:
879 wxFAIL_MSG( _T("can't check this item") );
880 }
881}
882
883void wxMenuItem::Enable( bool enable )
884{
885 wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
886
887 gtk_widget_set_sensitive( m_menuItem, enable );
888 wxMenuItemBase::Enable( enable );
889}
890
891bool wxMenuItem::IsChecked() const
892{
893 wxCHECK_MSG( m_menuItem, FALSE, wxT("invalid menu item") );
894
895 wxCHECK_MSG( IsCheckable(), FALSE,
896 wxT("can't get state of uncheckable item!") );
897
898 return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
899}
900
901wxString wxMenuItem::GetFactoryPath() const
902{
903 /* in order to get the pointer to the item we need the item text
904 _without_ underscores */
905 wxString path( wxT("<main>/") );
906
907 for ( const wxChar *pc = m_text.c_str(); *pc; pc++ )
908 {
909 if ( *pc == wxT('_') || *pc == wxT('&') )
910 {
911 // remove '_' and '&' unconditionally
912 continue;
913 }
914
915 path += *pc;
916 }
917
918 return path;
919}
920
921//-----------------------------------------------------------------------------
922// wxMenu
923//-----------------------------------------------------------------------------
924
925IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
926
927void wxMenu::Init()
928{
929#if GTK_CHECK_VERSION(1, 2, 0)
930 m_accel = gtk_accel_group_new();
931 m_factory = gtk_item_factory_new( GTK_TYPE_MENU, "<main>", m_accel );
932 m_menu = gtk_item_factory_get_widget( m_factory, "<main>" );
933#else
934 m_menu = gtk_menu_new(); // Do not show!
935#endif
936
937 m_owner = (GtkWidget*) NULL;
938
939#if GTK_CHECK_VERSION(1, 2, 0)
940 /* Tearoffs are entries, just like separators. So if we want this
941 menu to be a tear-off one, we just append a tearoff entry
942 immediately. */
943 if(m_style & wxMENU_TEAROFF)
944 {
945 GtkItemFactoryEntry entry;
946 entry.path = (char *)"/tearoff";
947 entry.callback = (GtkItemFactoryCallback) NULL;
948 entry.callback_action = 0;
949 entry.item_type = (char *)"<Tearoff>";
950 entry.accelerator = (gchar*) NULL;
951 gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 ); /* what is 2 ? */
952 //GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, "<main>/tearoff" );
953 }
954#endif // GTK+ 1.2.0+
955
956 // append the title as the very first entry if we have it
957 if ( !!m_title )
958 {
959 Append(-2, m_title);
960 AppendSeparator();
961 }
962}
963
964wxMenu::~wxMenu()
965{
966 m_items.Clear();
967
968 gtk_widget_destroy( m_menu );
969
970 gtk_object_unref( GTK_OBJECT(m_factory) );
971}
972
973bool wxMenu::GtkAppend(wxMenuItem *mitem)
974{
975 GtkWidget *menuItem;
976
977#if defined(USE_MENU_BITMAPS) || !GTK_CHECK_VERSION(1, 2, 0)
978 bool appended = FALSE;
979#endif
980
981#if GTK_CHECK_VERSION(1, 2, 0)
982 // does this item terminate the current radio group?
983 bool endOfRadioGroup = TRUE;
984#endif // GTK+ >= 1.2
985
986 if ( mitem->IsSeparator() )
987 {
988#if GTK_CHECK_VERSION(1, 2, 0)
989 GtkItemFactoryEntry entry;
990 entry.path = (char *)"/sep";
991 entry.callback = (GtkItemFactoryCallback) NULL;
992 entry.callback_action = 0;
993 entry.item_type = (char *)"<Separator>";
994 entry.accelerator = (gchar*) NULL;
995
996 gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 ); /* what is 2 ? */
997
998 /* this will be wrong for more than one separator. do we care? */
999 menuItem = gtk_item_factory_get_widget( m_factory, "<main>/sep" );
1000
1001 // we might have a separator inside a radio group
1002 endOfRadioGroup = FALSE;
1003#else // GTK+ 1.0
1004 menuItem = gtk_menu_item_new();
1005#endif // GTK 1.2/1.0
1006 }
1007 else if ( mitem->IsSubMenu() )
1008 {
1009#if GTK_CHECK_VERSION(1, 2, 0)
1010 /* text has "_" instead of "&" after mitem->SetText() */
1011 wxString text( mitem->GetText() );
1012
1013 /* local buffer in multibyte form */
1014 char buf[200];
1015 strcpy( buf, "/" );
1016 strcat( buf, text.mb_str() );
1017
1018 GtkItemFactoryEntry entry;
1019 entry.path = buf;
1020 entry.callback = (GtkItemFactoryCallback) 0;
1021 entry.callback_action = 0;
1022 entry.item_type = (char *)"<Branch>";
1023 entry.accelerator = (gchar*) NULL;
1024
1025 gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 ); /* what is 2 ? */
1026
1027 wxString path( mitem->GetFactoryPath() );
1028 menuItem = gtk_item_factory_get_item( m_factory, path.mb_str() );
1029#else // GTK+ 1.0
1030 menuItem = gtk_menu_item_new_with_label(mitem->GetText().mbc_str());
1031#endif // GTK 1.2/1.0
1032
1033 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
1034
1035 // if adding a submenu to a menu already existing in the menu bar, we
1036 // must set invoking window to allow processing events from this
1037 // submenu
1038 if ( m_invokingWindow )
1039 wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
1040 }
1041#ifdef USE_MENU_BITMAPS
1042 else if (mitem->GetBitmap().Ok()) // An item with bitmap
1043 {
1044 wxString text( mitem->GetText() );
1045 const wxBitmap *bitmap = &mitem->GetBitmap();
1046
1047 menuItem = gtk_pixmap_menu_item_new ();
1048 GtkWidget *label = gtk_accel_label_new (text.mb_str());
1049 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
1050 gtk_container_add (GTK_CONTAINER (menuItem), label);
1051 guint accel_key = gtk_label_parse_uline (GTK_LABEL(label), text.mb_str() );
1052 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (label), menuItem);
1053 if (accel_key != GDK_VoidSymbol)
1054 {
1055 gtk_widget_add_accelerator (menuItem,
1056 "activate_item",
1057 gtk_menu_ensure_uline_accel_group (GTK_MENU (m_menu)),
1058 accel_key, 0,
1059 GTK_ACCEL_LOCKED);
1060 }
1061 gtk_widget_show (label);
1062
1063 mitem->SetLabelWidget(label);
1064
1065 GtkWidget* pixmap = gtk_pixmap_new( bitmap->GetPixmap(), bitmap->GetMask() ? bitmap->GetMask()->GetBitmap() : (GdkBitmap* )NULL);
1066 gtk_widget_show(pixmap);
1067 gtk_pixmap_menu_item_set_pixmap(GTK_PIXMAP_MENU_ITEM( menuItem ), pixmap);
1068
1069 gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1070 GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1071 (gpointer)this );
1072 gtk_menu_append( GTK_MENU(m_menu), menuItem );
1073 gtk_widget_show( menuItem );
1074
1075 appended = TRUE; // We've done this, don't do it again
1076 }
1077#endif // USE_MENU_BITMAPS
1078 else // a normal item
1079 {
1080#if GTK_CHECK_VERSION(1, 2, 0)
1081 /* text has "_" instead of "&" after mitem->SetText() */
1082 wxString text( mitem->GetText() );
1083
1084 /* local buffer in multibyte form */
1085 char buf[200];
1086 strcpy( buf, "/" );
1087 strncat( buf, text.mb_str(), WXSIZEOF(buf) - 2 );
1088 buf[WXSIZEOF(buf) - 1] = '\0';
1089
1090 GtkItemFactoryEntry entry;
1091 entry.path = buf;
1092 entry.callback = (GtkItemFactoryCallback) gtk_menu_clicked_callback;
1093 entry.callback_action = 0;
1094
1095 wxString pathRadio;
1096 const char *item_type;
1097 switch ( mitem->GetKind() )
1098 {
1099 case wxITEM_CHECK:
1100 item_type = "<CheckItem>";
1101 break;
1102
1103 case wxITEM_RADIO:
1104 if ( m_pathLastRadio.empty() )
1105 {
1106 // start of a new radio group
1107 item_type = "<RadioItem>";
1108 m_pathLastRadio = buf + 1;
1109 }
1110 else // continue the radio group
1111 {
1112 pathRadio = m_pathLastRadio;
1113 pathRadio.Replace("_", "");
1114 pathRadio.Prepend("<main>/");
1115 item_type = pathRadio;
1116 }
1117
1118 // continue the existing radio group, if any
1119 endOfRadioGroup = FALSE;
1120 break;
1121
1122 default:
1123 wxFAIL_MSG( _T("unexpected menu item kind") );
1124 // fall through
1125
1126 case wxITEM_NORMAL:
1127 item_type = "<Item>";
1128 break;
1129 }
1130
1131 entry.item_type = (char *)item_type; // cast needed for GTK+
1132 entry.accelerator = (gchar*) NULL;
1133
1134#if wxUSE_ACCEL
1135 // due to an apparent bug in GTK+, we have to use a static buffer here -
1136 // otherwise GTK+ 1.2.2 manages to override the memory we pass to it
1137 // somehow! (VZ)
1138 static char s_accel[50]; // must be big enougg
1139 wxString tmp( GetHotKey(*mitem) );
1140 strncpy(s_accel, tmp.mb_str(), WXSIZEOF(s_accel));
1141 entry.accelerator = s_accel;
1142#else // !wxUSE_ACCEL
1143 entry.accelerator = (char*) NULL;
1144#endif // wxUSE_ACCEL/!wxUSE_ACCEL
1145
1146 gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 ); /* what is 2 ? */
1147
1148 wxString path( mitem->GetFactoryPath() );
1149 menuItem = gtk_item_factory_get_widget( m_factory, path.mb_str() );
1150#else // GTK+ 1.0
1151 menuItem = checkable ? gtk_check_menu_item_new_with_label( mitem->GetText().mb_str() )
1152 : gtk_menu_item_new_with_label( mitem->GetText().mb_str() );
1153
1154 gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1155 GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1156 (gpointer)this );
1157#endif // GTK+ 1.2/1.0
1158 }
1159
1160 if ( !mitem->IsSeparator() )
1161 {
1162 gtk_signal_connect( GTK_OBJECT(menuItem), "select",
1163 GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
1164 (gpointer)this );
1165
1166 gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
1167 GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
1168 (gpointer)this );
1169 }
1170
1171#if !GTK_CHECK_VERSION(1, 2, 0)
1172 if (!appended)
1173 {
1174 gtk_menu_append( GTK_MENU(m_menu), menuItem );
1175 gtk_widget_show( menuItem );
1176 }
1177#endif // GTK+ 1.0
1178
1179 mitem->SetMenuItem(menuItem);
1180
1181#if GTK_CHECK_VERSION(1, 2, 0)
1182 if ( endOfRadioGroup )
1183 {
1184 m_pathLastRadio.clear();
1185 }
1186#endif // GTK+ >= 1.2
1187
1188 return TRUE;
1189}
1190
1191bool wxMenu::DoAppend(wxMenuItem *mitem)
1192{
1193 return GtkAppend(mitem) && wxMenuBase::DoAppend(mitem);
1194}
1195
1196bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
1197{
1198 if ( !wxMenuBase::DoInsert(pos, item) )
1199 return FALSE;
1200
1201#ifdef __WXGTK12__
1202 // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
1203 // of version 1.2.6), so we first append the item and then change its
1204 // index
1205 if ( !GtkAppend(item) )
1206 return FALSE;
1207
1208 if ( m_style & wxMENU_TEAROFF )
1209 {
1210 // change the position as the first item is the tear-off marker
1211 pos++;
1212 }
1213
1214 GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
1215 gpointer data = g_list_last(menu_shell->children)->data;
1216 menu_shell->children = g_list_remove(menu_shell->children, data);
1217 menu_shell->children = g_list_insert(menu_shell->children, data, pos);
1218
1219 return TRUE;
1220#else // GTK < 1.2
1221 // this should be easy to do...
1222 wxFAIL_MSG( wxT("not implemented") );
1223
1224 return FALSE;
1225#endif // GTK 1.2/1.0
1226}
1227
1228wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
1229{
1230 if ( !wxMenuBase::DoRemove(item) )
1231 return (wxMenuItem *)NULL;
1232
1233 // TODO: this code doesn't delete the item factory item and this seems
1234 // impossible as of GTK 1.2.6.
1235 gtk_widget_destroy( item->GetMenuItem() );
1236
1237 return item;
1238}
1239
1240int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1241{
1242 wxNode *node = m_items.First();
1243 while (node)
1244 {
1245 wxMenuItem *item = (wxMenuItem*)node->Data();
1246 if (item->GetMenuItem() == menuItem)
1247 return item->GetId();
1248 node = node->Next();
1249 }
1250
1251 return wxNOT_FOUND;
1252}
1253
1254// ----------------------------------------------------------------------------
1255// helpers
1256// ----------------------------------------------------------------------------
1257
1258#if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
1259
1260static wxString GetHotKey( const wxMenuItem& item )
1261{
1262 wxString hotkey;
1263
1264 wxAcceleratorEntry *accel = item.GetAccel();
1265 if ( accel )
1266 {
1267 int flags = accel->GetFlags();
1268 if ( flags & wxACCEL_ALT )
1269 hotkey += wxT("<alt>");
1270 if ( flags & wxACCEL_CTRL )
1271 hotkey += wxT("<control>");
1272 if ( flags & wxACCEL_SHIFT )
1273 hotkey += wxT("<shift>");
1274
1275 int code = accel->GetKeyCode();
1276 switch ( code )
1277 {
1278 case WXK_F1:
1279 case WXK_F2:
1280 case WXK_F3:
1281 case WXK_F4:
1282 case WXK_F5:
1283 case WXK_F6:
1284 case WXK_F7:
1285 case WXK_F8:
1286 case WXK_F9:
1287 case WXK_F10:
1288 case WXK_F11:
1289 case WXK_F12:
1290 hotkey << wxT('F') << code - WXK_F1 + 1;
1291 break;
1292
1293 // TODO: we should use gdk_keyval_name() (a.k.a.
1294 // XKeysymToString) here as well as hardcoding the keysym
1295 // names this might be not portable
1296 case WXK_NUMPAD_INSERT:
1297 hotkey << wxT("KP_Insert" );
1298 break;
1299 case WXK_NUMPAD_DELETE:
1300 hotkey << wxT("KP_Delete" );
1301 break;
1302 case WXK_INSERT:
1303 hotkey << wxT("Insert" );
1304 break;
1305 case WXK_DELETE:
1306 hotkey << wxT("Delete" );
1307 break;
1308
1309 // if there are any other keys wxGetAccelFromString() may
1310 // return, we should process them here
1311
1312 default:
1313 if ( code < 127 )
1314 {
1315 gchar *name = gdk_keyval_name((guint)code);
1316 if ( name )
1317 {
1318 hotkey << name;
1319 break;
1320 }
1321 }
1322
1323 wxFAIL_MSG( wxT("unknown keyboard accel") );
1324 }
1325
1326 delete accel;
1327 }
1328
1329 return hotkey;
1330}
1331
1332#endif // wxUSE_ACCEL
1333
1334
1335//-----------------------------------------------------------------------------
1336// substitute for missing GtkPixmapMenuItem
1337//-----------------------------------------------------------------------------
1338
1339#ifdef USE_MENU_BITMAPS
1340
1341/*
1342 * Copyright (C) 1998, 1999, 2000 Free Software Foundation
1343 * All rights reserved.
1344 *
1345 * This file is part of the Gnome Library.
1346 *
1347 * The Gnome Library is free software; you can redistribute it and/or
1348 * modify it under the terms of the GNU Library General Public License as
1349 * published by the Free Software Foundation; either version 2 of the
1350 * License, or (at your option) any later version.
1351 *
1352 * The Gnome Library is distributed in the hope that it will be useful,
1353 * but WITHOUT ANY WARRANTY; without even the implied warranty of
1354 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1355 * Library General Public License for more details.
1356 *
1357 * You should have received a copy of the GNU Library General Public
1358 * License along with the Gnome Library; see the file COPYING.LIB. If not,
1359 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
1360 * Boston, MA 02111-1307, USA.
1361 */
1362/*
1363 @NOTATION@
1364 */
1365
1366/* Author: Dietmar Maurer <dm@vlsivie.tuwien.ac.at> */
1367
1368#include <gtk/gtkaccellabel.h>
1369#include <gtk/gtksignal.h>
1370#include <gtk/gtkmenuitem.h>
1371#include <gtk/gtkmenu.h>
1372#include <gtk/gtkcontainer.h>
1373
1374extern "C"
1375{
1376
1377static void gtk_pixmap_menu_item_class_init (GtkPixmapMenuItemClass *klass);
1378static void gtk_pixmap_menu_item_init (GtkPixmapMenuItem *menu_item);
1379static void gtk_pixmap_menu_item_draw (GtkWidget *widget,
1380 GdkRectangle *area);
1381static gint gtk_pixmap_menu_item_expose (GtkWidget *widget,
1382 GdkEventExpose *event);
1383
1384/* we must override the following functions */
1385
1386static void gtk_pixmap_menu_item_map (GtkWidget *widget);
1387static void gtk_pixmap_menu_item_size_allocate (GtkWidget *widget,
1388 GtkAllocation *allocation);
1389static void gtk_pixmap_menu_item_forall (GtkContainer *container,
1390 gboolean include_internals,
1391 GtkCallback callback,
1392 gpointer callback_data);
1393static void gtk_pixmap_menu_item_size_request (GtkWidget *widget,
1394 GtkRequisition *requisition);
1395static void gtk_pixmap_menu_item_remove (GtkContainer *container,
1396 GtkWidget *child);
1397
1398static void changed_have_pixmap_status (GtkPixmapMenuItem *menu_item);
1399
1400static GtkMenuItemClass *parent_class = NULL;
1401
1402}
1403
1404#define BORDER_SPACING 3
1405#define PMAP_WIDTH 20
1406
1407GtkType
1408gtk_pixmap_menu_item_get_type (void)
1409{
1410 static GtkType pixmap_menu_item_type = 0;
1411
1412 if (!pixmap_menu_item_type)
1413 {
1414 GtkTypeInfo pixmap_menu_item_info =
1415 {
1416 (char *)"GtkPixmapMenuItem",
1417 sizeof (GtkPixmapMenuItem),
1418 sizeof (GtkPixmapMenuItemClass),
1419 (GtkClassInitFunc) gtk_pixmap_menu_item_class_init,
1420 (GtkObjectInitFunc) gtk_pixmap_menu_item_init,
1421 /* reserved_1 */ NULL,
1422 /* reserved_2 */ NULL,
1423 (GtkClassInitFunc) NULL,
1424 };
1425
1426 pixmap_menu_item_type = gtk_type_unique (gtk_menu_item_get_type (),
1427 &pixmap_menu_item_info);
1428 }
1429
1430 return pixmap_menu_item_type;
1431}
1432
1433/**
1434 * gtk_pixmap_menu_item_new
1435 *
1436 * Creates a new pixmap menu item. Use gtk_pixmap_menu_item_set_pixmap()
1437 * to set the pixmap wich is displayed at the left side.
1438 *
1439 * Returns:
1440 * &GtkWidget pointer to new menu item
1441 **/
1442
1443GtkWidget*
1444gtk_pixmap_menu_item_new (void)
1445{
1446 return GTK_WIDGET (gtk_type_new (gtk_pixmap_menu_item_get_type ()));
1447}
1448
1449static void
1450gtk_pixmap_menu_item_class_init (GtkPixmapMenuItemClass *klass)
1451{
1452 GtkObjectClass *object_class;
1453 GtkWidgetClass *widget_class;
1454 GtkMenuItemClass *menu_item_class;
1455 GtkContainerClass *container_class;
1456
1457 object_class = (GtkObjectClass*) klass;
1458 widget_class = (GtkWidgetClass*) klass;
1459 menu_item_class = (GtkMenuItemClass*) klass;
1460 container_class = (GtkContainerClass*) klass;
1461
1462 parent_class = (GtkMenuItemClass*) gtk_type_class (gtk_menu_item_get_type ());
1463
1464 widget_class->draw = gtk_pixmap_menu_item_draw;
1465 widget_class->expose_event = gtk_pixmap_menu_item_expose;
1466 widget_class->map = gtk_pixmap_menu_item_map;
1467 widget_class->size_allocate = gtk_pixmap_menu_item_size_allocate;
1468 widget_class->size_request = gtk_pixmap_menu_item_size_request;
1469
1470 container_class->forall = gtk_pixmap_menu_item_forall;
1471 container_class->remove = gtk_pixmap_menu_item_remove;
1472
1473 klass->orig_toggle_size = menu_item_class->toggle_size;
1474 klass->have_pixmap_count = 0;
1475}
1476
1477static void
1478gtk_pixmap_menu_item_init (GtkPixmapMenuItem *menu_item)
1479{
1480 GtkMenuItem *mi;
1481
1482 mi = GTK_MENU_ITEM (menu_item);
1483
1484 menu_item->pixmap = NULL;
1485}
1486
1487static void
1488gtk_pixmap_menu_item_draw (GtkWidget *widget,
1489 GdkRectangle *area)
1490{
1491 g_return_if_fail (widget != NULL);
1492 g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1493 g_return_if_fail (area != NULL);
1494
1495 if (GTK_WIDGET_CLASS (parent_class)->draw)
1496 (* GTK_WIDGET_CLASS (parent_class)->draw) (widget, area);
1497
1498 if (GTK_WIDGET_DRAWABLE (widget) &&
1499 GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1500 gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1501 }
1502}
1503
1504static gint
1505gtk_pixmap_menu_item_expose (GtkWidget *widget,
1506 GdkEventExpose *event)
1507{
1508 g_return_val_if_fail (widget != NULL, FALSE);
1509 g_return_val_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget), FALSE);
1510 g_return_val_if_fail (event != NULL, FALSE);
1511
1512 if (GTK_WIDGET_CLASS (parent_class)->expose_event)
1513 (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
1514
1515 if (GTK_WIDGET_DRAWABLE (widget) &&
1516 GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1517 gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1518 }
1519
1520 return FALSE;
1521}
1522
1523/**
1524 * gtk_pixmap_menu_item_set_pixmap
1525 * @menu_item: Pointer to the pixmap menu item
1526 * @pixmap: Pointer to a pixmap widget
1527 *
1528 * Set the pixmap of the menu item.
1529 *
1530 **/
1531
1532void
1533gtk_pixmap_menu_item_set_pixmap (GtkPixmapMenuItem *menu_item,
1534 GtkWidget *pixmap)
1535{
1536 g_return_if_fail (menu_item != NULL);
1537 g_return_if_fail (pixmap != NULL);
1538 g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (menu_item));
1539 g_return_if_fail (GTK_IS_WIDGET (pixmap));
1540 g_return_if_fail (menu_item->pixmap == NULL);
1541
1542 gtk_widget_set_parent (pixmap, GTK_WIDGET (menu_item));
1543 menu_item->pixmap = pixmap;
1544
1545 if (GTK_WIDGET_REALIZED (pixmap->parent) &&
1546 !GTK_WIDGET_REALIZED (pixmap))
1547 gtk_widget_realize (pixmap);
1548
1549 if (GTK_WIDGET_VISIBLE (pixmap->parent)) {
1550 if (GTK_WIDGET_MAPPED (pixmap->parent) &&
1551 GTK_WIDGET_VISIBLE(pixmap) &&
1552 !GTK_WIDGET_MAPPED (pixmap))
1553 gtk_widget_map (pixmap);
1554 }
1555
1556 changed_have_pixmap_status(menu_item);
1557
1558 if (GTK_WIDGET_VISIBLE (pixmap) && GTK_WIDGET_VISIBLE (menu_item))
1559 gtk_widget_queue_resize (pixmap);
1560}
1561
1562static void
1563gtk_pixmap_menu_item_map (GtkWidget *widget)
1564{
1565 GtkPixmapMenuItem *menu_item;
1566
1567 g_return_if_fail (widget != NULL);
1568 g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1569
1570 menu_item = GTK_PIXMAP_MENU_ITEM(widget);
1571
1572 GTK_WIDGET_CLASS(parent_class)->map(widget);
1573
1574 if (menu_item->pixmap &&
1575 GTK_WIDGET_VISIBLE (menu_item->pixmap) &&
1576 !GTK_WIDGET_MAPPED (menu_item->pixmap))
1577 gtk_widget_map (menu_item->pixmap);
1578}
1579
1580static void
1581gtk_pixmap_menu_item_size_allocate (GtkWidget *widget,
1582 GtkAllocation *allocation)
1583{
1584 GtkPixmapMenuItem *pmenu_item;
1585
1586 pmenu_item = GTK_PIXMAP_MENU_ITEM(widget);
1587
1588 if (pmenu_item->pixmap && GTK_WIDGET_VISIBLE(pmenu_item))
1589 {
1590 GtkAllocation child_allocation;
1591 int border_width;
1592
1593 border_width = GTK_CONTAINER (widget)->border_width;
1594
1595 child_allocation.width = pmenu_item->pixmap->requisition.width;
1596 child_allocation.height = pmenu_item->pixmap->requisition.height;
1597 child_allocation.x = border_width + BORDER_SPACING;
1598 child_allocation.y = (border_width + BORDER_SPACING
1599 + (((allocation->height - child_allocation.height) - child_allocation.x)
1600 / 2)); /* center pixmaps vertically */
1601 gtk_widget_size_allocate (pmenu_item->pixmap, &child_allocation);
1602 }
1603
1604 if (GTK_WIDGET_CLASS (parent_class)->size_allocate)
1605 GTK_WIDGET_CLASS(parent_class)->size_allocate (widget, allocation);
1606}
1607
1608static void
1609gtk_pixmap_menu_item_forall (GtkContainer *container,
1610 gboolean include_internals,
1611 GtkCallback callback,
1612 gpointer callback_data)
1613{
1614 GtkPixmapMenuItem *menu_item;
1615
1616 g_return_if_fail (container != NULL);
1617 g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1618 g_return_if_fail (callback != NULL);
1619
1620 menu_item = GTK_PIXMAP_MENU_ITEM (container);
1621
1622 if (menu_item->pixmap)
1623 (* callback) (menu_item->pixmap, callback_data);
1624
1625 GTK_CONTAINER_CLASS(parent_class)->forall(container,include_internals,
1626 callback,callback_data);
1627}
1628
1629static void
1630gtk_pixmap_menu_item_size_request (GtkWidget *widget,
1631 GtkRequisition *requisition)
1632{
1633 GtkPixmapMenuItem *menu_item;
1634 GtkRequisition req = {0, 0};
1635
1636 g_return_if_fail (widget != NULL);
1637 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1638 g_return_if_fail (requisition != NULL);
1639
1640 GTK_WIDGET_CLASS(parent_class)->size_request(widget,requisition);
1641
1642 menu_item = GTK_PIXMAP_MENU_ITEM (widget);
1643
1644 if (menu_item->pixmap)
1645 gtk_widget_size_request(menu_item->pixmap, &req);
1646
1647 requisition->height = MAX(req.height + GTK_CONTAINER(widget)->border_width + BORDER_SPACING, (unsigned int) requisition->height);
1648 requisition->width += (req.width + GTK_CONTAINER(widget)->border_width + BORDER_SPACING);
1649}
1650
1651static void
1652gtk_pixmap_menu_item_remove (GtkContainer *container,
1653 GtkWidget *child)
1654{
1655 GtkBin *bin;
1656 gboolean widget_was_visible;
1657
1658 g_return_if_fail (container != NULL);
1659 g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1660 g_return_if_fail (child != NULL);
1661 g_return_if_fail (GTK_IS_WIDGET (child));
1662
1663 bin = GTK_BIN (container);
1664 g_return_if_fail ((bin->child == child ||
1665 (GTK_PIXMAP_MENU_ITEM(container)->pixmap == child)));
1666
1667 widget_was_visible = GTK_WIDGET_VISIBLE (child);
1668
1669 gtk_widget_unparent (child);
1670 if (bin->child == child)
1671 bin->child = NULL;
1672 else {
1673 GTK_PIXMAP_MENU_ITEM(container)->pixmap = NULL;
1674 changed_have_pixmap_status(GTK_PIXMAP_MENU_ITEM(container));
1675 }
1676
1677 if (widget_was_visible)
1678 gtk_widget_queue_resize (GTK_WIDGET (container));
1679}
1680
1681
1682/* important to only call this if there was actually a _change_ in pixmap == NULL */
1683static void
1684changed_have_pixmap_status (GtkPixmapMenuItem *menu_item)
1685{
1686 if (menu_item->pixmap != NULL) {
1687 GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count += 1;
1688
1689 if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 1) {
1690 /* Install pixmap toggle size */
1691 GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = MAX(GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size, PMAP_WIDTH);
1692 }
1693 } else {
1694 GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count -= 1;
1695
1696 if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 0) {
1697 /* Install normal toggle size */
1698 GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size;
1699 }
1700 }
1701
1702 /* Note that we actually need to do this for _all_ GtkPixmapMenuItem
1703 whenever the klass->toggle_size changes; but by doing it anytime
1704 this function is called, we get the same effect, just because of
1705 how the preferences option to show pixmaps works. Bogus, broken.
1706 */
1707 if (GTK_WIDGET_VISIBLE(GTK_WIDGET(menu_item)))
1708 gtk_widget_queue_resize(GTK_WIDGET(menu_item));
1709}
1710
1711#endif // USE_MENU_BITMAPS
1712
wxWidgets (Impactor)