Version 4.0.0.1, tag libreoffice-4.0.0.1
[LibreOffice.git] / rsc / README
blobed940f727fb0fd75a536bd21a13b743072a2e624
1 Resource Compiler.
3 This compiler converts .src files and .hrc equivalents into binary
4 .res files.  The basic idea is that this provides a map between
5 integer identifiers and the resources: string, pixmap (only the
6 file-name), and VCL control properties.
8 In more detail:
10 Typically we would have a .hrc file with entries like this:
12 #define SID_STR_FOO    1234
14 And then a .src file with some entries like this:
16 String SID_STR_FOO
18     Text [ en-US ] = "Foo !" ;
21 This is compiled into a binary resource file, we have many of these
22 which live in program/resource/ and then tends to get used in the code
23 thus:
25 String aStr( ResId( SID_STR_FOO ) );
27 It is important to note that any appearance of hierarchical structure
28 in the .src files is in fact a mirage. The file is compiled at root
29 into a plain map<integer,resource>.
31 There is some German documentation about it in a subdirectory called
32 [git:rsc/doku].  Seems to be very old (January 1992).