Gtk+ stock tool bar icons

Gtk+ stock tool bar icons

[Reiner Steib]

Hi,

Emacs trunk and EMACS_22_BASE (=> Emacs 22.2) now have:

,----[ NEWS ]
| * Changes in Emacs 22.2
| 
| ** The Gtk+ build now uses stock tool bar icons, so that a theme change
| is visible in Emacs tool bar.
`----

Up to now (AFAIK [1]), only the default Emacs tool bar has been
updated completely [2].  So for other modes, the user will get a
mixture of themed and un-themed icons (e.g. Info, Gnus, Message,
probably also MH-E).  Here are some screen shots from CVS trunk
(including my attempt to add mappings for Gnus icons to
`x-gtk-stock-map' [3]).

I'm not sure if its a good idea to enable the GTK stock mapping in
EMACS_22_BASE by default if we plan to release Emacs 22.2 soon.
What is better:

(a) A consistent icons style within Emacs (like in Emacs 22.1)

or

(b) Consistent icons between the (Gnome) desktop environment and parts
    of (GTK-) Emacs and inconsistent icons within several tool bars in
    Emacs.  See the screen shots on [4].

Some related questions:

- Is (setq x-gtk-stock-map nil) the recommended way to disable themed
  icons?  Shouldn't we provide this as a custom option (also in Emacs
  trunk) and mention it in NEWS?  (BTW, the custom version should read
  22.2 if we keep it in EMACS_22_BASE, shouldn't it?)

- Is my patch [3] correct?

- For Gnus, we have at least two icons where no corresponding
  Gnome/GTK icon was (is) available.  How can we should we deal with
  this?  (Probably the same is relevant for prev-node, next-node and
  up-node?)

  mail/preview.xpm (combining stock_mail and stock_zoom)
  mail/save.xpm    (combining stock_mail, stock_save and stock_convert)

- How is possible to try different icon styles for non-Gnome user?

Bye, Reiner.

[1] Maybe I missed some discussion on emacs-devel as I was on vacation.

[2] Info mode is only partially updated.  Previous, Next and Up node
    have un-themed icons.

[3]
--8<---------------cut here---------------start------------->8---
--- x-win.el	23 Sep 2007 18:33:46 +0200	1.210
+++ x-win.el	29 Sep 2007 15:18:32 +0200	
@@ -2587,7 +2587,43 @@
     ("etc/images/jump-to" . "gtk-jump-to")
     ("etc/images/index" . "gtk-index")
     ("etc/images/search" . "gtk-find")
-    ("etc/images/exit" . "gtk-quit"))
+    ("etc/images/exit" . "gtk-quit")
+    ;; Used in MH-E and/or Gnus:
+    ("etc/images/attach.xpm" . "gtk-attach")
+    ("etc/images/connect.xpm" . "gtk-connect")
+    ("etc/images/contact.xpm" . "gtk-contact")
+    ("etc/images/delete.xpm" . "gtk-delete")
+    ("etc/images/describe.xpm" . "gtk-properties")
+    ("etc/images/disconnect.xpm" . "gtk-disconnect")
+    ;; ("etc/images/exit.xpm" . "gtk-exit")
+    ("etc/images/lock-broken.xpm" . "gtk-lock_broken")
+    ("etc/images/lock-ok.xpm" . "gtk-lock_ok")
+    ("etc/images/lock.xpm" . "gtk-lock")
+    ("etc/images/next-page.xpm" . "gtk-next-page")
+    ("etc/images/refresh.xpm" . "gtk-refresh")
+    ("etc/images/sort-ascending.xpm" . "gtk-sort-ascending")
+    ("etc/images/sort-column-ascending.xpm" . "gtk-sort-column-ascending")
+    ("etc/images/sort-criteria.xpm" . "gtk-sort-criteria")
+    ("etc/images/sort-descending.xpm" . "gtk-sort-descending")
+    ("etc/images/sort-row-ascending.xpm" . "gtk-sort-row-ascending")
+    ("etc/images/gnus/toggle-subscription.xpm" . "gtk-task-recurring")
+    ("etc/images/mail/compose.xpm" . "gtk-mail-compose")
+    ("etc/images/mail/copy.xpm" . "gtk-mail-copy")
+    ("etc/images/mail/forward.xpm" . "gtk-mail-forward")
+    ("etc/images/mail/inbox.xpm" . "gtk-inbox")
+    ("etc/images/mail/move.xpm" . "gtk-mail-move")
+    ("etc/images/mail/not-spam.xpm" . "gtk-not-spam")
+    ("etc/images/mail/outbox.xpm" . "gtk-outbox")
+    ("etc/images/mail/reply-all.xpm" . "gtk-mail-reply-to-all")
+    ("etc/images/mail/reply.xpm" . "gtk-mail-reply")
+    ("etc/images/mail/save-draft.xpm" . "gtk-mail-handling")
+    ("etc/images/mail/send.xpm" . "gtk-mail-send")
+    ("etc/images/mail/spam.xpm" . "gtk-spam")
+    ;; No themed versions available:
+    ;; mail/preview.xpm (combining stock_mail and stock_zoom)
+    ;; mail/save.xpm    (combining stock_mail, stock_save and stock_convert)
+    ;;
+    )
   "How icons for tool bars are mapped to Gtk+ stock items.
 Emacs must be compiled with the Gtk+ toolkit for this to have any effect.
 A value that begins with n: denotes a named icon instead of a stock icon."
