From 742bc0e4a49bc39222f25fd7de19b832bce769bf Mon Sep 17 00:00:00 2001 From: opensides Date: Tue, 1 Nov 2005 18:13:09 +0000 Subject: [PATCH] moved the html and latex to devel directory git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@1778 594d385d-05f5-0310-b6e9-bd551577e9d8 --- doc/guide/devel/html/annotated.html | 19 ++ .../devel/html/classmailAccount-members.html | 60 ++++ doc/guide/devel/html/classmailAccount.html | 224 +++++++++++++ doc/guide/devel/html/classmailAccount.png | Bin 0 -> 327 bytes doc/guide/devel/html/classplugin-members.html | 33 ++ doc/guide/devel/html/classplugin.html | 294 ++++++++++++++++++ doc/guide/devel/html/classplugin.png | Bin 0 -> 602 bytes .../devel/html/classposixAccount-members.html | 66 ++++ doc/guide/devel/html/classposixAccount.html | 219 +++++++++++++ doc/guide/devel/html/classposixAccount.png | Bin 0 -> 343 bytes doc/guide/devel/html/classuser-members.html | 82 +++++ doc/guide/devel/html/classuser.html | 271 ++++++++++++++++ doc/guide/devel/html/classuser.png | Bin 0 -> 275 bytes doc/guide/devel/html/doxygen.css | 160 ++++++++++ doc/guide/devel/html/doxygen.png | Bin 0 -> 2352 bytes doc/guide/devel/html/functions.html | 25 ++ doc/guide/devel/html/functions_func.html | 20 ++ doc/guide/devel/html/functions_vars.html | 23 ++ doc/guide/devel/html/hierarchy.html | 21 ++ doc/guide/devel/html/index.html | 15 + doc/guide/devel/latex/Makefile | 39 +++ doc/guide/devel/latex/annotated.tex | 7 + doc/guide/devel/latex/classmailAccount.eps | 197 ++++++++++++ doc/guide/devel/latex/classmailAccount.tex | 175 +++++++++++ doc/guide/devel/latex/classplugin.eps | 207 ++++++++++++ doc/guide/devel/latex/classplugin.tex | 166 ++++++++++ doc/guide/devel/latex/classposixAccount.eps | 197 ++++++++++++ doc/guide/devel/latex/classposixAccount.tex | 184 +++++++++++ doc/guide/devel/latex/classuser.eps | 197 ++++++++++++ doc/guide/devel/latex/classuser.tex | 236 ++++++++++++++ doc/guide/devel/latex/doxygen.sty | 65 ++++ doc/guide/devel/latex/hierarchy.tex | 9 + doc/guide/devel/latex/refman.tex | 40 +++ 33 files changed, 3251 insertions(+) create mode 100644 doc/guide/devel/html/annotated.html create mode 100644 doc/guide/devel/html/classmailAccount-members.html create mode 100644 doc/guide/devel/html/classmailAccount.html create mode 100644 doc/guide/devel/html/classmailAccount.png create mode 100644 doc/guide/devel/html/classplugin-members.html create mode 100644 doc/guide/devel/html/classplugin.html create mode 100644 doc/guide/devel/html/classplugin.png create mode 100644 doc/guide/devel/html/classposixAccount-members.html create mode 100644 doc/guide/devel/html/classposixAccount.html create mode 100644 doc/guide/devel/html/classposixAccount.png create mode 100644 doc/guide/devel/html/classuser-members.html create mode 100644 doc/guide/devel/html/classuser.html create mode 100644 doc/guide/devel/html/classuser.png create mode 100644 doc/guide/devel/html/doxygen.css create mode 100644 doc/guide/devel/html/doxygen.png create mode 100644 doc/guide/devel/html/functions.html create mode 100644 doc/guide/devel/html/functions_func.html create mode 100644 doc/guide/devel/html/functions_vars.html create mode 100644 doc/guide/devel/html/hierarchy.html create mode 100644 doc/guide/devel/html/index.html create mode 100644 doc/guide/devel/latex/Makefile create mode 100644 doc/guide/devel/latex/annotated.tex create mode 100644 doc/guide/devel/latex/classmailAccount.eps create mode 100644 doc/guide/devel/latex/classmailAccount.tex create mode 100644 doc/guide/devel/latex/classplugin.eps create mode 100644 doc/guide/devel/latex/classplugin.tex create mode 100644 doc/guide/devel/latex/classposixAccount.eps create mode 100644 doc/guide/devel/latex/classposixAccount.tex create mode 100644 doc/guide/devel/latex/classuser.eps create mode 100644 doc/guide/devel/latex/classuser.tex create mode 100644 doc/guide/devel/latex/doxygen.sty create mode 100644 doc/guide/devel/latex/hierarchy.tex create mode 100644 doc/guide/devel/latex/refman.tex diff --git a/doc/guide/devel/html/annotated.html b/doc/guide/devel/html/annotated.html new file mode 100644 index 000000000..495245a68 --- /dev/null +++ b/doc/guide/devel/html/annotated.html @@ -0,0 +1,19 @@ + + +GOsa: Annotated Index + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

GOsa Compound List

Here are the classes, structs, unions and interfaces with brief descriptions: + + + + +
mailAccountMail plugin
pluginThe plugin base class
posixAccountPosixAccount plugin
userUser plugin
+
Generated on Sat Jul 26 18:32:22 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classmailAccount-members.html b/doc/guide/devel/html/classmailAccount-members.html new file mode 100644 index 000000000..fddd4a8b8 --- /dev/null +++ b/doc/guide/devel/html/classmailAccount-members.html @@ -0,0 +1,60 @@ + + +GOsa: Member List + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

mailAccount Member List

This is the complete list of members for mailAccount, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
acl (defined in plugin)plugin
adapt_from_template($dn) (defined in mailAccount)mailAccount
addAlternate($address) (defined in mailAccount)mailAccount
addForwarder($address) (defined in mailAccount)mailAccount
admins (defined in mailAccount)mailAccount
attributes (defined in mailAccount)mailAccount
attrsplugin
check() (defined in mailAccount)mailAccount
default_permissions (defined in mailAccount)mailAccount
delAlternate($addresses) (defined in mailAccount)mailAccount
delForwarder($addresses) (defined in mailAccount)mailAccount
dnplugin
execute()mailAccount
folder_prefix (defined in mailAccount)mailAccount
forward_dialog (defined in mailAccount)mailAccount
getImapAttributes() (defined in mailAccount)mailAccount
givenName (defined in plugin)plugin
gosaMailAlternateAddress (defined in mailAccount)mailAccount
gosaMailDeliveryMode (defined in mailAccount)mailAccount
gosaMailForwardingAddress (defined in mailAccount)mailAccount
gosaMailMaxSize (defined in mailAccount)mailAccount
gosaMailQuota (defined in mailAccount)mailAccount
gosaMailServer (defined in mailAccount)mailAccount
gosaSpamMailbox (defined in mailAccount)mailAccount
gosaSpamSortLevel (defined in mailAccount)mailAccount
gosaVacationMessage (defined in mailAccount)mailAccount
is_accountplugin
is_templateplugin
mail (defined in mailAccount)mailAccount
mailAccount($dn=NULL, $shared_folder=FALSE) (defined in mailAccount)mailAccount
mailboxList (defined in mailAccount)mailAccount
member_permissions (defined in mailAccount)mailAccount
members (defined in mailAccount)mailAccount
objectclasses (defined in mailAccount)mailAccount
parentplugin
password_change_needed() (defined in plugin)plugin
perms (defined in mailAccount)mailAccount
plugin($dn=NULL)plugin
quotaUsage (defined in mailAccount)mailAccount
remove_from_parent() (defined in mailAccount)mailAccount
save() (defined in mailAccount)mailAccount
save_object() (defined in mailAccount)mailAccount
setImapAttributes() (defined in mailAccount)mailAccount
setSieveAttributes() (defined in mailAccount)mailAccount
sn (defined in plugin)plugin
uid (defined in plugin)plugin
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classmailAccount.html b/doc/guide/devel/html/classmailAccount.html new file mode 100644 index 000000000..febb30e7a --- /dev/null +++ b/doc/guide/devel/html/classmailAccount.html @@ -0,0 +1,224 @@ + + +GOsa: mailAccount class Reference + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

mailAccount Class Reference

mail plugin +More... +

+

Inheritance diagram for mailAccount: +

+ +plugin + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ mailAccount ($dn=NULL, $shared_folder=FALSE)
+ getImapAttributes ()
+ setImapAttributes ()
+ setSieveAttributes ()
 execute ()
 execute plugin

+ remove_from_parent ()
+ save_object ()
+ save ()
+ check ()
+ adapt_from_template ($dn)
+ addForwarder ($address)
+ delForwarder ($addresses)
+ addAlternate ($address)
+ delAlternate ($addresses)

Public Attributes

+ mail = ""
+ gosaMailAlternateAddress = array()
+ gosaMailForwardingAddress = array()
+ gosaMailDeliveryMode = "[L ]"
+ gosaMailServer = ""
+ gosaMailQuota = ""
+ gosaMailMaxSize = ""
+ gosaVacationMessage = ""
+ gosaSpamSortLevel = ""
+ gosaSpamMailbox = ""
+ quotaUsage = 0
+ forward_dialog = FALSE
+ folder_prefix = ""
+ mailboxList = array()
+ default_permissions = "none"
+ member_permissions = "post"
+ members = array()
+ admins = array()
 perms
 attributes
+ objectclasses = array("gosaMailAccount")
+

Detailed Description

+mail plugin +

+

Author:
Cajus Pollmeier <pollmeier@gonicus.de>
+
Version:
2.00
+
Date:
24.07.2003
+This class provides the functionality to read and write all attributes relevant for gosaMailAccounts from/to the LDAP. It does syntax checking and displays the formulars required. +

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
mailAccount::execute (   ) 
+
+ + + + + +
+   + + +

+execute plugin +

+Generates the html output for this node +

+Reimplemented from plugin.

+

Member Data Documentation

+

+ + + + +
+ + +
mailAccount::attributes +
+
+ + + + + +
+   + + +

+Initial value:

 array("mail", "gosaMailServer", "gosaMailQuota", "gosaMailMaxSize",
+                        "gosaMailDeliveryMode", "gosaSpamSortLevel", "gosaSpamMailbox",
+                        "gosaVacationMessage", "uid")
+
+

+Reimplemented from plugin.

+

+ + + + +
+ + +
mailAccount::perms +
+
+ + + + + +
+   + + +

+Initial value:

 array( "lrs" => "read", "lrsp" => "post", "lrsip" => "append",
+                        "lrswipcd" => "write", "lrswipcda" => "all" )
+
+

