Added documentation.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/apps/gorm/trunk@21573 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Gregory John Casamento 2005-07-30 13:22:42 +00:00
parent 689c79c572
commit 738aefb672
10 changed files with 129 additions and 82 deletions

View file

@ -1,3 +1,16 @@
2005-07-30 09:30 Gregory John Casamento <greg_casamento@yahoo.com>
* Documentation/Makefile.postamble: Generate documentation from
headers only.
* GormPrefs/GormColorsPref.h
* GormPrefs/GormGeneralPref.h
* GormPrefs/GormGeneralPref.m
* GormPrefs/GormGuidelinePref.h
* GormPrefs/GormHeadersPref.h
* GormPrefs/GormPalettesPref.h
* GormPrefs/GormPrefController.h
* GormPrefs/GormShelfPref.h: Added documentation.
2005-07-30 04:29 Gregory John Casamento <greg_casamento@yahoo.com>
* GormCore/GormFilePrefsManager.h: Added documentation.

View file

@ -19,15 +19,15 @@ before-all:: version.texi
autogsdoc -MakeFrames YES \
-DocumentationDirectory GormCore \
-Declared GormCore \
../GormCore/*.[hm] 2> /dev/null
../GormCore/*.h 2> /dev/null
autogsdoc -MakeFrames YES \
-DocumentationDirectory GormPrefs \
-Declared GormPrefs \
../GormPrefs/*.[hm] 2> /dev/null
../GormPrefs/*.h 2> /dev/null
autogsdoc -MakeFrames YES \
-DocumentationDirectory GormObjCHeaderParser \
-Declared GormObjCHeaderParser \
../GormObjCHeaderParser/*.[hm] 2> /dev/null
../GormObjCHeaderParser/*.h 2> /dev/null
# Things to do after compiling
# after-all::

View file

@ -37,7 +37,15 @@
NSWindow *window;
id _view;
}
/**
* View to be shown.
*/
- (NSView *) view;
/**
* Set the colors.
*/
- (void)ok: (id)sender;
@end

View file

@ -8,19 +8,24 @@
{
id window;
id backupButton;
id inspectorButton;
id palettesButton;
id archiveMatrix;
id interfaceMatrix;
id _view;
}
/**
* View to be shown.
*/
- (NSView *) view;
- (void) palettesAction: (id)sender;
- (void) inspectorAction: (id)sender;
/**
* Should create a backup file.
*/
- (void) backupAction: (id)sender;
- (void) archiveAction: (id)sender;
/**
* Show the classes view as a browser or an outline.
*/
- (void) classesAction: (id)sender;
@end

View file