--8<---------------cut here---------------end--------------->8---

[4] Screen shots of Gnus on openSUSE 10.2 using fluxbox: 
<http://theotp1.physik.uni-ulm.de/~ste/comp/emacs/gnus/tool-bar/gtk-stock-map/>

$ rpm -qa|grep -Ee '-icon|-theme'|sort
gnome-icon-theme-2.16.0.1-12
gnome-themes-2.16.1.1-21
gtk2-themes-0.1-671
tango-icon-theme-0.7.2-36
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Gtk+ stock tool bar icons

[Jan Djärv]

Reiner Steib skrev:
> Hi,

Hi.

> What is better:
> 
> (a) A consistent icons style within Emacs (like in Emacs 22.1)
> 
> or
> 
> (b) Consistent icons between the (Gnome) desktop environment and parts
>     of (GTK-) Emacs and inconsistent icons within several tool bars in
>     Emacs.  See the screen shots on [4].
> 

I prefer (b), but then I am often a Gnome user.  An occational icon that isn't 
from the proper theme happens with other Gnome applications as well, depending 
on the theme used.

> Some related questions:
> 
> - Is (setq x-gtk-stock-map nil) the recommended way to disable themed
>   icons?  Shouldn't we provide this as a custom option (also in Emacs
>   trunk) and mention it in NEWS?  (BTW, the custom version should read
>   22.2 if we keep it in EMACS_22_BASE, shouldn't it?)

The custom version should indeed be 22.2, I've fixed that.  If you think we 
need another customize option to disable this, please feel free to add it.

> 
> - Is my patch [3] correct?

No, the files should be "images/mail/...".

> 
> - For Gnus, we have at least two icons where no corresponding
>   Gnome/GTK icon was (is) available.  How can we should we deal with
>   this?  (Probably the same is relevant for prev-node, next-node and
>   up-node?)
> 
>   mail/preview.xpm (combining stock_mail and stock_zoom)
>   mail/save.xpm    (combining stock_mail, stock_save and stock_convert)

There will always be icons that don't correspond to stock or theme icons. 
There are themes out there that don't have a complete set of icons for all 
purposes also.

> 
> - How is possible to try different icon styles for non-Gnome user?

AFAIK, it isn't.

	Jan D.

> 
> Bye, Reiner.
> 
> [1] Maybe I missed some discussion on emacs-devel as I was on vacation.
> 
> [2] Info mode is only partially updated.  Previous, Next and Up node
>     have un-themed icons.
> 
> [3]
> --8<---------------cut here---------------start------------->8---
> --- x-win.el	23 Sep 2007 18:33:46 +0200	1.210
> +++ x-win.el	29 Sep 2007 15:18:32 +0200	
> @@ -2587,7 +2587,43 @@
>      ("etc/images/jump-to" . "gtk-jump-to")
>      ("etc/images/index" . "gtk-index")
>      ("etc/images/search" . "gtk-find")
> -    ("etc/images/exit" . "gtk-quit"))
> +    ("etc/images/exit" . "gtk-quit")
> +    ;; Used in MH-E and/or Gnus:
> +    ("etc/images/attach.xpm" . "gtk-attach")
> +    ("etc/images/connect.xpm" . "gtk-connect")
> +    ("etc/images/contact.xpm" . "gtk-contact")
> +    ("etc/images/delete.xpm" . "gtk-delete")
> +    ("etc/images/describe.xpm" . "gtk-properties")
> +    ("etc/images/disconnect.xpm" . "gtk-disconnect")
> +    ;; ("etc/images/exit.xpm" . "gtk-exit")
> +    ("etc/images/lock-broken.xpm" . "gtk-lock_broken")
> +    ("etc/images/lock-ok.xpm" . "gtk-lock_ok")
> +    ("etc/images/lock.xpm" . "gtk-lock")
> +    ("etc/images/next-page.xpm" . "gtk-next-page")
> +    ("etc/images/refresh.xpm" . "gtk-refresh")
> +    ("etc/images/sort-ascending.xpm" . "gtk-sort-ascending")
> +    ("etc/images/sort-column-ascending.xpm" . "gtk-sort-column-ascending")
> +    ("etc/images/sort-criteria.xpm" . "gtk-sort-criteria")
> +    ("etc/images/sort-descending.xpm" . "gtk-sort-descending")
> +    ("etc/images/sort-row-ascending.xpm" . "gtk-sort-row-ascending")
> +    ("etc/images/gnus/toggle-subscription.xpm" . "gtk-task-recurring")
> +    ("etc/images/mail/compose.xpm" . "gtk-mail-compose")
> +    ("etc/images/mail/copy.xpm" . "gtk-mail-copy")
> +    ("etc/images/mail/forward.xpm" . "gtk-mail-forward")
> +    ("etc/images/mail/inbox.xpm" . "gtk-inbox")
> +    ("etc/images/mail/move.xpm" . "gtk-mail-move")
> +    ("etc/images/mail/not-spam.xpm" . "gtk-not-spam")
> +    ("etc/images/mail/outbox.xpm" . "gtk-outbox")
> +    ("etc/images/mail/reply-all.xpm" . "gtk-mail-reply-to-all")
> +    ("etc/images/mail/reply.xpm" . "gtk-mail-reply")
> +    ("etc/images/mail/save-draft.xpm" . "gtk-mail-handling")
> +    ("etc/images/mail/send.xpm" . "gtk-mail-send")
> +    ("etc/images/mail/spam.xpm" . "gtk-spam")
> +    ;; No themed versions available:
> +    ;; mail/preview.xpm (combining stock_mail and stock_zoom)
> +    ;; mail/save.xpm    (combining stock_mail, stock_save and stock_convert)
> +    ;;
> +    )
>    "How icons for tool bars are mapped to Gtk+ stock items.
>  Emacs must be compiled with the Gtk+ toolkit for this to have any effect.
>  A value that begins with n: denotes a named icon instead of a stock icon."
> --8<---------------cut here---------------end--------------->8---
> 
> [4] Screen shots of Gnus on openSUSE 10.2 using fluxbox: 
> <http://theotp1.physik.uni-ulm.de/~ste/comp/emacs/gnus/tool-bar/gtk-stock-map/>
> 
> $ rpm -qa|grep -Ee '-icon|-theme'|sort
> gnome-icon-theme-2.16.0.1-12
> gnome-themes-2.16.1.1-21
> gtk2-themes-0.1-671
> tango-icon-theme-0.7.2-36