The documentation for this class was generated from the following file: +
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classmailAccount.png b/doc/guide/devel/html/classmailAccount.png new file mode 100644 index 0000000000000000000000000000000000000000..12cfc1752e5e657cd4ac5856540e5fe44b1bbfb7 GIT binary patch literal 327 zcmeAS@N?(olHy`uVBq!ia0vp^fj}I%Gsd>it!nPqTBq%}#Uf|Ng1q|1RGpf3@?DuHN};@}AbW zsT|inmF;wY@62cU#8p-5uyy{LVlU33i@SuUS?*bP0l+XkKTm6!H literal 0 HcmV?d00001 diff --git a/doc/guide/devel/html/classplugin-members.html b/doc/guide/devel/html/classplugin-members.html new file mode 100644 index 000000000..ab6292b22 --- /dev/null +++ b/doc/guide/devel/html/classplugin-members.html @@ -0,0 +1,33 @@ + + +GOsa: Member List + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

plugin Member List

This is the complete list of members for plugin, including all inherited members. + + + + + + + + + + + + + + + + + + + +
acl (defined in plugin)plugin
adapt_from_template($dn) (defined in plugin)plugin
attributes (defined in plugin)plugin
attrsplugin
check() (defined in plugin)plugin
dnplugin
execute()plugin
givenName (defined in plugin)plugin
is_accountplugin
is_templateplugin
objectclasses (defined in plugin)plugin
parentplugin
password_change_needed() (defined in plugin)plugin
plugin($dn=NULL)plugin
remove_from_parent() (defined in plugin)plugin
save() (defined in plugin)plugin
save_object() (defined in plugin)plugin
sn (defined in plugin)plugin
uid (defined in plugin)plugin
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classplugin.html b/doc/guide/devel/html/classplugin.html new file mode 100644 index 000000000..edc1cb63b --- /dev/null +++ b/doc/guide/devel/html/classplugin.html @@ -0,0 +1,294 @@ + + +GOsa: plugin class Reference + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

plugin Class Reference

The plugin base class. +More... +

+

Inheritance diagram for plugin: +

+ +mailAccount +posixAccount +user + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 plugin ($dn=NULL)
 plugin constructor

 execute ()
 execute plugin

+ remove_from_parent ()
+ save_object ()
+ save ()
+ check ()
+ adapt_from_template ($dn)
+ password_change_needed ()

Public Attributes

 parent = NULL
 Reference to parent object.

 is_account = FALSE
 Mark plugin as account.

 is_template = FALSE
 Mark plugin as template.

 attrs = array()
 Represent temporary LDAP data.

 dn = ""
 Used standard values.

+ uid = ""
+ sn = ""
+ givenName = ""
+ acl = "*none*"
+ attributes = array()
+ objectclasses = array()
+

Detailed Description

+The plugin base class. +

+

Author:
Cajus Pollmeier <pollmeier@gonicus.de>
+
Version:
2.00
+
Date:
24.07.2003
+This is the base class for all plugins. It can be used standalone or can be included by the tabs class. All management should be done within this class. Extend your plugins from this class. +

+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + + +
plugin::plugin ( $  dn = NULL  ) 
+
+ + + + + +
+   + + +

+plugin constructor +

+If 'dn' is set, the node loads the given 'dn' from LDAP

+

Parameters:
+ + +
dn Distinguished name to initialize plugin from
+
+
See also:
plugin()
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
plugin::execute (   ) 
+
+ + + + + +
+   + + +

+execute plugin +

+Generates the html output for this node +

+Reimplemented in mailAccount, posixAccount, and user.

+

Member Data Documentation

+

+ + + + +
+ + +
plugin::attrs = array() +
+
+ + + + + +
+   + + +

+Represent temporary LDAP data. +

+This is only used internally.

+

+ + + + +
+ + +
plugin::dn = "" +
+
+ + + + + +
+   + + +

+Used standard values. +

+dn

+

+ + + + +
+ + +
plugin::is_account = FALSE +
+
+ + + + + +
+   + + +

+Mark plugin as account. +

+Defines whether this plugin is defined as an account or not. This has consequences for the plugin to be saved from tab mode. If it is set to 'FALSE' the tab will call the delete function, else the save function. Should be set to 'TRUE' if the construtor detects a valid LDAP object.

+

See also:
plugin::plugin()
+
+

+ + + + +
+ + +
plugin::is_template = FALSE +
+
+ + + + + +
+   + + +

+Mark plugin as template. +

+Defines whether we are creating a template or a normal object. Has conseqences on the way execute() shows the formular and how save() puts the data to LDAP.

+

See also:
plugin::save() plugin::execute()
+
+

+ + + + +
+ + +
plugin::parent = NULL +
+
+ + + + + +
+   + + +

+Reference to parent object. +

+This variable is used when the plugin is included in tabs and keeps reference to the tab class. Communication to other tabs is possible by 'name'. So the 'fax' plugin can ask the 'userinfo' plugin for the fax number.

+

See also:
tab
+
+

The documentation for this class was generated from the following file: +
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classplugin.png b/doc/guide/devel/html/classplugin.png new file mode 100644 index 0000000000000000000000000000000000000000..7853333be91edcf1f86bf2d49ac96fc910a6db5f GIT binary patch literal 602 zcmeAS@N?(olHy`uVBq!ia0y~yV3Yx}16Y`Wq^0@w0w5(3;1lBd|Nnm=^Z)+?^XDf_ z0J6aNz<~qRhyFhSav4j4{DK)Ap4~_TvOjpbIEGZrc{@Ei@34Y^>tX->XWuZCv%hVd zpjG+bTf?7Srp?InSn|p{E_Dpwi%c38-N_5dY&!9oGV`Uc&V4T2()__f%SP9b~j?MrX0O5LS|I_7+ + +GOsa: Member List + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

posixAccount Member List

This is the complete list of members for posixAccount, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
acl (defined in plugin)plugin
adapt_from_template($dn) (defined in posixAccount)posixAccount
addGroup($groups) (defined in posixAccount)posixAccount
attributes (defined in posixAccount)posixAccount
attrsplugin
check() (defined in posixAccount)posixAccount
delGroup($groups) (defined in posixAccount)posixAccount
dnplugin
execute()posixAccount
force_ids (defined in posixAccount)posixAccount
gecos (defined in posixAccount)posixAccount
gidNumber (defined in posixAccount)posixAccount
givenName (defined in plugin)plugin
gosaDefaultLanguage (defined in posixAccount)posixAccount
gosaDefaultPrinter (defined in posixAccount)posixAccount
gosaHostACL (defined in posixAccount)posixAccount
group_dialog (defined in posixAccount)posixAccount
groupMembership (defined in posixAccount)posixAccount
homeDirectory (defined in posixAccount)posixAccount
hosts_dialog (defined in posixAccount)posixAccount
is_accountplugin
is_templateplugin
loginShell (defined in posixAccount)posixAccount
loginShellList (defined in posixAccount)posixAccount
must_change_password (defined in posixAccount)posixAccount
objectclasses (defined in posixAccount)posixAccount
parentplugin
password_change_needed() (defined in plugin)plugin
plugin($dn=NULL)plugin
posixAccount($dn=NULL) (defined in posixAccount)posixAccount
printerList (defined in posixAccount)posixAccount
remove_from_parent() (defined in posixAccount)posixAccount
save() (defined in posixAccount)posixAccount
save_object() (defined in posixAccount)posixAccount
savedGidNumber (defined in posixAccount)posixAccount
savedGroupMembership (defined in posixAccount)posixAccount
savedUidNumber (defined in posixAccount)posixAccount
shadowExpire (defined in posixAccount)posixAccount
shadowInactive (defined in posixAccount)posixAccount
shadowLastChange (defined in posixAccount)posixAccount
shadowMax (defined in posixAccount)posixAccount
shadowMin (defined in posixAccount)posixAccount
shadowWarning (defined in posixAccount)posixAccount
sn (defined in plugin)plugin
status (defined in posixAccount)posixAccount
uid (defined in plugin)plugin
uidNumber (defined in posixAccount)posixAccount
use_shadowExpire (defined in posixAccount)posixAccount
use_shadowInactive (defined in posixAccount)posixAccount
use_shadowMax (defined in posixAccount)posixAccount
use_shadowMin (defined in posixAccount)posixAccount
use_shadowWarning (defined in posixAccount)posixAccount
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classposixAccount.html b/doc/guide/devel/html/classposixAccount.html new file mode 100644 index 000000000..f7f0ee3e0 --- /dev/null +++ b/doc/guide/devel/html/classposixAccount.html @@ -0,0 +1,219 @@ + + +GOsa: posixAccount class Reference + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

posixAccount Class Reference

posixAccount plugin +More... +

+

Inheritance diagram for posixAccount: +

+ +plugin + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ posixAccount ($dn=NULL)
 execute ()
 execute plugin

+ remove_from_parent ()
+ save_object ()
+ save ()
+ check ()
+ addGroup ($groups)
+ delGroup ($groups)
+ adapt_from_template ($dn)

Public Attributes

+ homeDirectory = ""
+ loginShell = "/bin/bash"
+ uidNumber = ""
+ gidNumber = ""
+ gecos = ""
+ shadowMin = "0"
+ shadowMax = "0"
+ shadowWarning = "0"
+ shadowLastChange = "0"
+ shadowInactive = "0"
+ shadowExpire = "0"
+ gosaDefaultPrinter = ""
+ gosaDefaultLanguage = ""
+ gosaHostACL = array()
+ status = ""
+ loginShellList = array()
+ groupMembership = array()
+ savedGroupMembership = array()
+ savedUidNumber = ""
+ savedGidNumber = ""
+ use_shadowMin = "0"
+ use_shadowMax = "0"
+ use_shadowWarning = "0"
+ use_shadowInactive = "0"
+ use_shadowExpire = "0"
+ must_change_password = "0"
+ force_ids = 0
+ printerList = array()
+ group_dialog = FALSE
+ hosts_dialog = FALSE
 attributes
+ objectclasses = array("posixAccount", "shadowAccount")
+

Detailed Description

+posixAccount plugin +

+

Author:
Cajus Pollmeier <pollmeier@gonicus.de>
+
Version:
2.00
+
Date:
24.07.2003
+This class provides the functionality to read and write all attributes relevant for posixAccounts and shadowAccounts from/to the LDAP. It does syntax checking and displays the formulars required. +

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
posixAccount::execute (   ) 
+
+ + + + + +
+   + + +

+execute plugin +

+Generates the html output for this node +

+Reimplemented from plugin.

+

Member Data Documentation

+

+ + + + +
+ + +
posixAccount::attributes +
+
+ + + + + +
+   + + +