@ -34,10 +34,7 @@
#include <GormCore/GormClassEditor.h>
static NSString *SHOWPALETTES=@"ShowPalettes";
static NSString *SHOWINSPECTOR=@"ShowInspectors";
static NSString *BACKUPFILE=@"BackupFile";
static NSString *ARCTYPE=@"ArchiveType";
static NSString *INTTYPE=@"ClassViewType";
@implementation GormGeneralPref
@ -59,33 +56,10 @@ static NSString *INTTYPE=@"ClassViewType";
//Defaults
{
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
NSString *arcType = [defaults stringForKey: ARCTYPE];
NSString *intType = [defaults stringForKey: INTTYPE];
[inspectorButton setState: [defaults integerForKey: SHOWINSPECTOR]];
[palettesButton setState: [defaults integerForKey: SHOWPALETTES]];
[backupButton setState: [defaults integerForKey: BACKUPFILE]];
// set the archive matrix...
if([arcType isEqual: @"Typed"])
{
[archiveMatrix setState: NSOnState atRow: 0 column: 0];
[archiveMatrix setState: NSOffState atRow: 1 column: 0];
[archiveMatrix setState: NSOffState atRow: 2 column: 0];
}
else if([arcType isEqual: @"Keyed"])
{
[archiveMatrix setState: NSOffState atRow: 0 column: 0];
[archiveMatrix setState: NSOnState atRow: 1 column: 0];
[archiveMatrix setState: NSOffState atRow: 2 column: 0];
}
else if([arcType isEqual: @"Both"])
{
[archiveMatrix setState: NSOffState atRow: 0 column: 0];
[archiveMatrix setState: NSOffState atRow: 1 column: 0];
[archiveMatrix setState: NSOnState atRow: 2 column: 0];
}
// set the interface matrix...
if([intType isEqual: @"Outline"])
{
@ -113,31 +87,6 @@ static NSString *INTTYPE=@"ClassViewType";
return _view;
}
/* IBActions */
- (void) palettesAction: (id)sender
{
if (sender != palettesButton)
return;
else
{
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
[defaults setInteger:[palettesButton state] forKey:SHOWPALETTES];
}
}
- (void) inspectorAction: (id)sender
{
if (sender != inspectorButton)
return;
else
{
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
[defaults setInteger:[inspectorButton state] forKey:SHOWINSPECTOR];
}
}
- (void) backupAction: (id)sender
{
if (sender != backupButton)
@ -149,28 +98,6 @@ static NSString *INTTYPE=@"ClassViewType";
}
}
- (void) archiveAction: (id)sender
{
if (sender != archiveMatrix)
return;
else
{
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
if([[archiveMatrix cellAtRow: 0 column: 0] state] == NSOnState)
{
[defaults setObject: @"Typed" forKey: ARCTYPE];
}
else if([[archiveMatrix cellAtRow: 1 column: 0] state] == NSOnState)
{
[defaults setObject: @"Keyed" forKey: ARCTYPE];
}
else if([[archiveMatrix cellAtRow: 2 column: 0] state] == NSOnState)
{
[defaults setObject: @"Both" forKey: ARCTYPE];
}
}
}
- (void) classesAction: (id)sender
{
if (sender != interfaceMatrix)

View file

@ -39,8 +39,19 @@
id currentSpacing;
id halfSpacing;
}
/**
* View to show in prefs panel.
*/
- (NSView *) view;
/**
* Called when the guidline preferences are changed.
*/
- (void)ok: (id)sender;
/**
* Reset to defaults.
*/
- (void)reset: (id)sender;
@end

View file

@ -16,9 +16,25 @@
NSMutableArray *headers;
}
/**
* View to show in prefs panel.
*/
- (NSView *) view;
/**
* Add a header.
*/
- (void) addAction: (id)sender;
/**
* Remove a header.
*/
- (void) removeAction: (id)sender;
/**
* Called when the "preload" switch is set.
*/
- (void) preloadAction: (id)sender;
@end

View file

@ -15,8 +15,20 @@
NSMutableArray *palettes;
}
/**
* View to be shown in the preferences panel.
*/
- (NSView *) view;
/**
* Add a palette to the list.
*/
- (void) addAction: (id)sender;
/**
* Remove a palette from the list.
*/
- (void) removeAction: (id)sender;
@end

View file

@ -1,3 +1,28 @@
/* GormShelfPref.m
*
* Copyright (C) 2003 Free Software Foundation, Inc.
*
* Author: Gregory Casamento <greg_casamento@yahoo.com>
* Date: February 2004
*
* This class is heavily based on work done by Enrico Sersale
* on ShelfPref.m for GWorkspace.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef INCLUDED_GormPrefController_h
#define INCLUDED_GormPrefController_h
@ -18,6 +43,9 @@
id _guidelineView;
}
/**
* Called when the popup is used to select a pref panel.
*/
- (void) popupAction: (id)sender;
@end

View file

@ -71,13 +71,40 @@ typedef enum {
int cellsWidth;
}
/**
* Sets the frame for the resize arrows.
*/
- (void)tile;
/**
* Called when the selection is changed.
*/
- (void)selectionChanged:(NSNotification *)n;
/**
* Invoked when the resizer widgets are moved.
*/
- (void)startMouseEvent:(NSEvent *)event
onResizer:(ArrResizer *)resizer;
/**
* Programmatically set a width.
*/
- (void)setNewWidth:(int)w;
/**
* Set the resizer back to the default width.
*/
- (IBAction)setDefaultWidth:(id)sender;
/**
* The view to display in the prefs panel.
*/
- (NSView *)view;
/**
* Return the current width.
*/
- (int) shelfCellsWidth;
@end