xresources.texi 29 KB
Newer Older
1
@c This is part of the Emacs manual.
2 3
@c Copyright (C) 1987, 1993-1995, 1997, 2001-2013 Free Software
@c Foundation, Inc.
4
@c See file emacs.texi for copying conditions.
5
@node X Resources
6
@appendix X Options and Resources
7

8
  You can customize some X-related aspects of Emacs behavior using X
9 10 11 12 13
resources, as is usual for programs that use X.

  When Emacs is compiled with GTK+ support, the appearance of various
graphical widgets, such as the menu-bar, scroll-bar, and dialog boxes,
is determined by
Jan Djärv's avatar
Jan Djärv committed
14 15 16 17
@ifnottex
``GTK resources'', which we will also describe.
@end ifnottex
@iftex
18
``GTK resources''.
Jan Djärv's avatar
Jan Djärv committed
19
@end iftex
20 21
When Emacs is built without GTK+ support, the appearance of these
widgets is determined by additional X resources.
Jan Djärv's avatar
Jan Djärv committed
22

23 24
  On MS-Windows, you can customize some of the same aspects using the
system registry (@pxref{MS-Windows Registry}).
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26

@menu
27 28
* Resources::           Using X resources with Emacs (in general).
* Table of Resources::  Table of specific X resources that affect Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
29 30
* Lucid Resources::     X resources for Lucid menus.
* LessTif Resources::   X resources for LessTif and Motif menus.
Jan Djärv's avatar
Jan Djärv committed
31
* GTK resources::       Resources for GTK widgets.
Richard M. Stallman's avatar
Richard M. Stallman committed
32 33
@end menu

34
@node Resources
35 36
@appendixsec X Resources
@cindex resources
37 38 39
@cindex X resources
@cindex @file{~/.Xdefaults} file
@cindex @file{~/.Xresources} file
40

41 42
  Programs running under the X Window System organize their user
options under a hierarchy of classes and resources.  You can specify
43 44 45 46 47
default values for these options in your @dfn{X resource file},
usually named @file{~/.Xdefaults} or @file{~/.Xresources}.  Changes in
this file do not take effect immediately, because the X server stores
its own list of resources; to update it, use the command
@command{xrdb}---for instance, @samp{xrdb ~/.Xdefaults}.
48

49
@cindex registry, setting resources (MS-Windows)
50
  (MS-Windows systems do not support X resource files; on such systems,
51
Emacs looks for X resources in the Windows Registry, first under the
52 53 54 55 56 57 58
key @samp{HKEY_CURRENT_USER\SOFTWARE\GNU\Emacs}, which affects only
the current user and override the system-wide settings, and then under
the key @samp{HKEY_LOCAL_MACHINE\SOFTWARE\GNU\Emacs}, which affects
all users of the system.  The menu and scroll bars are native widgets
on MS-Windows, so they are only customizable via the system-wide
settings in the Display Control Panel.  You can also set resources
using the @samp{-xrm} command line option, as explained below.)
59

60
  Each line in the X resource file specifies a value for one option or
61 62
for a collection of related options.  The order in which the lines
appear in the file does not matter.  Each resource specification
63 64 65
consists of a @dfn{program name} and a @dfn{resource name}.  Case
distinctions are significant in each of these names.  Here is an
example:
66 67

@example
68
emacs.cursorColor: dark green
69 70
@end example

71 72 73 74 75 76
  The program name is the name of the executable file to which the
resource applies.  For Emacs, this is normally @samp{emacs}.  To
specify a definition that applies to all instances of Emacs,
regardless of the name of the Emacs executable, use @samp{Emacs}.

  The resource name is the name of a program setting.  For instance,
77 78
Emacs recognizes a @samp{cursorColor} resource that controls the color
of the text cursor.
79 80

  Resources are grouped into named classes.  For instance, the
81 82 83 84 85
@samp{Foreground} class contains the @samp{cursorColor},
@samp{foreground} and @samp{pointerColor} resources (@pxref{Table of
Resources}).  Instead of using a resource name, you can use a class
name to specify the default value for all resources in that class,
like this:
86 87

@example
88
emacs.Foreground: dark green
89
@end example
90 91

  Emacs does not process X resources at all if you set the variable
92 93 94 95
@code{inhibit-x-resources} to a non-@code{nil} value.  If you invoke
Emacs with the @samp{-Q} (or @samp{--quick}) command-line option,
@code{inhibit-x-resources} is automatically set to @code{t}
(@pxref{Initial Options}).
Jan Djärv's avatar
Jan Djärv committed
96 97

@ifnottex
98 99
  In addition, you can use the following command-line options to
override the X resources file:
100 101 102 103 104 105