+Initial value:

 array("homeDirectory", "loginShell", "uidNumber", "gidNumber", "gecos",
+                        "shadowMin", "shadowMax", "shadowWarning", "shadowInactive", "shadowLastChange",
+                        "shadowExpire", "gosaDefaultPrinter", "gosaDefaultLanguage", "uid")
+
+

+Reimplemented from plugin.

+

The documentation for this class was generated from the following file:
    +
  • class_posixAccount.inc
+
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classposixAccount.png b/doc/guide/devel/html/classposixAccount.png new file mode 100644 index 0000000000000000000000000000000000000000..71dee1342af8a640f1a1604412c2553e26983d5b GIT binary patch literal 343 zcmeAS@N?(olHy`uVBq!ia0vp^5kMTk!VDzyU#!mpQW60^A+G=b{|7Sv|35H)e!>JG z3ycpOI8c4){}UjWu_VYZn8D%MjWi(Vt*47)NX4ADS5EUDGT>pj@Z-?Ub8KzA35tGq z>scPv{PLILR?_I|j#95J(iOjIBa-;;`l}s(*`G~`;I&(mb29NYUy*oP^pPhW3EyTu zRobTftl$?PpKbA*pDQ-`H0RDamME=Rc5Lq9*NdK>+ERIQ{~z(c5@EGm-yYArSuY*m z7FHo4QoEvHcV@|*!sD{y2AYQw{yu*2Mk1cec8T3?>eFPxL0o9u(OgaEUIB9F3Zx3#oRZiP=sW3am2$ww>GIW`~I*`ylh=lmf@szI** m@`XJI%XXNZ>olF;B<>@)>d#Wsw^xB4XYh3Ob6Mw<&;$S!5tJkV literal 0 HcmV?d00001 diff --git a/doc/guide/devel/html/classuser-members.html b/doc/guide/devel/html/classuser-members.html new file mode 100644 index 000000000..db776f137 --- /dev/null +++ b/doc/guide/devel/html/classuser-members.html @@ -0,0 +1,82 @@ + + +GOsa: Member List + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

user Member List

This is the complete list of members for user, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
academicTitle (defined in user)user
acl (defined in plugin)plugin
adapt_from_template($dn) (defined in plugin)plugin
attributes (defined in user)user
attrsplugin
base (defined in user)user
cert_dialog (defined in user)user
certificateSerialNumber (defined in user)user
check() (defined in user)user
cn (defined in user)user
departmentNumber (defined in user)user
dnplugin
employeeNumber (defined in user)user
employeeType (defined in user)user
execute()user
facsimileTelephoneNumber (defined in user)user
functionalTitle (defined in user)user
givenName (defined in plugin)plugin
gouvernmentOrganizationalPersonLocality (defined in user)user
gouvernmentOrganizationalUnit (defined in user)user
gouvernmentOrganizationalUnitDescription (defined in user)user
gouvernmentOrganizationalUnitSubjectArea (defined in user)user
homePhone (defined in user)user
homePostalAddress (defined in user)user
houseIdentifier (defined in user)user
is_accountplugin
is_templateplugin
ivbbLastDeliveryCollective (defined in user)user
jpegPhoto (defined in user)user
l (defined in user)user
labeledURI (defined in user)user
last_pw_storage (defined in user)user
mobile (defined in user)user
o (defined in user)user
objectclasses (defined in user)user
old_certificateSerialNumber (defined in user)user
old_jpegPhoto (defined in user)user
old_photoData (defined in user)user
old_userCertificate (defined in user)user
old_userPKCS12 (defined in user)user
old_userSMIMECertificate (defined in user)user
ou (defined in user)user
pager (defined in user)user
parentplugin
password_change_needed() (defined in plugin)plugin
personalTitle (defined in user)user
photoData (defined in user)user
picture_dialog (defined in user)user
plugin($dn=NULL)plugin
postalAddress (defined in user)user
postalCode (defined in user)user
publicVisible (defined in user)user
pw_storage (defined in user)user
remove_from_parent() (defined in user)user
role (defined in user)user
roomNumber (defined in user)user
save() (defined in user)user
save_object() (defined in user)user
sn (defined in plugin)plugin
st (defined in user)user
street (defined in user)user
telephoneNumber (defined in user)user
uid (defined in plugin)plugin
user($dn=NULL) (defined in user)user
userCertificate (defined in user)user
userPKCS12 (defined in user)user
userSMIMECertificate (defined in user)user
vocation (defined in user)user
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classuser.html b/doc/guide/devel/html/classuser.html new file mode 100644 index 000000000..38102e886 --- /dev/null +++ b/doc/guide/devel/html/classuser.html @@ -0,0 +1,271 @@ + + +GOsa: user class Reference + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

user Class Reference

user plugin +More... +

+

Inheritance diagram for user: +

+ +plugin + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ user ($dn=NULL)
 execute ()
 execute plugin

+ remove_from_parent ()
+ save_object ()
+ save ()
+ check ()

Public Attributes

+ base = ""
+ cn = ""
+ personalTitle = ""
+ academicTitle = ""
+ homePostalAddress = ""
+ homePhone = ""
+ labeledURI = ""
+ o = ""
+ ou = ""
+ departmentNumber = ""
+ employeeNumber = ""
+ employeeType = ""
+ roomNumber = ""
+ telephoneNumber = ""
+ facsimileTelephoneNumber = ""
+ mobile = ""
+ pager = ""
+ l = ""
+ st = ""
+ postalAddress = ""
+ jpegPhoto = "*removed*"
+ photoData = ""
+ old_jpegPhoto = ""
+ old_photoData = ""
+ cert_dialog = FALSE
+ picture_dialog = FALSE
+ userPKCS12 = ""
+ userSMIMECertificate = ""
+ userCertificate = ""
+ certificateSerialNumber = ""
+ old_certificateSerialNumber = ""
+ old_userPKCS12 = ""
+ old_userSMIMECertificate = ""
+ old_userCertificate = ""
+ gouvernmentOrganizationalUnit = ""
+ houseIdentifier = ""
+ street = ""
+ postalCode = ""
+ vocation = ""
+ ivbbLastDeliveryCollective = ""
+ gouvernmentOrganizationalPersonLocality = ""
+ gouvernmentOrganizationalUnitDescription = ""
+ gouvernmentOrganizationalUnitSubjectArea = ""
+ functionalTitle = ""
+ role = ""
+ publicVisible = ""
+ pw_storage = "crypt"
+ last_pw_storage = "crypt"
 attributes
+ objectclasses = array("person", "organizationalPerson", "inetOrgPerson", "gosaAccount")
+

Detailed Description

+user plugin +

+

Author:
Cajus Pollmeier <pollmeier@gonicus.de>
+
Version:
2.00
+
Date:
24.07.2003
+This class provides the functionality to read and write all attributes relevant for person, organizationalPerson, inetOrgPerson and gosaAccount from/to the LDAP. It does syntax checking and displays the formulars required. +

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
user::execute (   ) 
+
+ + + + + +
+   + + +

+execute plugin +

+Generates the html output for this node +

+Reimplemented from plugin.

+

Member Data Documentation

+

+ + + + +
+ + +
user::attributes +
+
+ + + + + +
+   + + +

+Initial value:

 array("sn", "givenName", "uid", "personalTitle", "academicTitle",
+        "homePostalAddress", "homePhone", "labeledURI", "o", "ou",
+        "departmentNumber", "employeeNumber", "employeeType", "l", "st",
+        "roomNumber", "telephoneNumber", "mobile", "pager", "cn", "userPKCS12",
+        "postalAddress", "facsimileTelephoneNumber", "userSMIMECertificate",
+        "gouvernmentOrganizationalUnit", "houseIdentifier", "vocation",
+        "ivbbLastDeliveryCollective", "gouvernmentOrganizationalPersonLocality",
+        "gouvernmentOrganizationalUnitDescription", "postalCode", "street",
+        "gouvernmentOrganizationalUnitSubjectArea", "functionalTitle",
+        "role", "certificateSerialNumber", "publicVisible")
+
+

+Reimplemented from plugin.

+

The documentation for this class was generated from the following file:
    +
  • class_user.inc
+
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/classuser.png b/doc/guide/devel/html/classuser.png new file mode 100644 index 0000000000000000000000000000000000000000..354ba28601d56acb3c0394d47e9e32ae0b9f0adf GIT binary patch literal 275 zcmeAS@N?(olHy`uVBq!ia0vp^dO#e&!VDy*?2p3NZkcv5PFB$S3R^VX`*qrk1JFidvg}4>M z-|d|q3kf;(hG?n25-?7f*ORLF;vxIp#p2sH$B13%yZ&{Rkn8iHsg=TO^3;nr@|2lZ z>*US;^KPeo(f?Dq^E!w$Dt z`j0}{`nLaH61p`TI(8Oro5Pv=cg~0E+HZ_9@t=+b{(3)W!`b3z)-o^V)_-D}trqgO T(4T!G(9sN@u6{1-oD!MB{P-jdO973>Gf8e9NRM)Dp)o!g0qM<4Vj=zPe@|Dq666;okhst+uYS@xk zAe#!=^Zln?PyVKr%6E;`S(kqWY=*HsfA1V;)fhQ<$CMos^=cI}FxoX8aHZD(`7N&D z>eW}uY`q&yA(Aq{v|hyY~*BV!IpRizEa^A zSwUf5fG8o|FrCa?7W_ZsbCSbIMfvD5rc2)xa_CE)&3MK>PdiZzPSx=EY{5R=Lw9$W zFB~Q4-_erioglSItWbyFcScK%P|Bx2nok_;7V~gL{^sw)Hmw`$rsv1K}`8Yt2#c0pX2g5sO;y1o~4%iuIyi#qw zFm*RC`MvCuf!1<4v?T_#Q{Sw>Dv=96=Qk`bvEfC+V}+C_G!9f5qp+Mfqpdo&v-7X2 zEsjl=2Zs2jpeR3I^jOrC#EnCRYK7ykw~Y<^$KBzQ$j?=wli)Z_dg%f@3mh@mn~ zY-rW-_)2Tp)x!)>H?E^r>=E{}#T=G-CW-@osY zch;71#~zaaQaCN&u+y;iqyJD$efQ0`ds~0bG7EEg?iz@?@KkW>xdI>kcON*eM-mkj z{Hg4Mq|yM@aKlnN8Ad!tqDiW7k~_vI0!L4-1Z&Wup7|~d>#qjJ0-uA&ia#r&mdx8v zh{Ysj=iMgA&&1A@moF|nsz(e)_;Uiol|tq()vU(gqOB|ji;{rH_>zyt2xSg9h+h{C zv+F5Xy#5KK7P)%}Ck#D|^?1V$N)szVm7J2X#m+w(imL|lM%~vBw^Q~q$CrnXoTf$H zzF~>!<$mS2O?lzwP|kfiF}g8jcl3mUEgkkkh%w!KZMvAFF9^}~ej@k#Gd^V_{0z7E zlS6D1*YZT=yhuXqJ9{VQ#HEDN*DR$8sI6F7<;IiQSrcoeN7g_o#?!`Af^b9`2;50K zitSJI72p0Sb8pZ7DS_NNl_sYR+va{vYOi<{J}UY2dXxVnRvC@qh1F8VTgYH6vT~(% zZ2N{=>^>N0x=jb@(&D^o^RLm}($~_;&Kub{C2Xfmah^5anC-b6$;BEl3*$8jem8}c z3*MM|I(n@y9TAF*ctIWJT!UQdUmM^y{K3@8sQJdNrafkJtINN7ONa1e;w?Mt{_JhM zvRka(c#HYT@E0V`S6xwQ!o-vU4DQhKh-)xd(lG?l6971ya~`Kg%#4-Zl9lG!@VLCj zn%e5Mm!q<2O$UGcRpXu>y%9VED_L9OY%qWuy3i~< z+emnMRoLY#-xm~rEgRP6atqF;dvM1{=%Q7NcKcBg&Z1l zV~6}Z`XPV+=bsYaz2&oFCc3ZEn}yXbvh;enHYUk;@jUTd(xG51%O-4mi-__eW*D%0++`&?dm# zPd_nXLUL4%gBDan;34>)_!5SOs{V7u1HVyR7H*pVx$aUUgqXX95@2i(7j1|H^I|!M zS3hU81OfgU9~=o25UZE}Kn~T?I2_2;b7HMR`%*)h);W}}SN$d(wjY3w22CPf3pSEK z`@JL}GUw`L^lZx+{KurgBTG8o(X~G|(-<9c9%;J8&^(JEc$Oi*N?=TC)Lzw#&F7Nl zHQB3u-YV(8aQrkAK!U7fLifRwqTWQcQt+0@;kmR<&^uK8n9YK;XTuDH?XY{HL*v09 z8svU;%Hhy$AH9$^e+pAEde;2I<;K%f*-dV3{IarZHE-WX1+D)GFP8KnOsc_^ z6q~mV=laSj_m1;^5X}%ECLfW5I$=E3`=TMVtLt?(a30*5=_&F*bvhx?FF`d>rP;x^MFfsMbkCxS5D-e^%!V{JsKKS`i`&ka` z-g#uQghXfa@Au4JFJ6eWrAEFVsOiW@X;hgN@VQgD2(fD=RxXatsl;WS2C1NQ5IP1br%vg@40K^|6=DP_ zk`iN1j)|m@h&uj}I)0bKLPIDz#87e&KcIbI4*IVgDKNyBa(Q1*52cUvH89j85a4h> zq`m + +GOsa: Compound Member Index + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+
All | Functions | Variables
+ +

+Here is a list of all documented class members with links to the class documentation for each member:

+
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/functions_func.html b/doc/guide/devel/html/functions_func.html new file mode 100644 index 000000000..dfcacf4e3 --- /dev/null +++ b/doc/guide/devel/html/functions_func.html @@ -0,0 +1,20 @@ + + +GOsa: Compound Member Index + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+
All | Functions | Variables
+ +

+

+
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/functions_vars.html b/doc/guide/devel/html/functions_vars.html new file mode 100644 index 000000000..808b44df6 --- /dev/null +++ b/doc/guide/devel/html/functions_vars.html @@ -0,0 +1,23 @@ + + +GOsa: Compound Member Index + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+
All | Functions | Variables
+ +

+

+
Generated on Sat Jul 26 18:32:23 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/hierarchy.html b/doc/guide/devel/html/hierarchy.html new file mode 100644 index 000000000..8ae523380 --- /dev/null +++ b/doc/guide/devel/html/hierarchy.html @@ -0,0 +1,21 @@ + + +GOsa: Hierarchical Index + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

GOsa Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
    +
  • acl
  • appGroup
  • application
  • blocklist
  • department
  • faxAccount
  • group
  • LDAP
  • link_info
  • plugin + +
  • pluginfo
  • proxyAccount
  • pureftpAccount
  • sambaAccount
  • server
  • userinfo
+
Generated on Sat Jul 26 18:32:22 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/html/index.html b/doc/guide/devel/html/index.html new file mode 100644 index 000000000..fa64b4cdf --- /dev/null +++ b/doc/guide/devel/html/index.html @@ -0,0 +1,15 @@ + + +GOsa: Main Page + + + +
Main Page | Class Hierarchy | Compound List | Compound Members
+

GOsa Documentation

+

+

2.00

Generated on Sat Jul 26 18:32:22 2003 for GOsa by + +doxygen +1.3.2
+ + diff --git a/doc/guide/devel/latex/Makefile b/doc/guide/devel/latex/Makefile new file mode 100644 index 000000000..e270675d5 --- /dev/null +++ b/doc/guide/devel/latex/Makefile @@ -0,0 +1,39 @@ +all: refman.dvi + +ps: refman.ps + +pdf: refman.pdf + +ps_2on1: refman_2on1.ps + +pdf_2on1: refman_2on1.pdf + +refman.ps: refman.dvi + dvips -o refman.ps refman.dvi + +refman.pdf: refman.ps + ps2pdf refman.ps refman.pdf + +refman.dvi: refman.tex doxygen.sty + echo "Running latex..." + latex refman.tex + echo "Running makeindex..." + makeindex refman.idx + echo "Rerunning latex...." + latex refman.tex + latex_count=5 ; \ + while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\ + do \ + echo "Rerunning latex...." ;\ + latex refman.tex ;\ + latex_count=`expr $$latex_count - 1` ;\ + done + +refman_2on1.ps: refman.ps + psnup -2 refman.ps >refman_2on1.ps + +refman_2on1.pdf: refman_2on1.ps + ps2pdf refman_2on1.ps refman_2on1.pdf + +clean: + rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out diff --git a/doc/guide/devel/latex/annotated.tex b/doc/guide/devel/latex/annotated.tex new file mode 100644 index 000000000..c23411486 --- /dev/null +++ b/doc/guide/devel/latex/annotated.tex @@ -0,0 +1,7 @@ +\section{GOsa Compound List} +Here are the classes, structs, unions and interfaces with brief descriptions:\begin{CompactList} +\item\contentsline{section}{{\bf mail\-Account} (Mail plugin )}{\pageref{classmailAccount}}{} +\item\contentsline{section}{{\bf plugin} (The plugin base class )}{\pageref{classplugin}}{} +\item\contentsline{section}{{\bf posix\-Account} (Posix\-Account plugin )}{\pageref{classposixAccount}}{} +\item\contentsline{section}{{\bf user} (User plugin )}{\pageref{classuser}}{} +\end{CompactList} diff --git a/doc/guide/devel/latex/classmailAccount.eps b/doc/guide/devel/latex/classmailAccount.eps new file mode 100644 index 000000000..f5f4b24da --- /dev/null +++ b/doc/guide/devel/latex/classmailAccount.eps @@ -0,0 +1,197 @@ +%!PS-Adobe-2.0 EPSF-2.0 +%%Title: ClassName +%%Creator: Doxygen +%%CreationDate: Time +%%For: +%Magnification: 1.00 +%%Orientation: Portrait +%%BoundingBox: 0 0 500 449.438 +%%Pages: 0 +%%BeginSetup +%%EndSetup +%%EndComments + +% ----- variables ----- + +/boxwidth 0 def +/boxheight 40 def +/fontheight 24 def +/marginwidth 10 def +/distx 20 def +/disty 40 def +/boundaspect 1.1125 def % aspect ratio of the BoundingBox (width/height) +/boundx 500 def +/boundy boundx boundaspect div def +/xspacing 0 def +/yspacing 0 def +/rows 2 def +/cols 1 def +/scalefactor 0 def +/boxfont /Times-Roman findfont fontheight scalefont def + +% ----- procedures ----- + +/dotted { [1 4] 0 setdash } def +/dashed { [5] 0 setdash } def +/solid { [] 0 setdash } def + +/max % result = MAX(arg1,arg2) +{ + /a exch def + /b exch def + a b gt {a} {b} ifelse +} def + +/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) +{ + 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max +} def + +/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) +{ + /str exch def + /boxwidth boxwidth str stringwidth pop max def +} def + +/box % draws a box with text `arg1' at grid pos (arg2,arg3) +{ gsave + 2 setlinewidth + newpath + exch xspacing mul xoffset add + exch yspacing mul + moveto + boxwidth 0 rlineto + 0 boxheight rlineto + boxwidth neg 0 rlineto + 0 boxheight neg rlineto + closepath + dup stringwidth pop neg boxwidth add 2 div + boxheight fontheight 2 div sub 2 div + rmoveto show stroke + grestore +} def + +/mark +{ newpath + exch xspacing mul xoffset add boxwidth add + exch yspacing mul + moveto + 0 boxheight 4 div rlineto + boxheight neg 4 div boxheight neg 4 div rlineto + closepath + eofill + stroke +} def + +/arrow +{ newpath + moveto + 3 -8 rlineto + -6 0 rlineto + 3 8 rlineto + closepath + eofill + stroke +} def + +/out % draws an output connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight add + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/in % draws an input connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul disty 2 div sub + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/hedge +{ + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight 2 div sub + /y exch def + /x exch def + newpath + x y moveto + boxwidth 2 div distx add 0 rlineto + stroke + 1 eq + { newpath x boxwidth 2 div distx add add y moveto + -8 3 rlineto + 0 -6 rlineto + 8 3 rlineto + closepath + eofill + stroke + } if +} def + +/vedge +{ + /ye exch def + /ys exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add dup + ys yspacing mul boxheight 2 div sub + moveto + ye yspacing mul boxheight 2 div sub + lineto + stroke +} def + +/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' +{ + /ys exch def + /xe exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add + ys yspacing mul disty 2 div sub + moveto + xspacing xe xs sub mul 0 + rlineto + stroke +} def + +% ----- main ------ + +boxfont setfont +1 boundaspect scale +(mailAccount) cw +(plugin) cw +/boxwidth boxwidth marginwidth 2 mul add def +/xspacing boxwidth distx add def +/yspacing boxheight disty add def +/scalefactor + boxwidth cols mul distx cols 1 sub mul add + boxheight rows mul disty rows 1 sub mul add boundaspect mul + max def +boundx scalefactor div boundy scalefactor div scale + +% ----- classes ----- + + (mailAccount) 0 0 box + (plugin) 0 1 box + +% ----- relations ----- + +solid +0 0 0 out +solid +1 0 1 in diff --git a/doc/guide/devel/latex/classmailAccount.tex b/doc/guide/devel/latex/classmailAccount.tex new file mode 100644 index 000000000..9c117d918 --- /dev/null +++ b/doc/guide/devel/latex/classmailAccount.tex @@ -0,0 +1,175 @@ +\section{mail\-Account Class Reference} +\label{classmailAccount}\index{mailAccount@{mailAccount}} +mail plugin + + +Inheritance diagram for mail\-Account::\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=2cm]{classmailAccount} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf mail\-Account} (\${\bf dn}=NULL, \$shared\_\-folder=FALSE)\label{classmailAccount_a0} + +\item +{\bf get\-Imap\-Attributes} ()\label{classmailAccount_a1} + +\item +{\bf set\-Imap\-Attributes} ()\label{classmailAccount_a2} + +\item +{\bf set\-Sieve\-Attributes} ()\label{classmailAccount_a3} + +\item +{\bf execute} () +\begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item +{\bf remove\_\-from\_\-parent} ()\label{classmailAccount_a5} + +\item +{\bf save\_\-object} ()\label{classmailAccount_a6} + +\item +{\bf save} ()\label{classmailAccount_a7} + +\item +{\bf check} ()\label{classmailAccount_a8} + +\item +{\bf adapt\_\-from\_\-template} (\${\bf dn})\label{classmailAccount_a9} + +\item +{\bf add\-Forwarder} (\$address)\label{classmailAccount_a10} + +\item +{\bf del\-Forwarder} (\$addresses)\label{classmailAccount_a11} + +\item +{\bf add\-Alternate} (\$address)\label{classmailAccount_a12} + +\item +{\bf del\-Alternate} (\$addresses)\label{classmailAccount_a13} + +\end{CompactItemize} +\subsection*{Public Attributes} +\begin{CompactItemize} +\item +{\bf mail} = \char`\"{}\char`\"{}\label{classmailAccount_o0} + +\item +{\bf gosa\-Mail\-Alternate\-Address} = array()\label{classmailAccount_o1} + +\item +{\bf gosa\-Mail\-Forwarding\-Address} = array()\label{classmailAccount_o2} + +\item +{\bf gosa\-Mail\-Delivery\-Mode} = \char`\"{}[L ]\char`\"{}\label{classmailAccount_o3} + +\item +{\bf gosa\-Mail\-Server} = \char`\"{}\char`\"{}\label{classmailAccount_o4} + +\item +{\bf gosa\-Mail\-Quota} = \char`\"{}\char`\"{}\label{classmailAccount_o5} + +\item +{\bf gosa\-Mail\-Max\-Size} = \char`\"{}\char`\"{}\label{classmailAccount_o6} + +\item +{\bf gosa\-Vacation\-Message} = \char`\"{}\char`\"{}\label{classmailAccount_o7} + +\item +{\bf gosa\-Spam\-Sort\-Level} = \char`\"{}\char`\"{}\label{classmailAccount_o8} + +\item +{\bf gosa\-Spam\-Mailbox} = \char`\"{}\char`\"{}\label{classmailAccount_o9} + +\item +{\bf quota\-Usage} = 0\label{classmailAccount_o10} + +\item +{\bf forward\_\-dialog} = FALSE\label{classmailAccount_o11} + +\item +{\bf folder\_\-prefix} = \char`\"{}\char`\"{}\label{classmailAccount_o12} + +\item +{\bf mailbox\-List} = array()\label{classmailAccount_o13} + +\item +{\bf default\_\-permissions} = \char`\"{}none\char`\"{}\label{classmailAccount_o14} + +\item +{\bf member\_\-permissions} = \char`\"{}post\char`\"{}\label{classmailAccount_o15} + +\item +{\bf members} = array()\label{classmailAccount_o16} + +\item +{\bf admins} = array()\label{classmailAccount_o17} + +\item +{\bf perms} +\item +{\bf attributes} +\item +{\bf objectclasses} = array(\char`\"{}gosa\-Mail\-Account\char`\"{})\label{classmailAccount_o20} + +\end{CompactItemize} + + +\subsection{Detailed Description} +mail plugin + +\begin{Desc} +\item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc} +\begin{Desc} +\item[Version:]2.00 \end{Desc} +\begin{Desc} +\item[Date:]24.07.2003\end{Desc} +This class provides the functionality to read and write all attributes relevant for gosa\-Mail\-Accounts from/to the LDAP. It does syntax checking and displays the formulars required. + + + +\subsection{Member Function Documentation} +\index{mailAccount@{mail\-Account}!execute@{execute}} +\index{execute@{execute}!mailAccount@{mail\-Account}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}mail\-Account::execute ()}\label{classmailAccount_a4} + + +execute plugin + +Generates the html output for this node + +Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin_a1})}. + +\subsection{Member Data Documentation} +\index{mailAccount@{mail\-Account}!attributes@{attributes}} +\index{attributes@{attributes}!mailAccount@{mail\-Account}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}mail\-Account::attributes}\label{classmailAccount_o19} + + +{\bf Initial value:} + +\footnotesize\begin{verbatim} array("mail", "gosaMailServer", "gosaMailQuota", "gosaMailMaxSize", + "gosaMailDeliveryMode", "gosaSpamSortLevel", "gosaSpamMailbox", + "gosaVacationMessage", "uid") +\end{verbatim}\normalsize + + +Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin})}.\index{mailAccount@{mail\-Account}!perms@{perms}} +\index{perms@{perms}!mailAccount@{mail\-Account}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}mail\-Account::perms}\label{classmailAccount_o18} + + +{\bf Initial value:} + +\footnotesize\begin{verbatim} array( "lrs" => "read", "lrsp" => "post", "lrsip" => "append", + "lrswipcd" => "write", "lrswipcda" => "all" ) +\end{verbatim}\normalsize + + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +class\_\-mail\-Account.inc\end{CompactItemize} diff --git a/doc/guide/devel/latex/classplugin.eps b/doc/guide/devel/latex/classplugin.eps new file mode 100644 index 000000000..69febded0 --- /dev/null +++ b/doc/guide/devel/latex/classplugin.eps @@ -0,0 +1,207 @@ +%!PS-Adobe-2.0 EPSF-2.0 +%%Title: ClassName +%%Creator: Doxygen +%%CreationDate: Time +%%For: +%Magnification: 1.00 +%%Orientation: Portrait +%%BoundingBox: 0 0 500 138.889 +%%Pages: 0 +%%BeginSetup +%%EndSetup +%%EndComments + +% ----- variables ----- + +/boxwidth 0 def +/boxheight 40 def +/fontheight 24 def +/marginwidth 10 def +/distx 20 def +/disty 40 def +/boundaspect 3.6 def % aspect ratio of the BoundingBox (width/height) +/boundx 500 def +/boundy boundx boundaspect div def +/xspacing 0 def +/yspacing 0 def +/rows 2 def +/cols 3 def +/scalefactor 0 def +/boxfont /Times-Roman findfont fontheight scalefont def + +% ----- procedures ----- + +/dotted { [1 4] 0 setdash } def +/dashed { [5] 0 setdash } def +/solid { [] 0 setdash } def + +/max % result = MAX(arg1,arg2) +{ + /a exch def + /b exch def + a b gt {a} {b} ifelse +} def + +/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) +{ + 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max +} def + +/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) +{ + /str exch def + /boxwidth boxwidth str stringwidth pop max def +} def + +/box % draws a box with text `arg1' at grid pos (arg2,arg3) +{ gsave + 2 setlinewidth + newpath + exch xspacing mul xoffset add + exch yspacing mul + moveto + boxwidth 0 rlineto + 0 boxheight rlineto + boxwidth neg 0 rlineto + 0 boxheight neg rlineto + closepath + dup stringwidth pop neg boxwidth add 2 div + boxheight fontheight 2 div sub 2 div + rmoveto show stroke + grestore +} def + +/mark +{ newpath + exch xspacing mul xoffset add boxwidth add + exch yspacing mul + moveto + 0 boxheight 4 div rlineto + boxheight neg 4 div boxheight neg 4 div rlineto + closepath + eofill + stroke +} def + +/arrow +{ newpath + moveto + 3 -8 rlineto + -6 0 rlineto + 3 8 rlineto + closepath + eofill + stroke +} def + +/out % draws an output connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight add + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/in % draws an input connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul disty 2 div sub + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/hedge +{ + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight 2 div sub + /y exch def + /x exch def + newpath + x y moveto + boxwidth 2 div distx add 0 rlineto + stroke + 1 eq + { newpath x boxwidth 2 div distx add add y moveto + -8 3 rlineto + 0 -6 rlineto + 8 3 rlineto + closepath + eofill + stroke + } if +} def + +/vedge +{ + /ye exch def + /ys exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add dup + ys yspacing mul boxheight 2 div sub + moveto + ye yspacing mul boxheight 2 div sub + lineto + stroke +} def + +/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' +{ + /ys exch def + /xe exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add + ys yspacing mul disty 2 div sub + moveto + xspacing xe xs sub mul 0 + rlineto + stroke +} def + +% ----- main ------ + +boxfont setfont +1 boundaspect scale +(plugin) cw +(mailAccount) cw +(posixAccount) cw +(user) cw +/boxwidth boxwidth marginwidth 2 mul add def +/xspacing boxwidth distx add def +/yspacing boxheight disty add def +/scalefactor + boxwidth cols mul distx cols 1 sub mul add + boxheight rows mul disty rows 1 sub mul add boundaspect mul + max def +boundx scalefactor div boundy scalefactor div scale + +% ----- classes ----- + + (plugin) 1 1 box + (mailAccount) 0 0 box + (posixAccount) 1 0 box + (user) 2 0 box + +% ----- relations ----- + +solid +1 1 0.25 out +solid +0 2 1 conn +solid +0 0 0.75 in +solid +0 1 0.75 in +solid +0 2 0.75 in diff --git a/doc/guide/devel/latex/classplugin.tex b/doc/guide/devel/latex/classplugin.tex new file mode 100644 index 000000000..6bbdbd72c --- /dev/null +++ b/doc/guide/devel/latex/classplugin.tex @@ -0,0 +1,166 @@ +\section{plugin Class Reference} +\label{classplugin}\index{plugin@{plugin}} +The plugin base class. + + +Inheritance diagram for plugin::\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=2cm]{classplugin} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf plugin} (\${\bf dn}=NULL) +\begin{CompactList}\small\item\em plugin constructor \item\end{CompactList}\item +{\bf execute} () +\begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item +{\bf remove\_\-from\_\-parent} ()\label{classplugin_a2} + +\item +{\bf save\_\-object} ()\label{classplugin_a3} + +\item +{\bf save} ()\label{classplugin_a4} + +\item +{\bf check} ()\label{classplugin_a5} + +\item +{\bf adapt\_\-from\_\-template} (\${\bf dn})\label{classplugin_a6} + +\item +{\bf password\_\-change\_\-needed} ()\label{classplugin_a7} + +\end{CompactItemize} +\subsection*{Public Attributes} +\begin{CompactItemize} +\item +{\bf parent} = NULL +\begin{CompactList}\small\item\em Reference to parent object. \item\end{CompactList}\item +{\bf is\_\-account} = FALSE +\begin{CompactList}\small\item\em Mark plugin as account. \item\end{CompactList}\item +{\bf is\_\-template} = FALSE +\begin{CompactList}\small\item\em Mark plugin as template. \item\end{CompactList}\item +{\bf attrs} = array() +\begin{CompactList}\small\item\em Represent temporary LDAP data. \item\end{CompactList}\item +{\bf dn} = \char`\"{}\char`\"{} +\begin{CompactList}\small\item\em Used standard values. \item\end{CompactList}\item +{\bf uid} = \char`\"{}\char`\"{}\label{classplugin_o5} + +\item +{\bf sn} = \char`\"{}\char`\"{}\label{classplugin_o6} + +\item +{\bf given\-Name} = \char`\"{}\char`\"{}\label{classplugin_o7} + +\item +{\bf acl} = \char`\"{}$\ast$none$\ast$\char`\"{}\label{classplugin_o8} + +\item +{\bf attributes} = array()\label{classplugin_o9} + +\item +{\bf objectclasses} = array()\label{classplugin_o10} + +\end{CompactItemize} + + +\subsection{Detailed Description} +The plugin base class. + +\begin{Desc} +\item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc} +\begin{Desc} +\item[Version:]2.00 \end{Desc} +\begin{Desc} +\item[Date:]24.07.2003\end{Desc} +This is the base class for all plugins. It can be used standalone or can be included by the tabs class. All management should be done within this class. Extend your plugins from this class. + + + +\subsection{Constructor \& Destructor Documentation} +\index{plugin@{plugin}!plugin@{plugin}} +\index{plugin@{plugin}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}plugin::plugin (\$ {\em dn} = NULL)}\label{classplugin_a0} + + +plugin constructor + +If 'dn' is set, the node loads the given 'dn' from LDAP + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em dn}]Distinguished name to initialize plugin from \end{description} +\end{Desc} +\begin{Desc} +\item[See also:]{\bf plugin()} \end{Desc} + + +\subsection{Member Function Documentation} +\index{plugin@{plugin}!execute@{execute}} +\index{execute@{execute}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}plugin::execute ()}\label{classplugin_a1} + + +execute plugin + +Generates the html output for this node + +Reimplemented in {\bf mail\-Account} {\rm (p.\,\pageref{classmailAccount_a4})}, {\bf posix\-Account} {\rm (p.\,\pageref{classposixAccount_a1})}, and {\bf user} {\rm (p.\,\pageref{classuser_a1})}. + +\subsection{Member Data Documentation} +\index{plugin@{plugin}!attrs@{attrs}} +\index{attrs@{attrs}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::attrs} = array()}\label{classplugin_o3} + + +Represent temporary LDAP data. + +This is only used internally. \index{plugin@{plugin}!dn@{dn}} +\index{dn@{dn}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::dn} = \char`\"{}\char`\"{}}\label{classplugin_o4} + + +Used standard values. + +dn \index{plugin@{plugin}!is_account@{is\_\-account}} +\index{is_account@{is\_\-account}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::is\_\-account} = FALSE}\label{classplugin_o1} + + +Mark plugin as account. + +Defines whether this plugin is defined as an account or not. This has consequences for the plugin to be saved from tab mode. If it is set to 'FALSE' the tab will call the delete function, else the save function. Should be set to 'TRUE' if the construtor detects a valid LDAP object. + +\begin{Desc} +\item[See also:]{\bf plugin::plugin()} \end{Desc} +\index{plugin@{plugin}!is_template@{is\_\-template}} +\index{is_template@{is\_\-template}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::is\_\-template} = FALSE}\label{classplugin_o2} + + +Mark plugin as template. + +Defines whether we are creating a template or a normal object. Has conseqences on the way {\bf execute()} shows the formular and how save() puts the data to LDAP. + +\begin{Desc} +\item[See also:]plugin::save() {\bf plugin::execute()} \end{Desc} +\index{plugin@{plugin}!parent@{parent}} +\index{parent@{parent}!plugin@{plugin}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf plugin::parent} = NULL}\label{classplugin_o0} + + +Reference to parent object. + +This variable is used when the plugin is included in tabs and keeps reference to the tab class. Communication to other tabs is possible by 'name'. So the 'fax' plugin can ask the 'userinfo' plugin for the fax number. + +\begin{Desc} +\item[See also:]tab \end{Desc} + + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +plugin.inc\end{CompactItemize} diff --git a/doc/guide/devel/latex/classposixAccount.eps b/doc/guide/devel/latex/classposixAccount.eps new file mode 100644 index 000000000..f3dfa4897 --- /dev/null +++ b/doc/guide/devel/latex/classposixAccount.eps @@ -0,0 +1,197 @@ +%!PS-Adobe-2.0 EPSF-2.0 +%%Title: ClassName +%%Creator: Doxygen +%%CreationDate: Time +%%For: +%Magnification: 1.00 +%%Orientation: Portrait +%%BoundingBox: 0 0 500 416.667 +%%Pages: 0 +%%BeginSetup +%%EndSetup +%%EndComments + +% ----- variables ----- + +/boxwidth 0 def +/boxheight 40 def +/fontheight 24 def +/marginwidth 10 def +/distx 20 def +/disty 40 def +/boundaspect 1.2 def % aspect ratio of the BoundingBox (width/height) +/boundx 500 def +/boundy boundx boundaspect div def +/xspacing 0 def +/yspacing 0 def +/rows 2 def +/cols 1 def +/scalefactor 0 def +/boxfont /Times-Roman findfont fontheight scalefont def + +% ----- procedures ----- + +/dotted { [1 4] 0 setdash } def +/dashed { [5] 0 setdash } def +/solid { [] 0 setdash } def + +/max % result = MAX(arg1,arg2) +{ + /a exch def + /b exch def + a b gt {a} {b} ifelse +} def + +/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) +{ + 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max +} def + +/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) +{ + /str exch def + /boxwidth boxwidth str stringwidth pop max def +} def + +/box % draws a box with text `arg1' at grid pos (arg2,arg3) +{ gsave + 2 setlinewidth + newpath + exch xspacing mul xoffset add + exch yspacing mul + moveto + boxwidth 0 rlineto + 0 boxheight rlineto + boxwidth neg 0 rlineto + 0 boxheight neg rlineto + closepath + dup stringwidth pop neg boxwidth add 2 div + boxheight fontheight 2 div sub 2 div + rmoveto show stroke + grestore +} def + +/mark +{ newpath + exch xspacing mul xoffset add boxwidth add + exch yspacing mul + moveto + 0 boxheight 4 div rlineto + boxheight neg 4 div boxheight neg 4 div rlineto + closepath + eofill + stroke +} def + +/arrow +{ newpath + moveto + 3 -8 rlineto + -6 0 rlineto + 3 8 rlineto + closepath + eofill + stroke +} def + +/out % draws an output connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight add + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/in % draws an input connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul disty 2 div sub + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/hedge +{ + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight 2 div sub + /y exch def + /x exch def + newpath + x y moveto + boxwidth 2 div distx add 0 rlineto + stroke + 1 eq + { newpath x boxwidth 2 div distx add add y moveto + -8 3 rlineto + 0 -6 rlineto + 8 3 rlineto + closepath + eofill + stroke + } if +} def + +/vedge +{ + /ye exch def + /ys exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add dup + ys yspacing mul boxheight 2 div sub + moveto + ye yspacing mul boxheight 2 div sub + lineto + stroke +} def + +/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' +{ + /ys exch def + /xe exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add + ys yspacing mul disty 2 div sub + moveto + xspacing xe xs sub mul 0 + rlineto + stroke +} def + +% ----- main ------ + +boxfont setfont +1 boundaspect scale +(posixAccount) cw +(plugin) cw +/boxwidth boxwidth marginwidth 2 mul add def +/xspacing boxwidth distx add def +/yspacing boxheight disty add def +/scalefactor + boxwidth cols mul distx cols 1 sub mul add + boxheight rows mul disty rows 1 sub mul add boundaspect mul + max def +boundx scalefactor div boundy scalefactor div scale + +% ----- classes ----- + + (posixAccount) 0 0 box + (plugin) 0 1 box + +% ----- relations ----- + +solid +0 0 0 out +solid +1 0 1 in diff --git a/doc/guide/devel/latex/classposixAccount.tex b/doc/guide/devel/latex/classposixAccount.tex new file mode 100644 index 000000000..f98242f1c --- /dev/null +++ b/doc/guide/devel/latex/classposixAccount.tex @@ -0,0 +1,184 @@ +\section{posix\-Account Class Reference} +\label{classposixAccount}\index{posixAccount@{posixAccount}} +posix\-Account plugin + + +Inheritance diagram for posix\-Account::\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=2cm]{classposixAccount} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf posix\-Account} (\${\bf dn}=NULL)\label{classposixAccount_a0} + +\item +{\bf execute} () +\begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item +{\bf remove\_\-from\_\-parent} ()\label{classposixAccount_a2} + +\item +{\bf save\_\-object} ()\label{classposixAccount_a3} + +\item +{\bf save} ()\label{classposixAccount_a4} + +\item +{\bf check} ()\label{classposixAccount_a5} + +\item +{\bf add\-Group} (\$groups)\label{classposixAccount_a6} + +\item +{\bf del\-Group} (\$groups)\label{classposixAccount_a7} + +\item +{\bf adapt\_\-from\_\-template} (\${\bf dn})\label{classposixAccount_a8} + +\end{CompactItemize} +\subsection*{Public Attributes} +\begin{CompactItemize} +\item +{\bf home\-Directory} = \char`\"{}\char`\"{}\label{classposixAccount_o0} + +\item +{\bf login\-Shell} = \char`\"{}/bin/bash\char`\"{}\label{classposixAccount_o1} + +\item +{\bf uid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o2} + +\item +{\bf gid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o3} + +\item +{\bf gecos} = \char`\"{}\char`\"{}\label{classposixAccount_o4} + +\item +{\bf shadow\-Min} = \char`\"{}0\char`\"{}\label{classposixAccount_o5} + +\item +{\bf shadow\-Max} = \char`\"{}0\char`\"{}\label{classposixAccount_o6} + +\item +{\bf shadow\-Warning} = \char`\"{}0\char`\"{}\label{classposixAccount_o7} + +\item +{\bf shadow\-Last\-Change} = \char`\"{}0\char`\"{}\label{classposixAccount_o8} + +\item +{\bf shadow\-Inactive} = \char`\"{}0\char`\"{}\label{classposixAccount_o9} + +\item +{\bf shadow\-Expire} = \char`\"{}0\char`\"{}\label{classposixAccount_o10} + +\item +{\bf gosa\-Default\-Printer} = \char`\"{}\char`\"{}\label{classposixAccount_o11} + +\item +{\bf gosa\-Default\-Language} = \char`\"{}\char`\"{}\label{classposixAccount_o12} + +\item +{\bf gosa\-Host\-ACL} = array()\label{classposixAccount_o13} + +\item +{\bf status} = \char`\"{}\char`\"{}\label{classposixAccount_o14} + +\item +{\bf login\-Shell\-List} = array()\label{classposixAccount_o15} + +\item +{\bf group\-Membership} = array()\label{classposixAccount_o16} + +\item +{\bf saved\-Group\-Membership} = array()\label{classposixAccount_o17} + +\item +{\bf saved\-Uid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o18} + +\item +{\bf saved\-Gid\-Number} = \char`\"{}\char`\"{}\label{classposixAccount_o19} + +\item +{\bf use\_\-shadow\-Min} = \char`\"{}0\char`\"{}\label{classposixAccount_o20} + +\item +{\bf use\_\-shadow\-Max} = \char`\"{}0\char`\"{}\label{classposixAccount_o21} + +\item +{\bf use\_\-shadow\-Warning} = \char`\"{}0\char`\"{}\label{classposixAccount_o22} + +\item +{\bf use\_\-shadow\-Inactive} = \char`\"{}0\char`\"{}\label{classposixAccount_o23} + +\item +{\bf use\_\-shadow\-Expire} = \char`\"{}0\char`\"{}\label{classposixAccount_o24} + +\item +{\bf must\_\-change\_\-password} = \char`\"{}0\char`\"{}\label{classposixAccount_o25} + +\item +{\bf force\_\-ids} = 0\label{classposixAccount_o26} + +\item +{\bf printer\-List} = array()\label{classposixAccount_o27} + +\item +{\bf group\_\-dialog} = FALSE\label{classposixAccount_o28} + +\item +{\bf hosts\_\-dialog} = FALSE\label{classposixAccount_o29} + +\item +{\bf attributes} +\item +{\bf objectclasses} = array(\char`\"{}posix\-Account\char`\"{}, \char`\"{}shadow\-Account\char`\"{})\label{classposixAccount_o31} + +\end{CompactItemize} + + +\subsection{Detailed Description} +posix\-Account plugin + +\begin{Desc} +\item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc} +\begin{Desc} +\item[Version:]2.00 \end{Desc} +\begin{Desc} +\item[Date:]24.07.2003\end{Desc} +This class provides the functionality to read and write all attributes relevant for posix\-Accounts and shadow\-Accounts from/to the LDAP. It does syntax checking and displays the formulars required. + + + +\subsection{Member Function Documentation} +\index{posixAccount@{posix\-Account}!execute@{execute}} +\index{execute@{execute}!posixAccount@{posix\-Account}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}posix\-Account::execute ()}\label{classposixAccount_a1} + + +execute plugin + +Generates the html output for this node + +Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin_a1})}. + +\subsection{Member Data Documentation} +\index{posixAccount@{posix\-Account}!attributes@{attributes}} +\index{attributes@{attributes}!posixAccount@{posix\-Account}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}posix\-Account::attributes}\label{classposixAccount_o30} + + +{\bf Initial value:} + +\footnotesize\begin{verbatim} array("homeDirectory", "loginShell", "uidNumber", "gidNumber", "gecos", + "shadowMin", "shadowMax", "shadowWarning", "shadowInactive", "shadowLastChange", + "shadowExpire", "gosaDefaultPrinter", "gosaDefaultLanguage", "uid") +\end{verbatim}\normalsize + + +Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin})}. + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +class\_\-posix\-Account.inc\end{CompactItemize} diff --git a/doc/guide/devel/latex/classuser.eps b/doc/guide/devel/latex/classuser.eps new file mode 100644 index 000000000..20b76d201 --- /dev/null +++ b/doc/guide/devel/latex/classuser.eps @@ -0,0 +1,197 @@ +%!PS-Adobe-2.0 EPSF-2.0 +%%Title: ClassName +%%Creator: Doxygen +%%CreationDate: Time +%%For: +%Magnification: 1.00 +%%Orientation: Portrait +%%BoundingBox: 0 0 500 740.741 +%%Pages: 0 +%%BeginSetup +%%EndSetup +%%EndComments + +% ----- variables ----- + +/boxwidth 0 def +/boxheight 40 def +/fontheight 24 def +/marginwidth 10 def +/distx 20 def +/disty 40 def +/boundaspect 0.675 def % aspect ratio of the BoundingBox (width/height) +/boundx 500 def +/boundy boundx boundaspect div def +/xspacing 0 def +/yspacing 0 def +/rows 2 def +/cols 1 def +/scalefactor 0 def +/boxfont /Times-Roman findfont fontheight scalefont def + +% ----- procedures ----- + +/dotted { [1 4] 0 setdash } def +/dashed { [5] 0 setdash } def +/solid { [] 0 setdash } def + +/max % result = MAX(arg1,arg2) +{ + /a exch def + /b exch def + a b gt {a} {b} ifelse +} def + +/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2) +{ + 0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max +} def + +/cw % boxwidth = MAX(boxwidth, stringwidth(arg1)) +{ + /str exch def + /boxwidth boxwidth str stringwidth pop max def +} def + +/box % draws a box with text `arg1' at grid pos (arg2,arg3) +{ gsave + 2 setlinewidth + newpath + exch xspacing mul xoffset add + exch yspacing mul + moveto + boxwidth 0 rlineto + 0 boxheight rlineto + boxwidth neg 0 rlineto + 0 boxheight neg rlineto + closepath + dup stringwidth pop neg boxwidth add 2 div + boxheight fontheight 2 div sub 2 div + rmoveto show stroke + grestore +} def + +/mark +{ newpath + exch xspacing mul xoffset add boxwidth add + exch yspacing mul + moveto + 0 boxheight 4 div rlineto + boxheight neg 4 div boxheight neg 4 div rlineto + closepath + eofill + stroke +} def + +/arrow +{ newpath + moveto + 3 -8 rlineto + -6 0 rlineto + 3 8 rlineto + closepath + eofill + stroke +} def + +/out % draws an output connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight add + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/in % draws an input connector for the block at (arg1,arg2) +{ + newpath + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul disty 2 div sub + /y exch def + /x exch def + x y moveto + 0 disty 2 div rlineto + stroke + 1 eq { x y disty 2 div add arrow } if +} def + +/hedge +{ + exch xspacing mul xoffset add boxwidth 2 div add + exch yspacing mul boxheight 2 div sub + /y exch def + /x exch def + newpath + x y moveto + boxwidth 2 div distx add 0 rlineto + stroke + 1 eq + { newpath x boxwidth 2 div distx add add y moveto + -8 3 rlineto + 0 -6 rlineto + 8 3 rlineto + closepath + eofill + stroke + } if +} def + +/vedge +{ + /ye exch def + /ys exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add dup + ys yspacing mul boxheight 2 div sub + moveto + ye yspacing mul boxheight 2 div sub + lineto + stroke +} def + +/conn % connections the blocks from col `arg1' to `arg2' of row `arg3' +{ + /ys exch def + /xe exch def + /xs exch def + newpath + xs xspacing mul xoffset add boxwidth 2 div add + ys yspacing mul disty 2 div sub + moveto + xspacing xe xs sub mul 0 + rlineto + stroke +} def + +% ----- main ------ + +boxfont setfont +1 boundaspect scale +(user) cw +(plugin) cw +/boxwidth boxwidth marginwidth 2 mul add def +/xspacing boxwidth distx add def +/yspacing boxheight disty add def +/scalefactor + boxwidth cols mul distx cols 1 sub mul add + boxheight rows mul disty rows 1 sub mul add boundaspect mul + max def +boundx scalefactor div boundy scalefactor div scale + +% ----- classes ----- + + (user) 0 0 box + (plugin) 0 1 box + +% ----- relations ----- + +solid +0 0 0 out +solid +1 0 1 in diff --git a/doc/guide/devel/latex/classuser.tex b/doc/guide/devel/latex/classuser.tex new file mode 100644 index 000000000..d2d7bdf06 --- /dev/null +++ b/doc/guide/devel/latex/classuser.tex @@ -0,0 +1,236 @@ +\section{user Class Reference} +\label{classuser}\index{user@{user}} +user plugin + + +Inheritance diagram for user::\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=2cm]{classuser} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf user} (\${\bf dn}=NULL)\label{classuser_a0} + +\item +{\bf execute} () +\begin{CompactList}\small\item\em execute plugin \item\end{CompactList}\item +{\bf remove\_\-from\_\-parent} ()\label{classuser_a2} + +\item +{\bf save\_\-object} ()\label{classuser_a3} + +\item +{\bf save} ()\label{classuser_a4} + +\item +{\bf check} ()\label{classuser_a5} + +\end{CompactItemize} +\subsection*{Public Attributes} +\begin{CompactItemize} +\item +{\bf base} = \char`\"{}\char`\"{}\label{classuser_o0} + +\item +{\bf cn} = \char`\"{}\char`\"{}\label{classuser_o1} + +\item +{\bf personal\-Title} = \char`\"{}\char`\"{}\label{classuser_o2} + +\item +{\bf academic\-Title} = \char`\"{}\char`\"{}\label{classuser_o3} + +\item +{\bf home\-Postal\-Address} = \char`\"{}\char`\"{}\label{classuser_o4} + +\item +{\bf home\-Phone} = \char`\"{}\char`\"{}\label{classuser_o5} + +\item +{\bf labeled\-URI} = \char`\"{}\char`\"{}\label{classuser_o6} + +\item +{\bf o} = \char`\"{}\char`\"{}\label{classuser_o7} + +\item +{\bf ou} = \char`\"{}\char`\"{}\label{classuser_o8} + +\item +{\bf department\-Number} = \char`\"{}\char`\"{}\label{classuser_o9} + +\item +{\bf employee\-Number} = \char`\"{}\char`\"{}\label{classuser_o10} + +\item +{\bf employee\-Type} = \char`\"{}\char`\"{}\label{classuser_o11} + +\item +{\bf room\-Number} = \char`\"{}\char`\"{}\label{classuser_o12} + +\item +{\bf telephone\-Number} = \char`\"{}\char`\"{}\label{classuser_o13} + +\item +{\bf facsimile\-Telephone\-Number} = \char`\"{}\char`\"{}\label{classuser_o14} + +\item +{\bf mobile} = \char`\"{}\char`\"{}\label{classuser_o15} + +\item +{\bf pager} = \char`\"{}\char`\"{}\label{classuser_o16} + +\item +{\bf l} = \char`\"{}\char`\"{}\label{classuser_o17} + +\item +{\bf st} = \char`\"{}\char`\"{}\label{classuser_o18} + +\item +{\bf postal\-Address} = \char`\"{}\char`\"{}\label{classuser_o19} + +\item +{\bf jpeg\-Photo} = \char`\"{}$\ast$removed$\ast$\char`\"{}\label{classuser_o20} + +\item +{\bf photo\-Data} = \char`\"{}\char`\"{}\label{classuser_o21} + +\item +{\bf old\_\-jpeg\-Photo} = \char`\"{}\char`\"{}\label{classuser_o22} + +\item +{\bf old\_\-photo\-Data} = \char`\"{}\char`\"{}\label{classuser_o23} + +\item +{\bf cert\_\-dialog} = FALSE\label{classuser_o24} + +\item +{\bf picture\_\-dialog} = FALSE\label{classuser_o25} + +\item +{\bf user\-PKCS12} = \char`\"{}\char`\"{}\label{classuser_o26} + +\item +{\bf user\-SMIMECertificate} = \char`\"{}\char`\"{}\label{classuser_o27} + +\item +{\bf user\-Certificate} = \char`\"{}\char`\"{}\label{classuser_o28} + +\item +{\bf certificate\-Serial\-Number} = \char`\"{}\char`\"{}\label{classuser_o29} + +\item +{\bf old\_\-certificate\-Serial\-Number} = \char`\"{}\char`\"{}\label{classuser_o30} + +\item +{\bf old\_\-user\-PKCS12} = \char`\"{}\char`\"{}\label{classuser_o31} + +\item +{\bf old\_\-user\-SMIMECertificate} = \char`\"{}\char`\"{}\label{classuser_o32} + +\item +{\bf old\_\-user\-Certificate} = \char`\"{}\char`\"{}\label{classuser_o33} + +\item +{\bf gouvernment\-Organizational\-Unit} = \char`\"{}\char`\"{}\label{classuser_o34} + +\item +{\bf house\-Identifier} = \char`\"{}\char`\"{}\label{classuser_o35} + +\item +{\bf street} = \char`\"{}\char`\"{}\label{classuser_o36} + +\item +{\bf postal\-Code} = \char`\"{}\char`\"{}\label{classuser_o37} + +\item +{\bf vocation} = \char`\"{}\char`\"{}\label{classuser_o38} + +\item +{\bf ivbb\-Last\-Delivery\-Collective} = \char`\"{}\char`\"{}\label{classuser_o39} + +\item +{\bf gouvernment\-Organizational\-Person\-Locality} = \char`\"{}\char`\"{}\label{classuser_o40} + +\item +{\bf gouvernment\-Organizational\-Unit\-Description} = \char`\"{}\char`\"{}\label{classuser_o41} + +\item +{\bf gouvernment\-Organizational\-Unit\-Subject\-Area} = \char`\"{}\char`\"{}\label{classuser_o42} + +\item +{\bf functional\-Title} = \char`\"{}\char`\"{}\label{classuser_o43} + +\item +{\bf role} = \char`\"{}\char`\"{}\label{classuser_o44} + +\item +{\bf public\-Visible} = \char`\"{}\char`\"{}\label{classuser_o45} + +\item +{\bf pw\_\-storage} = \char`\"{}crypt\char`\"{}\label{classuser_o46} + +\item +{\bf last\_\-pw\_\-storage} = \char`\"{}crypt\char`\"{}\label{classuser_o47} + +\item +{\bf attributes} +\item +{\bf objectclasses} = array(\char`\"{}person\char`\"{}, \char`\"{}organizational\-Person\char`\"{}, \char`\"{}inet\-Org\-Person\char`\"{}, \char`\"{}gosa\-Account\char`\"{})\label{classuser_o49} + +\end{CompactItemize} + + +\subsection{Detailed Description} +user plugin + +\begin{Desc} +\item[Author:]Cajus Pollmeier $<${\tt pollmeier@gonicus.de}$>$ \end{Desc} +\begin{Desc} +\item[Version:]2.00 \end{Desc} +\begin{Desc} +\item[Date:]24.07.2003\end{Desc} +This class provides the functionality to read and write all attributes relevant for person, organizational\-Person, inet\-Org\-Person and gosa\-Account from/to the LDAP. It does syntax checking and displays the formulars required. + + + +\subsection{Member Function Documentation} +\index{user@{user}!execute@{execute}} +\index{execute@{execute}!user@{user}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}user::execute ()}\label{classuser_a1} + + +execute plugin + +Generates the html output for this node + +Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin_a1})}. + +\subsection{Member Data Documentation} +\index{user@{user}!attributes@{attributes}} +\index{attributes@{attributes}!user@{user}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}user::attributes}\label{classuser_o48} + + +{\bf Initial value:} + +\footnotesize\begin{verbatim} array("sn", "givenName", "uid", "personalTitle", "academicTitle", + "homePostalAddress", "homePhone", "labeledURI", "o", "ou", + "departmentNumber", "employeeNumber", "employeeType", "l", "st", + "roomNumber", "telephoneNumber", "mobile", "pager", "cn", "userPKCS12", + "postalAddress", "facsimileTelephoneNumber", "userSMIMECertificate", + "gouvernmentOrganizationalUnit", "houseIdentifier", "vocation", + "ivbbLastDeliveryCollective", "gouvernmentOrganizationalPersonLocality", + "gouvernmentOrganizationalUnitDescription", "postalCode", "street", + "gouvernmentOrganizationalUnitSubjectArea", "functionalTitle", + "role", "certificateSerialNumber", "publicVisible") +\end{verbatim}\normalsize + + +Reimplemented from {\bf plugin} {\rm (p.\,\pageref{classplugin})}. + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +class\_\-user.inc\end{CompactItemize} diff --git a/doc/guide/devel/latex/doxygen.sty b/doc/guide/devel/latex/doxygen.sty new file mode 100644 index 000000000..5c9ef7eca --- /dev/null +++ b/doc/guide/devel/latex/doxygen.sty @@ -0,0 +1,65 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{doxygen} +\RequirePackage{calc} +\RequirePackage{array} +\pagestyle{fancyplain} +\addtolength{\headwidth}{\marginparsep} +\addtolength{\headwidth}{\marginparwidth} +\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}} +\renewcommand{\chaptermark}[1]{\markboth{#1}{}} +\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}} +\lhead[\fancyplain{}{\bfseries\thepage}] + {\fancyplain{}{\bfseries\rightmark}} +\rhead[\fancyplain{}{\bfseries\leftmark}] + {\fancyplain{}{\bfseries\thepage}} +\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Sat Jul 26 18:32:23 2003 for GOsa by Doxygen }]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Sat Jul 26 18:32:23 2003 for GOsa by Doxygen }} +\cfoot{} +\newenvironment{CompactList} +{\begin{list}{}{ + \setlength{\leftmargin}{0.5cm} + \setlength{\itemsep}{0pt} + \setlength{\parsep}{0pt} + \setlength{\topsep}{0pt} + \renewcommand{\makelabel}{}}} +{\end{list}} +\newenvironment{CompactItemize} +{ + \begin{itemize} + \setlength{\itemsep}{-3pt} + \setlength{\parsep}{0pt} + \setlength{\topsep}{0pt} + \setlength{\partopsep}{0pt} +} +{\end{itemize}} +\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp} +\newlength{\tmplength} +\newenvironment{TabularC}[1] +{ +\setlength{\tmplength} + {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)} + \par\begin{tabular*}{\linewidth} + {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|} +} +{\end{tabular*}\par} +\newcommand{\entrylabel}[1]{ + {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\\}}} +\newenvironment{Desc} +{\begin{list}{} + { + \settowidth{\labelwidth}{40pt} + \setlength{\leftmargin}{\labelwidth} + \setlength{\parsep}{0pt} + \setlength{\itemsep}{-4pt} + \renewcommand{\makelabel}{\entrylabel} + } +} +{\end{list}} +\newenvironment{Indent} + {\begin{list}{}{\setlength{\leftmargin}{0.5cm}} + \item[]\ignorespaces} + {\unskip\end{list}} +\setlength{\parindent}{0cm} +\setlength{\parskip}{0.2cm} +\addtocounter{secnumdepth}{1} +\sloppy diff --git a/doc/guide/devel/latex/hierarchy.tex b/doc/guide/devel/latex/hierarchy.tex new file mode 100644 index 000000000..2ca698880 --- /dev/null +++ b/doc/guide/devel/latex/hierarchy.tex @@ -0,0 +1,9 @@ +\section{GOsa Class Hierarchy} +This inheritance list is sorted roughly, but not completely, alphabetically:\begin{CompactList} +\item acl\item app\-Group\item application\item blocklist\item department\item fax\-Account\item group\item LDAP\item link\_\-info\item \contentsline{section}{plugin}{\pageref{classplugin}}{} +\begin{CompactList} +\item \contentsline{section}{mail\-Account}{\pageref{classmailAccount}}{} +\item \contentsline{section}{posix\-Account}{\pageref{classposixAccount}}{} +\item \contentsline{section}{user}{\pageref{classuser}}{} +\end{CompactList} +\item pluginfo\item proxy\-Account\item pureftp\-Account\item samba\-Account\item server\item userinfo\end{CompactList} diff --git a/doc/guide/devel/latex/refman.tex b/doc/guide/devel/latex/refman.tex new file mode 100644 index 000000000..bcae22222 --- /dev/null +++ b/doc/guide/devel/latex/refman.tex @@ -0,0 +1,40 @@ +\documentclass[a4paper]{book} +\usepackage{a4wide} +\usepackage{makeidx} +\usepackage{fancyhdr} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{float} +\usepackage{textcomp} +\usepackage{alltt} +\usepackage{doxygen} +\makeindex +\setcounter{tocdepth}{1} +\renewcommand{\footrulewidth}{0.4pt} +\begin{document} +\begin{titlepage} +\vspace*{7cm} +\begin{center} +{\Large GOsa Reference Manual\\[1ex]\large 2.00 }\\ +\vspace*{1cm} +{\large Generated by Doxygen 1.3.2}\\ +\vspace*{0.5cm} +{\small Sat Jul 26 18:32:22 2003}\\ +\end{center} +\end{titlepage} +\clearemptydoublepage +\pagenumbering{roman} +\tableofcontents +\clearemptydoublepage +\pagenumbering{arabic} +\chapter{GOsa Hierarchical Index} +\input{hierarchy} +\chapter{GOsa Compound Index} +\input{annotated} +\chapter{GOsa Class Documentation} +\input{classmailAccount} +\include{classplugin} +\include{classposixAccount} +\include{classuser} +\printindex +\end{document} -- 2.30.2