2 Copyright (C) 2000-2005 SKYRIX Software AG
4 This file is part of OpenGroupware.org.
6 OGo is free software; you can redistribute it and/or modify it under
7 the terms of the GNU Lesser General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
11 OGo is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with OGo; see the file COPYING. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 #ifndef __UIxComponent_H_
23 #define __UIxComponent_H_
25 #import <NGObjWeb/SoComponent.h>
26 #import <NGObjWeb/WOContext+SoObjects.h>
28 #import <SOGo/SOGoObject.h>
33 Common superclass for most components used in SOGo.
35 TODO: document facilities.
38 @class NSCalendarDate, NSTimeZone, NSMutableDictionary, SoUser;
40 @interface UIxComponent : SoComponent
42 NSMutableDictionary *queryParameters;
43 NSCalendarDate *_selectedDate;
46 - (NSString *)queryParameterForKey:(NSString *)_key;
47 - (NSDictionary *)queryParameters;
49 /* use this to set 'sticky' query parameters */
50 - (void)setQueryParameter:(NSString *)_param forKey:(NSString *)_key;
52 /* date related query parameters */
53 - (NSDictionary *)queryParametersBySettingSelectedDate:(NSCalendarDate *)_date;
54 - (void)setSelectedDateQueryParameter:(NSCalendarDate *)_newDate
55 inDictionary:(NSMutableDictionary *)_qp;
57 /* appends queryParameters to _method if any are set */
58 - (NSString *)completeHrefForMethod:(NSString *)_method;
60 - (NSString *)ownMethodName;
62 - (NSString *)userFolderPath;
63 - (NSString *) applicationPath;
65 - (NSString *)ownPath;
66 - (NSString *)relativePathToUserFolderSubPath:(NSString *)_sub;
69 - (NSCalendarDate *) selectedDate;
71 - (NSString *)dateStringForDate:(NSCalendarDate *)_date;
75 - (UIxComponent *) jsCloseWithRefreshMethod: (NSString *) methodName;
79 - (NSString *)shortUserNameForDisplay;
82 - (NSString *)labelForKey:(NSString *)_key;
84 - (NSString *)localizedNameForDayOfWeek:(unsigned)_dayOfWeek;
85 - (NSString *)localizedAbbreviatedNameForDayOfWeek:(unsigned)_dayOfWeek;
86 - (NSString *)localizedNameForMonthOfYear:(unsigned)_monthOfYear;
87 - (NSString *)localizedAbbreviatedNameForMonthOfYear:(unsigned)_monthOfYear;
89 /* HTTP method safety */
90 - (BOOL)isInvokedBySafeMethod;
93 - (NSDictionary *)locale;
95 /* cached resource filenames */
96 - (WOResourceManager *) pageResourceManager;
97 - (NSString *) urlForResourceFilename: (NSString *) filename;
100 - (BOOL)isUIxDebugEnabled;
104 #endif /* __UIxComponent_H_ */