add comment about the two different area Rects
[mikachu/openbox.git] / HACKING
1 Woop, a HACKING document for openbox at last!
2
3 Beware the Client.transient_for. It can be set to a !NULL value of TRAN_GROUP,
4 which is not a valid pointer. You must ALWAYS check for TRAN_GROUP before
5 following transient_for. When TRAN_GROUP is found, Client.group will always
6 be !NULL. Some smart action should be taken using all members of the group in
7 this case.
8
9 When using coordinates/sizes of windows, make sure you use the right area. The
10 Client.area rect is the reference point and size of the *CLIENT* window. This
11 value is not what you see in any shape or form, and gravity is applied to it to
12 translate it into what you see. The Client.frame.area is the actual position
13 and size of the entire frame. This is usually the value you want to use, unless
14 you are in client.c (probably) and adjusting/using the position or size from
15 the client's perspective.