@table @samp
@item -name @var{name}
@opindex --name
@itemx --name=@var{name}
@cindex resource name, command-line argument
106 107 108
This option sets the program name of the initial Emacs frame to
@var{name}.  It also sets the title of the initial frame to
@var{name}.  This option does not affect subsequent frames.
109 110

If you don't specify this option, the default is to use the Emacs
111 112 113 114 115 116 117 118 119 120
executable's name as the program name.

For consistency, @samp{-name} also specifies the name to use for other
resource values that do not belong to any particular frame.

The resources that name Emacs invocations also belong to a class,
named @samp{Emacs}.  If you write @samp{Emacs} instead of
@samp{emacs}, the resource applies to all frames in all Emacs jobs,
regardless of frame titles and regardless of the name of the
executable file.
121 122 123 124 125

@item -xrm @var{resource-values}
@opindex --xrm
@itemx --xrm=@var{resource-values}
@cindex resource values, command-line argument
126 127 128 129 130 131 132 133 134
This option specifies X resource values for the present Emacs job.

@var{resource-values} should have the same format that you would use
inside a file of X resources.  To include multiple resource
specifications in @var{resource-values}, put a newline between them,
just as you would in a file.  You can also use @samp{#include
"@var{filename}"} to include a file full of resource specifications.
Resource values specified with @samp{-xrm} take precedence over all
other resource specifications.
135
@end table
136
@end ifnottex
137

138 139 140
@node Table of Resources
@appendixsec Table of X Resources for Emacs

141 142 143
  This table lists the X resource names that Emacs recognizes,
excluding those that control the appearance of graphical widgets like
the menu bar:
144 145 146

@table @asis
@item @code{background} (class @code{Background})
147
Background color (@pxref{Colors}).
148 149

@item @code{bitmapIcon} (class @code{BitmapIcon})
150
Tell the window manager to display the Emacs icon if @samp{on}; don't
151
do so if @samp{off}.  @xref{Icons X}, for a description of the icon.
152

153
@ifnottex
154
@item @code{borderColor} (class @code{BorderColor})
155 156
Color of the frame's external border.  This has no effect if Emacs is
compiled with GTK+ support.
157 158

@item @code{borderWidth} (class @code{BorderWidth})
159 160
Width of the frame's external border, in pixels.  This has no effect
if Emacs is compiled with GTK+ support.
Jan Djärv's avatar
Jan Djärv committed
161
@end ifnottex
162 163

@item @code{cursorColor} (class @code{Foreground})
164 165 166
Text cursor color.  If this resource is specified when Emacs starts
up, Emacs sets its value as the background color of the @code{cursor}
face (@pxref{Faces}).
167

168
@item @code{cursorBlink} (class @code{CursorBlink})
169 170 171
If the value of this resource is @samp{off} or @samp{false} or
@samp{0} at startup, Emacs disables Blink Cursor mode (@pxref{Cursor
Display}).
172

173
@item @code{font} (class @code{Font})
174
Font name for the @code{default} face (@pxref{Fonts}).  You can also
175 176 177
specify a fontset name (@pxref{Fontsets}).

@item @code{fontBackend} (class @code{FontBackend})
178 179
Comma-delimited list of backend(s) to use for drawing fonts, in order
of precedence.  For instance, the value @samp{x,xft} tells Emacs to
180
draw fonts using the X core font driver, falling back on the Xft font
181 182
driver if that fails.  Normally, you should leave this resource unset,
in which case Emacs tries using all available font backends.
183 184

@item @code{foreground} (class @code{Foreground})
185
Default foreground color for text.
186 187

@item @code{geometry} (class @code{Geometry})
188 189 190
Window size and position.  The value should be a size and position
specification, of the same form as in the @samp{-g} or
@samp{--geometry} command-line option (@pxref{Window Size X}).
191

192 193 194 195 196 197 198
The size applies to all frames in the Emacs session, but the position
applies only to the initial Emacs frame (or, in the case of a resource
for a specific frame name, only that frame).


Be careful not to specify this resource as @samp{emacs*geometry}, as
that may affect individual menus as well as the main Emacs frame.
199

200
@item @code{fullscreen} (class @code{Fullscreen})
201
The desired fullscreen size.  The value can be one of @code{fullboth},
202 203 204 205
@code{maximized}, @code{fullwidth} or @code{fullheight}, which
correspond to the command-line options @samp{-fs}, @samp{-mm},
@samp{-fw}, and @samp{-fh} (@pxref{Window Size X}).  Note that this
applies to the initial frame only.
206

207
@ifnottex
208 209 210 211
@item @code{iconName} (class @code{Title})
Name to display in the icon.

@item @code{internalBorder} (class @code{BorderWidth})
212 213
Width of the internal frame border, in pixels.
@end ifnottex
214 215 216

