annotate PROGRAMMING_NOTES @ 7751:d691cb95ee67

[gaim-migrate @ 8396] Changes for the conversation "Find" dialog: -Makes the window manager "X" work correctly when closing the dialog -Added an "s" mnemonic for the search box -Hitting enter now performs the default action (Find) -The Find button grays and un-grays (aka sensitizes and desensitizes) itself based on the presence or absence of text in the search box. For this I moved a function from dialogs.c to util.[c|h]: gaim_gtk_set_sensitive_if_input() -HIGification suggestions from Steven Garrity: 1. Give the window a title ("Find") as is recommended by the HIG (http://developer.gnome.org/projects/gup/hig/1.0/windows.html#window-properties). 2. Drop the phrase "Enter a search phrase" altogether. Since the text box is already labeled (and if the window was labeled too), this phrase is redundant. Removing it simplifies the visual appearance of the window, and is one less thing to translate. 3.Change text box label from "Search term:" to "Search for:". This isn't a big deal, but the Search window in GEdit uses "Search for:" (I couldn't find much consistency anywhere else). 4.Move "Close" and "Find" buttons to be 12 pixels from the bottom and right edges of the window, as recommended by the HIG (http://developer.gnome.org/projects/gup/hig/1.0/layout.html#window-layout-spacing). Also thanks to Nathan Fredrickson for writing a patch for Steven's suggestions. committer: Tailor Script <[e-mail]>

Notes on keeping GAIM OS independant
------------------------------------

General
-------
- Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths

- Use g_getenv, g_snprintf, g_vsnprintf

- Use gaim_home_dir instead of g_get_home_dir or g_getenv("HOME")

- Make sure when including win32dep.h that it is the last header to
  be included.

- Open binary files when reading or writing with 'b' mode.

  e.g: fopen("somefile", "wb");

  Not doing so will open files in windows using defaut translation mode. 
  i.e. newline -> <CR><LF>

Paths
-----

- DATADIR, LOCALEDIR & LIBDIR are defined in wingaim as functions.
  Doing the following will therefore break the windows build:

  printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");

  it should be:

  printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");

- When writing out paths to .gaimrc, use wgaim_escape_dirsep. This is necessary
  because the Windows dir separator '\' is being used to escape characters, when
  paths are read in from the .gaimrc file.

PLUGINS & PROTOS
----------------

- G_MODULE_EXPORT all functions which are to be accessed from outside the
  scope of its "dll" or "so". (E.G. gaim_plugin_init)

- G_MODULE_IMPORT all global variables which are located outside your
  dynamic library. (E.G. connections)

  (Not doing this will cause "Memory Access Violations" in Win32)