Permalink
Browse files

Further shuffling. Update (and rename) developers readme.

git-svn-id: svn://svn.pgadmin.org/trunk@5756 a7884b65-44f6-0310-8a51-81a127f17b15
  • Loading branch information...
1 parent f252352 commit d2c43ae29030ea8258746bacdce3c9d1b10d35bd @dpage dpage committed Dec 6, 2006
Showing with 87 additions and 59 deletions.
  1. +55 −0 DEVELOPERS
  2. +1 −0 Makefile.am
  3. +31 −1 pgAdmin3.sln
  4. +0 −34 programmers-readme.txt
  5. +0 −24 src/pgAdmin3.vcproj
View
@@ -0,0 +1,55 @@
+pgAdmin Development
+===================
+
+The pgAdmin developers mailing list is pgadmin-hackers@postgresql.org
+
+For further information about pgAdmin's developement, please see the website:
+
+http://www.pgadmin.org/development/
+
+
+Developer notes
+===============
+
+Class naming conventions
+------------------------
+
+foo represents an object of type Foo
+fooFactory creates foos
+fooCollection is a collection of foos
+fooCollectionFactory creates a fooCollection
+
+fooObject is an object that resides under/in foo
+fooObjCollection is a collection of fooObjects
+
+fooObjFactory creates fooObjects
+
+
+To add actions to the main window (frmMain)
+--------------------------------------------
+
+- create the frmXXX class that will render the new function.
+
+- create an actionFactory (or contextActionFactory, if the action will display
+ in context menus too) derived factory for each action to be performed, and
+ register it in frmMain::CreateMenus(). Never touch menu.h, or anything for
+ that. Easy examples are frmGrantWizard or frmEditGrid.
+
+ - Implement CheckEnable() for each factory, checking the current object if
+ the action applies.
+
+ - Implement StartDialog(), which brings up the dialog.
+
+Following this, you should be able to add new actions on objects by just adding
+the source and registering the new menu in frmMain.cpp. If you think you need
+to modify more files, you're probably wrong.
+
+
+To add objects to the object tree
+---------------------------------
+- Implement the class with proper hierarchy. pgCast and dlgCast are simple
+ examples.
+
+- instantiate a collection in the pgXXX object where it should be located
+ under.
+
View
@@ -14,6 +14,7 @@ SUBDIRS = i18n src pkg xtra
EXTRA_DIST = \
$(top_srcdir)/BUGS \
$(top_srcdir)/CHANGELOG \
+ $(top_srcdir)/DEVELOPERS \
$(top_srcdir)/LICENSE \
$(top_srcdir)/README \
$(top_srcdir)/TODO \
View
@@ -8,6 +8,33 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "pgaevent", "xtra\pgaevent\p
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "xtra", "xtra", "{6F07A8BA-8734-4ECE-B19D-178465B1CEAA}"
EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "pgAdmin III", "pgAdmin III", "{CCBC0773-7287-4076-8D4F-BEBB3AFF5D23}"
+ ProjectSection(SolutionItems) = preProject
+ acinclude.m4 = acinclude.m4
+ bootstrap = bootstrap
+ BUGS = BUGS
+ CHANGELOG = CHANGELOG
+ configure.ac.in = configure.ac.in
+ DEVELOPERS = DEVELOPERS
+ languages.hwx = languages.hwx
+ languages.po = languages.po
+ LICENSE = LICENSE
+ Makefile.am = Makefile.am
+ pgadmin3-release.pot = pgadmin3-release.pot
+ pgadmin3.pot = pgadmin3.pot
+ README = README
+ stringextract = stringextract
+ stringextract.bat = stringextract.bat
+ stringmerge = stringmerge
+ TODO = TODO
+ EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "i18n", "i18n", "{F7C45B39-2B75-4D71-85D8-BF99CAC5ED16}"
+ ProjectSection(SolutionItems) = preProject
+ i18n\pg_settings.csv = i18n\pg_settings.csv
+ i18n\pgadmin3.lng = i18n\pgadmin3.lng
+ EndProjectSection
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Win32 = Debug|Win32
@@ -31,7 +58,10 @@ Global
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
- {7D082D30-F35A-42DA-A7E3-188EE6E67C7D} = {6F07A8BA-8734-4ECE-B19D-178465B1CEAA}
{71AF025C-C835-4501-89CF-A94EB3B14401} = {6F07A8BA-8734-4ECE-B19D-178465B1CEAA}
+ {7D082D30-F35A-42DA-A7E3-188EE6E67C7D} = {6F07A8BA-8734-4ECE-B19D-178465B1CEAA}
+ {5C2D73BA-1F24-48F8-8233-85F5D672AA6A} = {CCBC0773-7287-4076-8D4F-BEBB3AFF5D23}
+ {F7C45B39-2B75-4D71-85D8-BF99CAC5ED16} = {CCBC0773-7287-4076-8D4F-BEBB3AFF5D23}
+ {6F07A8BA-8734-4ECE-B19D-178465B1CEAA} = {CCBC0773-7287-4076-8D4F-BEBB3AFF5D23}
EndGlobalSection
EndGlobal
View
@@ -1,34 +0,0 @@
-Class naming conventions
-=========================
-
-foo represents an object of type Foo
-fooFactory creates foos
-fooCollection is a collection of foos
-fooCollectionFactory creates a fooCollection
-
-fooObject is an object that resides under/in foo
-fooObjCollection is a collection of fooObjects
-
-fooObjFactory creates fooObjects
-
-
-
-To add actions to the main window (frmMain):
-=============================================
-
-- create the frmXXX class that will render the new function.
-- create an actionFactory (or contextActionFactory, if the action will display in context menus too) derived factory for each action to be performed, and register it in frmMain::CreateMenus(). Never touch menu.h, or anything for that. Easy examples are frmGrantWizard or frmEditGrid.
-
- - Implement CheckEnable() for each factory, checking the current object if the action applies.
- - Implement StartDialog(), which brings up the dialog.
-
-Following this, you should be able to add new actions on objects by just adding the source and registering the new menu in frmMain.cpp. If you think you need to modify more files, you're probably wrong.
-
-
-
-
-To add objects to the object tree:
-===================================
-- Implement the class with proper hierarchy. pgCast and dlgCast are simple examples.
-- instantiate a collection in the pgXXX object where it should be located under.
-
View
@@ -4723,30 +4723,6 @@
</Filter>
</Filter>
</Filter>
- <Filter
- Name="misc files"
- >
- <File
- RelativePath="..\BUGS"
- >
- </File>
- <File
- RelativePath="..\CHANGELOG"
- >
- </File>
- <File
- RelativePath="..\i18n\pgadmin3.lng"
- >
- </File>
- <File
- RelativePath="..\programmers-readme.txt"
- >
- </File>
- <File
- RelativePath="..\TODO"
- >
- </File>
- </Filter>
</Files>
<Globals>
</Globals>

0 comments on commit d2c43ae

Please sign in to comment.