@item @code{lineSpacing} (class @code{LineSpacing})
@cindex line spacing
217
Additional space between lines, in pixels.
218 219

@item @code{menuBar} (class @code{MenuBar})
Dave Love's avatar
Dave Love committed
220
@cindex menu bar
221 222
If the value of this resource is @samp{off} or @samp{false} or
@samp{0}, Emacs disables Menu Bar mode at startup (@pxref{Menu Bars}).
223

Jan Djärv's avatar
Jan Djärv committed
224
@ifnottex
225
@item @code{minibuffer} (class @code{Minibuffer})
226 227
If @samp{none}, Emacs will not make a minibuffer in this frame; it
will use a separate minibuffer frame instead.
228 229 230 231

@item @code{paneFont} (class @code{Font})
@cindex font for menus
Font name for menu pane titles, in non-toolkit versions of Emacs.
Jan Djärv's avatar
Jan Djärv committed
232
@end ifnottex
233 234

@item @code{pointerColor} (class @code{Foreground})
235 236 237
Color of the mouse cursor.  This has no effect in many graphical
desktop environments, as they do not let Emacs change the mouse cursor
this way.
238

Jan Djärv's avatar
Jan Djärv committed
239
@ifnottex
240 241 242 243 244 245 246 247 248 249 250 251 252
@item @code{privateColormap} (class @code{PrivateColormap})
If @samp{on}, use a private color map, in the case where the ``default
visual'' of class PseudoColor and Emacs is using it.

@item @code{reverseVideo} (class @code{ReverseVideo})
Switch foreground and background default colors if @samp{on}, use colors as
specified if @samp{off}.

@item @code{screenGamma} (class @code{ScreenGamma})
@cindex gamma correction
Gamma correction for colors, equivalent to the frame parameter
@code{screen-gamma}.

Jan Djärv's avatar
Reorder  
Jan Djärv committed
253 254 255
@item @code{scrollBarWidth} (class @code{ScrollBarWidth})
@cindex scrollbar width
The scroll bar width in pixels, equivalent to the frame parameter
256 257 258
@code{scroll-bar-width}.  Do not set this resource if Emacs is
compiled with GTK+ support.
@end ifnottex
Jan Djärv's avatar
Reorder  
Jan Djärv committed
259

Jan Djärv's avatar
Jan Djärv committed
260
@ifnottex
Dave Love's avatar
Dave Love committed
261
@item @code{selectionFont} (class @code{SelectionFont})
262 263 264 265
Font name for pop-up menu items, in non-toolkit versions of Emacs.  (For
toolkit versions, see @ref{Lucid Resources}, also see @ref{LessTif
Resources}.)

Dave Love's avatar
Dave Love committed
266 267 268 269 270
@item @code{selectionTimeout} (class @code{SelectionTimeout})
Number of milliseconds to wait for a selection reply.
If the selection owner doesn't reply in this time, we give up.
A value of 0 means wait as long as necessary.

271 272 273 274 275
@item @code{synchronous} (class @code{Synchronous})
@cindex debugging X problems
@cindex synchronous X mode
Run Emacs in synchronous mode if @samp{on}.  Synchronous mode is
useful for debugging X problems.
Jan Djärv's avatar
Jan Djärv committed
276
@end ifnottex
277 278 279 280

@item @code{title} (class @code{Title})
Name to display in the title bar of the initial Emacs frame.

281
@item @code{toolBar} (class @code{ToolBar})
Dave Love's avatar
Dave Love committed
282
@cindex tool bar
283 284
If the value of this resource is @samp{off} or @samp{false} or
@samp{0}, Emacs disables Tool Bar mode at startup (@pxref{Tool Bars}).
285

Dave Love's avatar
Dave Love committed
286 287 288 289
@item @code{useXIM} (class @code{UseXIM})
@cindex XIM
@cindex X input methods
@cindex input methods, X
290 291 292
Disable use of X input methods (XIM) if @samp{false} or @samp{off}.
This is only relevant if your Emacs is built with XIM support.  It
might be useful to turn off XIM on slow X client/server links.
Dave Love's avatar
Dave Love committed
293

294 295 296
@item @code{verticalScrollBars} (class @code{ScrollBars})
Give frames scroll bars if @samp{on}; don't have scroll bars if
@samp{off}.
297

Jan Djärv's avatar
Jan Djärv committed
298
@ifnottex
299
@item @code{visualClass} (class @code{VisualClass})
300 301 302 303 304
The @dfn{visual class} for X color display.  If specified, the value
should start with one of @samp{TrueColor}, @samp{PseudoColor},
@samp{DirectColor}, @samp{StaticColor}, @samp{GrayScale}, and
@samp{StaticGray}, followed by @samp{-@var{depth}}, where @var{depth}
is the number of color planes.
Jan Djärv's avatar
Jan Djärv committed
305
@end ifnottex
306 307
@end table