Re: Gtk+ stock tool bar icons

[Reiner Steib]

On Sat, Sep 29 2007, Jan Djärv wrote:

> Reiner Steib skrev:
>> - Is (setq x-gtk-stock-map nil) the recommended way to disable themed
>>   icons?  Shouldn't we provide this as a custom option (also in Emacs
>>   trunk) and mention it in NEWS?  (BTW, the custom version should read
>>   22.2 if we keep it in EMACS_22_BASE, shouldn't it?)
>
> The custom version should indeed be 22.2, I've fixed that.  If you think we
> need another customize option to disable this, please feel free to add it.

On a second thought: Maybe `icon-map-list' seems more suitable to
disable it.  How about making it `icon-map-list' customizable and
improving the custom type of `x-gtk-stock-map' as follows?

--8<---------------cut here---------------start------------->8---
--- x-win.el	29 Sep 2007 16:23:59 -0000	1.211
+++ x-win.el	29 Sep 2007 19:48:04 -0000
@@ -2592,11 +2592,14 @@
 Emacs must be compiled with the Gtk+ toolkit for this to have any effect.
 A value that begins with n: denotes a named icon instead of a stock icon."
   :version "22.2"
-  :type 'alist
+  :type '(choice (repeat (choice symbol
+				 (cons (string :tag "Emacs icon")
+				       (regexp :tag "Stock/named")))))
+
   :group 'x)
 
-(defvar icon-map-list '(x-gtk-stock-map)
-  "*A list of alists that maps icon file names to stock/named icons.
+(defcustom icon-map-list '(x-gtk-stock-map)
+  "A list of alists that maps icon file names to stock/named icons.
 The alists are searched in the order they appear.  The first match is used.
 The keys in the alists are file names without extension and with two directory
 components.  For example, to map /usr/share/emacs/22.1.1/etc/images/open.xpm
@@ -2608,7 +2611,14 @@
 
   (\"etc/images/diropen\" . \"n:system-file-manager\")
 
-The list elements are either the symbol name for the alist or the alist itself.")
+The list elements are either the symbol name for the alist or the
+alist itself."
+  :version "22.2"
+  :type '(choice (const :tag "Don't use stock icons" nil)
+		 (repeat (choice symbol
+				 (cons (string :tag "Emacs icon")
+				       (regexp :tag "Stock/named")))))
+  :group 'x)
 
 (defun x-gtk-map-stock (file)
   "Map icon with file name FILE to a Gtk+ stock name, using `x-gtk-stock-map'."
--8<---------------cut here---------------end--------------->8---


>> - Is my patch [3] correct?
>
> No, the files should be "images/mail/...".

Are you saying without "etc/"?  I did it exactly like the present
elements:

     ("etc/images/search" . "gtk-find")
-    ("etc/images/exit" . "gtk-quit"))
+    ("etc/images/exit" . "gtk-quit")
+    ;; Used in MH-E and/or Gnus:
+    ("etc/images/attach.xpm" . "gtk-attach")
+    ("etc/images/connect.xpm" . "gtk-connect")

