Files
cdesktop/cde/doc/C/guides/man/man4/dtbmfile.sgm

98 lines
3.7 KiB
Plaintext

<!-- $XConsortium: dtbmfile.sgm /main/6 1996/09/08 20:17:12 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<RefEntry Id="CDEMX.MAN78.rsml.1">
<RefMeta>
<RefEntryTitle>dtbmfile</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtbmfile</Filename></RefName>
<RefPurpose>format of X11 bitmap format desktop icon files
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis> #define <Symbol Role="Variable">name</Symbol>_width <Symbol Role="Variable">width</Symbol>
#define <Symbol Role="Variable">name</Symbol>_height <Symbol Role="Variable">height</Symbol>
#define <Symbol Role="Variable">name</Symbol>_x_hot <Symbol Role="Variable">x</Symbol>
#define <Symbol Role="Variable">name</Symbol>_y_hot <Symbol Role="Variable">y</Symbol>
static unsigned char <Symbol Role="Variable">name</Symbol>_bits[] = {0x<Emphasis>N</Emphasis>,...}
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>X Bitmap (XBM) files are used for monochrome icons in the CDE.
XBM icons specify background and foreground
color only.
They would be black and white on a black and white
display.
On a color display, they could be any two colors.
XBM files are not used exclusively for black and white icons.
The CDE icon editor component can be used to create or modify a
bitmap icon.
A bitmap file is an ASCII file, but because the data is
simply a binary representation of the icon, it is not realistic
to edit this file by hand.
X Bitmap files can be included directly
in C source code, so the file data is in the form of a bitmap
structure variable.
X version 11 bitmap file format is the only icon file format
officially supported as part of the X Window System at this time.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The following is an example of a bitmap file named <Literal>julie.bm</Literal>:
</Para>
<InformalExample Remap="indent">
<ProgramListing>#define julie.bm_width 18
#define julie.bm_height 22
#define julie.bm_x_hot 0
#define julie.bm_y_hot 0
static char julie.bm_bits[] = {
0xff, 0xff, 0x03, 0x81, 0xc3, 0x02,
0xf1, 0x98, 0x03, 0x19, 0x18, 0x02,
0x05, 0x59, 0x02, 0x07, 0xdb, 0x02,
0x01, 0xdb, 0x02, 0x01, 0xdb, 0x02,
0x01, 0xdb, 0x02, 0x01, 0xdf, 0x02,
0x01, 0xff, 0x02, 0x01, 0xfe, 0x02,
0x01, 0x7c, 0x02, 0x01, 0x38, 0x02,
0x01, 0x38, 0x02, 0x01, 0x38, 0x02,
0x01, 0x38, 0x02, 0x01, 0x3f, 0x02,
0xe1, 0x33, 0x02, 0xb9, 0x31, 0x02,
0xcf, 0x1c, 0x02, 0xff, 0xff, 0x03};
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>For a description of icon location, usage, design, etc. within the
CDE, refer to &cdeman.dticonfile;.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Literal>X11</Literal>Window<Literal>System</Literal>documentation, &cdeman.dtpmfile;, &cdeman.dticonfile;, &cdeman.dticon;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->