308 309 310 311 312 313
  You can also use X resources to customize individual Emacs faces
(@pxref{Faces}).  For example, setting the resource
@samp{@var{face}.attributeForeground} is equivalent to customizing the
@samp{foreground} attribute of the face @var{face}.  However, we
recommend customizing faces from within Emacs, instead of using X
resources.  @xref{Face Customization}.
314

315
@ifnottex
316
@node Lucid Resources
317
@appendixsec Lucid Menu And Dialog X Resources
318
@cindex Menu X Resources (Lucid widgets)
319
@cindex Dialog X Resources (Lucid widgets)
320 321
@cindex Lucid Widget X Resources

322 323 324 325 326 327 328 329
  If Emacs is compiled with the X toolkit support using Lucid widgets,
you can use X resources to customize the appearance of the menu bar,
pop-up menus, and dialog boxes.  The resources for the menu bar fall
in the @samp{pane.menubar} class (following, as always, either the
name of the Emacs executable or @samp{Emacs} for all Emacs
invocations).  The resources for the pop-up menu are in the
@samp{menu*} class.  The resources for dialog boxes are in the
@samp{dialog*} class.
330

331 332
  For example, to display menu bar entries with the @samp{Courier-12}
font (@pxref{Fonts}), write this:
333 334

@example
335
Emacs.pane.menubar.font: Courier-12
336 337 338
@end example

@noindent
339 340 341 342
Lucid widgets can display multilingual text in your locale.  To enable
this, specify a @code{fontSet} resource instead of a @code{font}
resource.  @xref{Fontsets}.  If both @code{font} and @code{fontSet}
resources are specified, the @code{fontSet} resource is used.
Jan Djärv's avatar
Jan Djärv committed
343

344
Here is a list of resources for menu bars, pop-up menus, and dialogs:
345 346 347 348

@table @code
@item font
Font for menu item text.
349 350
@item fontSet
Fontset for menu item text.
351
@item foreground
352
Foreground color.
353
@item background
354
Background color.
355
@item buttonForeground
356
Foreground color for a selected item.
Jan Djärv's avatar
Jan Djärv committed
357
@ifnottex
358 359 360
@item horizontalSpacing
Horizontal spacing in pixels between items.  Default is 3.
@item verticalSpacing
361
Vertical spacing in pixels between items.  Default is 2.
362 363 364 365
@item arrowSpacing
Horizontal spacing between the arrow (which indicates a submenu) and
the associated text.  Default is 10.
@item shadowThickness
366 367
Thickness of shadow lines for 3D buttons, arrows, and other graphical
elements.  Default is 1.
Jan Djärv's avatar
Jan Djärv committed
368
@end ifnottex
369
@item margin
370
Margin of the menu bar, in characters.  Default is 1.
371 372 373 374 375 376 377
@end table

@node LessTif Resources
@appendixsec LessTif Menu X Resources
@cindex Menu X Resources (LessTif widgets)
@cindex LessTif Widget X Resources

378 379 380 381
  If Emacs is compiled with the X toolkit support using LessTif or
Motif widgets, you can use X resources to customize the appearance of
the menu bar, pop-up menus, and dialog boxes.  However, the resources
are organized differently from Lucid widgets.
382

383 384
  The resource names for the menu bar are in the @samp{pane.menubar}
class, and they must be specified in this form:
385 386 387 388 389

@smallexample
Emacs.pane.menubar.@var{subwidget}.@var{resource}:  @var{value}
@end smallexample

390 391 392 393 394 395 396 397 398 399 400 401
@noindent
For pop-up menus, the resources are in the @samp{menu*} class, instead
of @samp{pane.menubar}.  For dialog boxes, they are in @samp{dialog}.
In each case, each individual menu string is a subwidget; the
subwidget's name is the same as the menu item string.  For example,
the @samp{File} menu in the menu bar is a subwidget named
@samp{emacs.pane.menubar.File}.

  Typically, you want to specify the same resources for the whole menu
bar.  To do this, use @samp{*} instead of a specific subwidget name.
For example, to specify the font @samp{8x16} for all menu bar items,
including submenus, write this:
402 403 404 405 406

@smallexample
Emacs.pane.menubar.*.fontList:  8x16
@end smallexample

407 408 409 410
  Each item in a submenu also has its own name for X resources; for
example, the @samp{File} submenu has an item named @samp{Save (current
buffer)}.  A resource specification for a submenu item looks like
this:
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441

@smallexample
Emacs.pane.menubar.popup_*.@var{menu}.@var{item}.@var{resource}: @var{value}
@end smallexample

