add more spacing
[personal-kdebase.git] / workspace / systemsettings / HACKING
blobdaabb88f149eeebc4ff7eeca548c0eb5c1f54cb6
1 This is an overview of how the code is situated and a very brief overview of what the classes do.  See the header files for a more indepth overview of what the classes do.
3 -- System Settings classes --
5 mainwindow - The KMainWindow contains KActions, the stack of the iconlist and the current module(s) view.
7 modulesview - The widget that is the icon view that users see when the first enter the app.
8 kcmsearch - Search widget that can search ModulesView and enable/disable items.
10 modulesiconitem - The individual modules items.  Used for loading enabled/disabled images and storing the list of modules acosiated with the item.
12 kcmodulemenu - Class that reads in a freedesktop.org .menu file into a QValueList.
14 kcmultiwidget - A basterdized kcmultidialog from kdelibs/kutil that provides info about the current shown dialog so the about dialog and caption can be updated and prompts for unsaved changes. 
16 -- INSTALL --
18 To install a new menu you have to install three files.
20 (if you have debian, if you have another system use locate to determine where kde-system.* is installed and install in the same place.
22 -/etc/xdg/menus/system-settings.menu
23 -/etc/xdg/menus/applications-merged/system-settings-merge.menu
24 -/usr/share/desktop-directories/system-settings.directory
26 Also don't forget to install the ui file.
27 -/share/apps/systemsettings/systempreferencesui.rc
28 And the desktop file.
29 -share/applications/kde/systemsettings.desktop
31 When you change (or install) any of the first three files make sure to run kbuildsycoca to re-generate the cache files or log out and back in.