BTW, wouldn't it be better to strip "etc/images/" in the icon names
for consistency with the specification of the icons e.g. in
`tool-bar-add-item-from-menu' (cf. `image-load-path')?

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Gtk+ stock tool bar icons

[Richard Stallman]

    I'm not sure if its a good idea to enable the GTK stock mapping in
    EMACS_22_BASE by default if we plan to release Emacs 22.2 soon.
    What is better:

    (a) A consistent icons style within Emacs (like in Emacs 22.1)

For Emacs 22.2, let's not change this.

Re: Gtk+ stock tool bar icons

[Jan Djärv]

Reiner Steib skrev:
> On Sat, Sep 29 2007, Jan Djärv wrote:
> 
>> Reiner Steib skrev:
>>> - Is (setq x-gtk-stock-map nil) the recommended way to disable themed
>>>   icons?  Shouldn't we provide this as a custom option (also in Emacs
>>>   trunk) and mention it in NEWS?  (BTW, the custom version should read
>>>   22.2 if we keep it in EMACS_22_BASE, shouldn't it?)
>> The custom version should indeed be 22.2, I've fixed that.  If you think we
>> need another customize option to disable this, please feel free to add it.
> 
> On a second thought: Maybe `icon-map-list' seems more suitable to
> disable it.  How about making it `icon-map-list' customizable and
> improving the custom type of `x-gtk-stock-map' as follows?

Ok with me.



> 
>>> - Is my patch [3] correct?
>> No, the files should be "images/mail/...".
> 
> Are you saying without "etc/"?  I did it exactly like the present
> elements:

Yes I know.  But the document string says "file names without extension and 
with two directory components".  The reason for this is to avoid having to 
search the image path first and then do the translation.  Also, two is enough 
to distinguish the default setup.


> 
>      ("etc/images/search" . "gtk-find")
> -    ("etc/images/exit" . "gtk-quit"))
> +    ("etc/images/exit" . "gtk-quit")
> +    ;; Used in MH-E and/or Gnus:
> +    ("etc/images/attach.xpm" . "gtk-attach")
> +    ("etc/images/connect.xpm" . "gtk-connect")
> 
> BTW, wouldn't it be better to strip "etc/images/" in the icon names
> for consistency with the specification of the icons e.g. in
> `tool-bar-add-item-from-menu' (cf. `image-load-path')?
> 