@noindent
For example, here's how to specify the font for the @samp{Save (current
buffer)} item:

@smallexample
Emacs.pane.menubar.popup_*.File.Save (current buffer).fontList: 8x16
@end smallexample

@noindent
For an item in a second-level submenu, such as @samp{Complete Word}
under @samp{Spell Checking} under @samp{Tools}, the resource fits this
template:

@smallexample
Emacs.pane.menubar.popup_*.popup_*.@var{menu}.@var{resource}: @var{value}
@end smallexample

@noindent
For example,

@smallexample
Emacs.pane.menubar.popup_*.popup_*.Spell Checking.Complete Word: @var{value}
@end smallexample

@noindent
(This should be one long line.)
442

443 444 445
  If you want the submenu items to look different from the menu bar
itself, you must first specify the resource for all of them, then
override the value for submenus alone.  Here is an example:
446 447 448 449 450 451

@smallexample
Emacs.pane.menubar.*.fontList:  8x16
Emacs.pane.menubar.popup_*.fontList: 8x16
@end smallexample

452
  To specify resources for the LessTif file-selection box, use
453 454 455 456 457 458
@samp{fsb*}, like this:

@example
Emacs.fsb*.fontList: 8x16
@end example

459
  Here is a list of resources for LessTif menu bars and pop-up menus:
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481

@table @code
@item armColor
The color to show in an armed button.
@item fontList
The font to use.
@item marginBottom
@itemx marginHeight
@itemx marginLeft
@itemx marginRight
@itemx marginTop
@itemx marginWidth
Amount of space to leave around the item, within the border.
@item borderWidth
The width of the border around the menu item, on all sides.
@item shadowThickness
The width of the border shadow.
@item bottomShadowColor
The color for the border shadow, on the bottom and the right.
@item topShadowColor
The color for the border shadow, on the top and the left.
@end table
Jan Djärv's avatar
Jan Djärv committed
482
@end ifnottex
Jan Djärv's avatar
Jan Djärv committed
483 484 485

@node GTK resources
@appendixsec GTK resources
486 487 488 489
@cindex GTK+ resources
@cindex resource files for GTK
@cindex @file{~/.gtkrc-2.0} file
@cindex @file{~/.emacs.d/gtkrc} file
Jan Djärv's avatar
Jan Djärv committed
490

491
  If Emacs is compiled with GTK+ toolkit support, the simplest way to
492
customize its GTK+ widgets (e.g., menus, dialogs, tool bars and
493 494 495 496 497 498 499 500 501
scroll bars) is to choose an appropriate GTK+ theme, for example with
the GNOME theme selector.

  In GTK+ version 2, you can also use @dfn{GTK+ resources} to
customize the appearance of GTK+ widgets used by Emacs.  These
resources are specified in either the file @file{~/.emacs.d/gtkrc}
(for Emacs-specific GTK+ resources), or @file{~/.gtkrc-2.0} (for
general GTK+ resources).  We recommend using @file{~/.emacs.d/gtkrc},
since GTK+ seems to ignore @file{~/.gtkrc-2.0} when running GConf with
502
GNOME@.  Note, however, that some GTK themes may override
503 504 505 506 507 508 509
customizations in @file{~/.emacs.d/gtkrc}; there is nothing we can do
about this.  GTK+ resources do not affect aspects of Emacs unrelated
to GTK+ widgets, such as fonts and colors in the main Emacs window;
those are governed by normal X resources (@pxref{Resources}).

  The following sections describe how to customize GTK+ resources for
Emacs.  For details about GTK+ resources, see the GTK+ API document at
510
@uref{http://developer.gnome.org/gtk2/stable/gtk2-Resource-Files.html}.
Jan Djärv's avatar
Jan Djärv committed
511

512 513 514 515 516 517 518 519 520
  In GTK+ version 3, GTK+ resources have been replaced by a completely
different system.  The appearance of GTK+ widgets is now determined by
CSS-like style files: @file{gtk-3.0/gtk.css} in the GTK+ installation
directory, and @file{~/.themes/@var{theme}/gtk-3.0/gtk.css} for local
style settings (where @var{theme} is the name of the current GTK+
theme).  Therefore, the description of GTK+ resources in this section
does not apply to GTK+ 3.  For details about the GTK+ 3 styling
system, see
@uref{http://developer.gnome.org/gtk3/3.0/GtkCssProvider.html}.
Jan Djärv's avatar
Jan Djärv committed
521

522 523 524 525 526 527
@menu
* GTK Resource Basics::   Basic usage of GTK+ resources.
* GTK Widget Names::      How GTK+ widgets are named.
* GTK Names in Emacs::    GTK widgets used by Emacs.
* GTK styles::            What can be customized in a GTK widget.
@end menu
Jan Djärv's avatar
Jan Djärv committed
528

529 530
@node GTK Resource Basics
@appendixsubsec GTK Resource Basics
Jan Djärv's avatar
Jan Djärv committed
531

532 533 534 535
  In a GTK+ 2 resource file (usually @file{~/.emacs.d/gtkrc}), the
simplest kinds of resource settings simply assign a value to a
variable.  For example, putting the following line in the resource
file changes the font on all GTK+ widgets to @samp{courier-12}:
Jan Djärv's avatar
Jan Djärv committed
536 537

@smallexample
538
gtk-font-name = "courier 12"
Jan Djärv's avatar
Jan Djärv committed
539
@end smallexample
540

541 542 543
@noindent
Note that in this case the font name must be supplied as a GTK font
pattern (also called a @dfn{Pango font name}), not as a
544
Fontconfig-style font name or XLFD@.  @xref{Fonts}.
Jan Djärv's avatar
Jan Djärv committed
545

546 547 548
  To customize widgets you first define a @dfn{style}, and then apply
the style to the widgets.  Here is an example that sets the font for
menus (@samp{#} characters indicate comments):
Jan Djärv's avatar
Jan Djärv committed
549 550

@smallexample
551 552
# @r{Define the style @samp{my_style}.}
style "my_style"
Jan Djärv's avatar
Jan Djärv committed
553 554 555 556
@{
  font_name = "helvetica bold 14"
@}

557 558
# @r{Specify that widget type @samp{*emacs-menuitem*} uses @samp{my_style}.}
widget "*emacs-menuitem*" style "my_style"
Jan Djärv's avatar
Jan Djärv committed
559 560 561
@end smallexample

@noindent
562 563 564 565 566
The widget name in this example contains wildcards, so the style is
applied to all widgets matching @samp{*emacs-menuitem*}.  The widgets
are named by the way they are contained, from the outer widget to the
inner widget.  Here is another example that applies @samp{my_style}
specifically to the Emacs menu bar:
Jan Djärv's avatar
Jan Djärv committed
567 568

@smallexample
569
widget "Emacs.pane.menubar.*" style "my_style"
Jan Djärv's avatar
Jan Djärv committed
570 571 572 573 574 575 576 577
@end smallexample

  Here is a more elaborate example, showing how to change the parts of
the scroll bar:

@smallexample
style "scroll"
@{
578 579 580 581
  fg[NORMAL] = "red"@ @ @ @ @ # @r{Arrow color.}
  bg[NORMAL] = "yellow"@ @ # @r{Thumb and background around arrow.}
  bg[ACTIVE] = "blue"@ @ @ @ # @r{Trough color.}
  bg[PRELIGHT] = "white"@ # @r{Thumb color when the mouse is over it.}
Jan Djärv's avatar
Jan Djärv committed
582 583 584 585
@}

widget "*verticalScrollBar*" style "scroll"
@end smallexample
586

587
@node GTK Widget Names
Jan Djärv's avatar
Jan Djärv committed
588 589 590
@appendixsubsec GTK widget names
@cindex GTK widget names

591 592
  A GTK+ widget is specified by a @dfn{widget name} and a @dfn{widget
class}.  The widget name refers to a specific widget
593 594
(e.g., @samp{emacs-menuitem}), while the widget class refers to a
collection of similar widgets (e.g., @samp{GtkMenuItem}).  A widget
595
always has a class, but need not have a name.
Jan Djärv's avatar
Jan Djärv committed
596

597 598 599 600 601 602 603
  @dfn{Absolute names} are sequences of widget names or widget
classes, corresponding to hierarchies of widgets embedded within
other widgets.  For example, if a @code{GtkWindow} named @code{top}
contains a @code{GtkVBox} named @code{box}, which in turn contains
a @code{GtkMenuBar} called @code{menubar}, the absolute class name
of the menu-bar widget is @code{GtkWindow.GtkVBox.GtkMenuBar}, and
its absolute widget name is @code{top.box.menubar}.
Jan Djärv's avatar
Jan Djärv committed
604

605 606
  GTK+ resource files can contain two types of commands for specifying
widget appearances:
607

608 609 610 611
@table @code
@item widget
specifies a style for widgets based on the class name, or just the
class.
612

613 614
@item widget_class
specifies a style for widgets based on the class name.
615 616 617
@end table

@noindent
618 619 620 621
See the previous subsection for examples of using the @code{widget}
command; the @code{widget_class} command is used similarly.  Note that
the widget name/class and the style must be enclosed in double-quotes,
and these commands must be at the top level in the GTK+ resource file.
Jan Djärv's avatar
Jan Djärv committed
622

623 624 625 626
  As previously noted, you may specify a widget name or class with
shell wildcard syntax: @samp{*} matches zero or more characters and
@samp{?} matches one character.  This example assigns a style to all
widgets:
Jan Djärv's avatar
Jan Djärv committed
627 628

@smallexample
629
widget "*" style "my_style"
Jan Djärv's avatar
Jan Djärv committed
630 631
@end smallexample

632 633
@node GTK Names in Emacs
@appendixsubsec GTK Widget Names in Emacs
Jan Djärv's avatar
Jan Djärv committed
634 635 636
@cindex GTK widget names
@cindex GTK widget classes

637
  The GTK+ widgets used by an Emacs frame are listed below:
Jan Djärv's avatar
Jan Djärv committed
638

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
@table @asis
@item @code{Emacs} (class @code{GtkWindow})
@table @asis
@item @code{pane} (class @code{GtkVBox})
@table @asis
@item @code{menubar} (class @code{GtkMenuBar})
@table @asis
@item [menu item widgets]
@end table
@item [unnamed widget] (class @code{GtkHandleBox})
@table @asis
@item @code{emacs-toolbar} (class @code{GtkToolbar})
@table @asis
@item [tool bar item widgets]
@end table
@end table
@item @code{emacs} (class @code{GtkFixed})
@table @asis
@item @code{verticalScrollBar} (class @code{GtkVScrollbar})
@end table
@end table
@end table
@end table
Jan Djärv's avatar
Jan Djärv committed
662 663

@noindent
664 665 666
The contents of Emacs windows are drawn in the @code{emacs} widget.
Note that even if there are multiple Emacs windows, each scroll bar
widget is named @code{verticalScrollBar}.
Jan Djärv's avatar
Jan Djärv committed
667

668
  For example, here are two different ways to set the menu bar style:
Jan Djärv's avatar
Jan Djärv committed
669 670

@smallexample
671 672
widget "Emacs.pane.menubar.*" style "my_style"
widget_class "GtkWindow.GtkVBox.GtkMenuBar.*" style "my_style"
Jan Djärv's avatar
Jan Djärv committed
673 674
@end smallexample

675 676 677
  For GTK+ dialogs, Emacs uses a widget named @code{emacs-dialog}, of
class @code{GtkDialog}.  For file selection, Emacs uses a widget named
@code{emacs-filedialog}, of class @code{GtkFileSelection}.
Jan Djärv's avatar
Jan Djärv committed
678

679 680 681 682
  Because the widgets for pop-up menus and dialogs are free-standing
windows and not ``contained'' in the @code{Emacs} widget, their GTK+
absolute names do not start with @samp{Emacs}.  To customize these
widgets, use wildcards like this:
Jan Djärv's avatar
Jan Djärv committed
683 684 685 686 687 688 689

@smallexample
widget "*emacs-dialog*" style "my_dialog_style"
widget "*emacs-filedialog* style "my_file_style"
widget "*emacs-menuitem* style "my_menu_style"
@end smallexample

690
  If you want to apply a style to all menus in Emacs, use this:
Jan Djärv's avatar
Jan Djärv committed
691 692 693 694 695 696 697 698 699

@smallexample
widget_class "*Menu*" style "my_menu_style"
@end smallexample

@node GTK styles
@appendixsubsec GTK styles
@cindex GTK styles

700
  Here is an example of two GTK+ style declarations:
Jan Djärv's avatar
Jan Djärv committed
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725

@smallexample
pixmap_path "/usr/share/pixmaps:/usr/include/X11/pixmaps"

style "default"
@{
  font_name = "helvetica 12"

  bg[NORMAL] = @{ 0.83, 0.80, 0.73 @}
  bg[SELECTED] = @{ 0.0, 0.55, 0.55 @}
  bg[INSENSITIVE] = @{ 0.77, 0.77, 0.66 @}
  bg[ACTIVE] = @{ 0.0, 0.55, 0.55 @}
  bg[PRELIGHT] = @{ 0.0, 0.55, 0.55 @}

  fg[NORMAL] = "black"
  fg[SELECTED] = @{ 0.9, 0.9, 0.9 @}
  fg[ACTIVE] = "black"
  fg[PRELIGHT] = @{ 0.9, 0.9, 0.9 @}

  base[INSENSITIVE] = "#777766"
  text[INSENSITIVE] = @{ 0.60, 0.65, 0.57 @}

  bg_pixmap[NORMAL] = "background.xpm"
  bg_pixmap[INSENSITIVE] = "background.xpm"
  bg_pixmap[ACTIVE] = "background.xpm"
726
  bg_pixmap[PRELIGHT] = "<none>"
Jan Djärv's avatar
Jan Djärv committed
727 728 729 730 731 732 733 734 735 736

@}

style "ruler" = "default"
@{
  font_name = "helvetica 8"
@}

@end smallexample

737
  The style @samp{ruler} inherits from @samp{default}.  This way you can build
Jan Djärv's avatar
Jan Djärv committed
738 739
on existing styles.  The syntax for fonts and colors is described below.

740 741 742 743
  As this example shows, it is possible to specify several values for
foreground and background depending on the widget's @dfn{state}.  The
possible states are:

Jan Djärv's avatar
Jan Djärv committed
744 745 746 747 748
@table @code
@item NORMAL
This is the default state for widgets.
@item ACTIVE
This is the state for a widget that is ready to do something.  It is
749
also for the trough of a scroll bar, i.e., @code{bg[ACTIVE] = "red"}
Jan Djärv's avatar
Jan Djärv committed
750 751 752
sets the scroll bar trough to red.  Buttons that have been pressed but
not released yet (``armed'') are in this state.
@item PRELIGHT
753 754 755 756
This is the state for a widget that can be manipulated, when the mouse
pointer is over it---for example when the mouse is over the thumb in
the scroll bar or over a menu item.  When the mouse is over a button
that is not pressed, the button is in this state.
Jan Djärv's avatar
Jan Djärv committed
757
@item SELECTED
758 759 760
This is the state for data that has been selected by the user.  It can
be selected text or items selected in a list.  This state is not used
in Emacs.
Jan Djärv's avatar
Jan Djärv committed
761 762
@item INSENSITIVE
This is the state for widgets that are visible, but they can not be
763 764 765
manipulated in the usual way---for example, buttons that can't be
pressed, and disabled menu items.  To display disabled menu items in
yellow, use @code{fg[INSENSITIVE] = "yellow"}.
Jan Djärv's avatar
Jan Djärv committed
766 767
@end table

768
  Here are the things that can go in a style declaration:
Jan Djärv's avatar
Jan Djärv committed
769 770 771

@table @code
@item bg[@var{state}] = @var{color}
772 773
This specifies the background color for the widget.  Note that
editable text doesn't use @code{bg}; it uses @code{base} instead.
Jan Djärv's avatar
Jan Djärv committed
774 775

@item base[@var{state}] = @var{color}
776 777 778
This specifies the background color for editable text.  In Emacs, this
color is used for the background of the text fields in the file
dialog.
Jan Djärv's avatar
Jan Djärv committed
779 780

@item bg_pixmap[@var{state}] = "@var{pixmap}"
781 782
This specifies an image background (instead of a background color).
@var{pixmap} should be the image file name.  GTK can use a number of
783
image file formats, including XPM, XBM, GIF, JPEG and PNG@.  If you
784 785 786 787 788 789 790 791 792
want a widget to use the same image as its parent, use
@samp{<parent>}.  If you don't want any image, use @samp{<none>}.
@samp{<none>} is the way to cancel a background image inherited from a
parent style.

You can't specify the file by its absolute file name.  GTK looks for
the pixmap file in directories specified in @code{pixmap_path}.
@code{pixmap_path} is a colon-separated list of directories within
double quotes, specified at the top level in a @file{gtkrc} file
793
(i.e., not inside a style definition; see example above):
Jan Djärv's avatar
Jan Djärv committed
794 795 796 797 798 799

@smallexample
pixmap_path "/usr/share/pixmaps:/usr/include/X11/pixmaps"
@end smallexample

@item fg[@var{state}] = @var{color}
800 801 802
This specifies the foreground color for widgets to use.  It is the
color of text in menus and buttons, and the color for the arrows in
the scroll bar.  For editable text, use @code{text}.
Jan Djärv's avatar
Jan Djärv committed
803 804

@item text[@var{state}] = @var{color}
805
This is the color for editable text.  In Emacs, this color is used for the
Jan Djärv's avatar
Jan Djärv committed
806 807 808
text fields in the file dialog.

@item font_name = "@var{font}"
809
This specifies the font for text in the widget.  @var{font} is a
810 811
GTK-style (or Pango) font name, like @samp{Sans Italic 10}.
@xref{Fonts}.  The names are case insensitive.
Jan Djärv's avatar
Jan Djärv committed
812 813
@end table

814 815 816
  There are three ways to specify a color: a color name, an RGB
triplet, or a GTK-style RGB triplet.  @xref{Colors}, for a description
of color names and RGB triplets.  Color names should be enclosed with
817 818
double quotes, e.g., @samp{"red"}.  RGB triplets should be written
without double quotes, e.g., @samp{#ff0000}.  GTK-style RGB triplets
819
have the form @w{@code{@{ @var{r}, @var{g}, @var{b} @}}}, where
820 821
@var{r}, @var{g} and @var{b} are either integers in the range 0--65535
or floats in the range 0.0--1.0.