I guess that would work also.  I'll fix that.

	Jan D.

Re: Gtk+ stock tool bar icons

[Jan Djärv]

Richard Stallman skrev:
>     I'm not sure if its a good idea to enable the GTK stock mapping in
>     EMACS_22_BASE by default if we plan to release Emacs 22.2 soon.
>     What is better:
> 
>     (a) A consistent icons style within Emacs (like in Emacs 22.1)
> 
> For Emacs 22.2, let's not change this.

Let's not change what?  Let's not change what is already checked in for 22.2 
or let's not change this so it differs from 22.1?

	Jan D.

Re: Gtk+ stock tool bar icons

[Reiner Steib]

On Sun, Sep 30 2007, Jan Djärv wrote:

> Richard Stallman skrev:
>>     I'm not sure if its a good idea to enable the GTK stock mapping in
>>     EMACS_22_BASE by default if we plan to release Emacs 22.2 soon.
>>     What is better:
>>
>>     (a) A consistent icons style within Emacs (like in Emacs 22.1)
>>
>> For Emacs 22.2, let's not change this.
>
> Let's not change what?  Let's not change what is already checked in for 22.2
> or let's not change this so it differs from 22.1?

I'd suggest to modify EMACS_22_BASE to achieve...
>>     (a) A consistent icons style within Emacs (like in Emacs 22.1)
... as follows:

Add/keep the relevant code as well (I assume these changes are safe
enough for Emacs 22.2), but change the default of `icon-map-list' to
nil.  Users who prefer...
>> (b) Consistent icons between the (Gnome) desktop environment and parts
>>     of (GTK-) Emacs [...]
... can customize it to include `x-gtk-stock-map'.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Gtk+ stock tool bar icons

[Reiner Steib]

On Sun, Sep 30 2007, Jan Djärv wrote:

> Reiner Steib skrev:
>> On a second thought: Maybe `icon-map-list' seems more suitable to
>> disable it.  How about making it `icon-map-list' customizable and
>> improving the custom type of `x-gtk-stock-map' as follows?
>
> Ok with me.

I have committed the following changes (only in the trunk yet):

	* term/x-win.el (x-gtk-stock-map): Add Gnus and MH-E icons.
	Improve custom type.
	(icon-map-list): Make it customizable.  Document how to disable
	stock icons.

Please take a look if and correct if necessary.  Thanks.

>>>> - Is my patch [3] correct?
>>> No, the files should be "images/mail/...".
>>
>> Are you saying without "etc/"?  I did it exactly like the present
>> elements:
>
> Yes I know.  But the document string says "file names without extension and
> with two directory components".  

Ah, it's only in the doc string of `icon-map-list' and not
`x-gtk-stock-map'.  To avoid duplication of the description, shouldn't
we describe the format in detail only in the doc string of
`icon-map-list' and refer to it in the doc string of
`x-gtk-stock-map'?

FWIW, removing "etc/" doesn't improve the Gnus tool bars for me.

> The reason for this is to avoid having to search the image path
> first and then do the translation.  Also, two is enough to
> distinguish the default setup.

So it's more or less an implementation detail?  For a user variable,
it would be nicer to make it consistent with
`tool-bar-add-item-from-menu' etc., I think.

>> BTW, wouldn't it be better to strip "etc/images/" in the icon names
>> for consistency with the specification of the icons e.g. in
>> `tool-bar-add-item-from-menu' (cf. `image-load-path')?
>
> I guess that would work also.  I'll fix that.

Thanks.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Gtk+ stock tool bar icons

[Richard Stallman]

    >     (a) A consistent icons style within Emacs (like in Emacs 22.1)
    > 
    > For Emacs 22.2, let's not change this.

    Let's not change what?  Let's not change what is already checked in for 22.2 
    or let's not change this so it differs from 22.1?

Let's not change it from Emacs 22.1, at least not by default.

I would also prefer not to install the source changes for stock icons
into Emacs 22.2 unless they are very simple.
The goal for 22.2 is to fix the bugs and release it
soon.