From: smh Date: Mon, 5 Apr 2004 08:10:03 +0000 (+0000) Subject: SALOME PAL V1_4_1 X-Git-Tag: Base_Ecole_Ete X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=716f7c4be32082a18a21fc54fb809068ad23e2c6;p=tools%2Fmedcoupling.git SALOME PAL V1_4_1 --- diff --git a/doc/salome/MED_index.html b/doc/salome/MED_index.html new file mode 100644 index 000000000..5217304ed --- /dev/null +++ b/doc/salome/MED_index.html @@ -0,0 +1,94 @@ + + + + + + + + Med Module Documentation + + + +
  +
+
                   +   
+ + + + + + + + + +
+ + + +
+ +
+
+
+

Med MODULE Documentation

+
+
+ + + + + +
+
+ +
+

Application-About.png +     

+
+ +
+ + + + +
+
+
+ +
+
+ +
+ +
+ +

+
+ +
+ +
TUI Documentation
+ +
+ +
+ +

+
+
+
+
+
+
+
+ + diff --git a/doc/salome/Makefile.in b/doc/salome/Makefile.in new file mode 100644 index 000000000..b411e3271 --- /dev/null +++ b/doc/salome/Makefile.in @@ -0,0 +1,43 @@ + +# -* Makefile *- +# +# Author : Patrick GOLDBRONN (CEA) +# Date : 30/11/2001 +# $Header$ +# +# source path +top_srcdir=@top_srcdir@ +top_builddir=../.. +srcdir=@srcdir@ +VPATH=.:@srcdir@ + +SUBDIRS= tui + +@COMMENCE@ + +docs: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done; \ + cp -f $(srcdir)/MED_index.html MED_index.html + +clean: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done + +distclean: clean + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done + +install: + $(MAKE) docs + (cd tui && $(MAKE) install); + cp -f MED_index.html $(docdir) + +uninstall: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done; \ + rm -fr $(docdir)/MED_index.html diff --git a/doc/salome/tui/MED/HTML/MED.html b/doc/salome/tui/MED/HTML/MED.html new file mode 100644 index 000000000..b8f484ade --- /dev/null +++ b/doc/salome/tui/MED/HTML/MED.html @@ -0,0 +1,422 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface MESH
IDL file
Python
string getName ( )
return_value = getName ( )
long getSpaceDimension ( )
return_value = getSpaceDimension ( )
long getMeshDimension ( )
return_value = getMeshDimension ( )
string getCoordinateSystem ( )
return_value = getCoordinateSystem ( )
long getNumberOfNodes ( )
return_value = getNumberOfNodes ( )
double_array getCoordinates ( in medModeSwitch typeSwitch )
return_value = getCoordinates ( typeSwitch )
string_array getCoordinatesNames ( )
return_value = getCoordinatesNames ( )
string_array getCoordinatesUnits ( )
return_value = getCoordinatesUnits ( )
long getNumberOfTypes ( in medEntityMesh entity )
return_value = getNumberOfTypes ( entity )
medGeometryElement_array getTypes ( in medEntityMesh entity )
return_value = getTypes ( entity )
long getNumberOfElements ( in medEntityMesh entity, in medGeometryElement geomElement )
return_value = getNumberOfElements ( entity, geomElement )
long_array getConnectivity ( in medModeSwitch typeSwitch, in medConnectivity mode, in medEntityMesh entity, in medGeometryElement geomElement )
return_value = getConnectivity ( typeSwitch, mode, entity, geomElement )
long_array getConnectivityIndex ( in medConnectivity mode, in medEntityMesh entity )
return_value = getConnectivityIndex ( mode, entity )
long getElementNumber ( in medConnectivity mode, in medEntityMesh entity, in medGeometryElement type, in long_array connectivity )
return_value = getElementNumber ( mode, entity, type, connectivity )
long_array getReverseConnectivity ( in medConnectivity mode )
return_value = getReverseConnectivity ( mode )
long_array getReverseConnectivityIndex ( in medConnectivity mode )
return_value = getReverseConnectivityIndex ( mode )
long getNumberOfFamilies ( in medEntityMesh entity )
return_value = getNumberOfFamilies ( entity )
long getNumberOfGroups ( in medEntityMesh entity )
return_value = getNumberOfGroups ( entity )
Family_array getFamilies ( in medEntityMesh entity )
return_value = getFamilies ( entity )
FAMILY getFamily ( in medEntityMesh entity, in long familyNumber )
return_value = getFamily ( entity, familyNumber )
Group_array getGroups ( in medEntityMesh entity )
return_value = getGroups ( entity )
GROUP getGroup ( in medEntityMesh entity, in long groupNumber )
return_value = getGroup ( entity, groupNumber )
FIELD getVolume ( in SUPPORT mySupport )
return_value = getVolume ( mySupport )
FIELD getArea ( in SUPPORT mySupport )
return_value = getArea ( mySupport )
FIELD getLength ( in SUPPORT mySupport )
return_value = getLength ( mySupport )
FIELD getNormal ( in SUPPORT mySupport )
return_value = getNormal ( mySupport )
FIELD getBarycenter ( in SUPPORT mySupport )
return_value = getBarycenter ( mySupport )
void addInStudy ( in Study myStudy, in MESH myIor )
addInStudy ( myStudy, myIor )
long addDriver ( in medDriverTypes driverType, in string fileName, in string meshName )
return_value = addDriver ( driverType, fileName, meshName )
void rmDriver ( in long i )
rmDriver ( i )
void read ( in long i )
read ( i )
void write ( in long i, in string driverMeshName )
write ( i, driverMeshName )
long getCorbaIndex ( )
return_value = getCorbaIndex ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SUPPORT
IDL file
Python
string getName ( )
return_value = getName ( )
string getDescription ( )
return_value = getDescription ( )
MESH getMesh ( )
return_value = getMesh ( )
medEntityMesh getEntity ( )
return_value = getEntity ( )
boolean isOnAllElements ( )
return_value = isOnAllElements ( )
long getNumberOfElements ( in medGeometryElement geomElement )
return_value = getNumberOfElements ( geomElement )
medGeometryElement_array getTypes ( )
return_value = getTypes ( )
long_array getNumber ( in medGeometryElement geomElement )
return_value = getNumber ( geomElement )
long_array getNumberIndex ( )
return_value = getNumberIndex ( )
long getNumberOfGaussPoints ( in medGeometryElement geomElement )
return_value = getNumberOfGaussPoints ( geomElement )
long getCorbaIndex ( )
return_value = getCorbaIndex ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface FAMILY
IDL file
Python
long getIdentifier ( )
return_value = getIdentifier ( )
long getNumberOfAttributes ( )
return_value = getNumberOfAttributes ( )
long_array getAttributesIdentifiers ( )
return_value = getAttributesIdentifiers ( )
long getAttributeIdentifier ( in long i )
return_value = getAttributeIdentifier ( i )
long_array getAttributesValues ( )
return_value = getAttributesValues ( )
long getAttributeValue ( in long i )
return_value = getAttributeValue ( i )
string_array getAttributesDescriptions ( )
return_value = getAttributesDescriptions ( )
string getAttributeDescription ( in long i )
return_value = getAttributeDescription ( i )

+ + + + + + + + + + + + + + + + + + + +
interface GROUP
IDL file
Python
long getNumberOfFamilies ( )
return_value = getNumberOfFamilies ( )
Family_array getFamilies ( )
return_value = getFamilies ( )
FAMILY getFamily ( in long i )
return_value = getFamily ( i )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface FIELD
IDL file
Python
string getName ( )
return_value = getName ( )
string getDescription ( )
return_value = getDescription ( )
SUPPORT getSupport ( )
return_value = getSupport ( )
long getNumberOfComponents ( )
return_value = getNumberOfComponents ( )
string_array getComponentsNames ( )
return_value = getComponentsNames ( )
string getComponentName ( in long i )
return_value = getComponentName ( i )
string_array getComponentsUnits ( )
return_value = getComponentsUnits ( )
string getComponentUnit ( in long i )
return_value = getComponentUnit ( i )
long getIterationNumber ( )
return_value = getIterationNumber ( )
double getTime ( )
return_value = getTime ( )
long getOrderNumber ( )
return_value = getOrderNumber ( )
long addDriver ( in medDriverTypes driverType, in string fileName, in string fieldName )
return_value = addDriver ( driverType, fileName, fieldName )
void rmDriver ( in long i )
rmDriver ( i )
void read ( in long i )
read ( i )
void write ( in long i, in string driverFieldName )
write ( i, driverFieldName )
void addInStudy ( in Study myStudy, in FIELD myIor )
addInStudy ( myStudy, myIor )
long getCorbaIndex ( )
return_value = getCorbaIndex ( )

+ + + + + + + + + + + +
interface FIELDDOUBLE
IDL file
Python
double_array getValue ( in medModeSwitch mode )
return_value = getValue ( mode )

+ + + + + + + + + + + +
interface FIELDINT
IDL file
Python
long_array getValue ( in medModeSwitch mode )
return_value = getValue ( mode )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface MED
IDL file
Python
long getNumberOfMeshes ( )
return_value = getNumberOfMeshes ( )
long getNumberOfFields ( )
return_value = getNumberOfFields ( )
string_array getMeshNames ( )
return_value = getMeshNames ( )
string_array getFieldNames ( )
return_value = getFieldNames ( )
MESH getMeshByName ( in string meshName )
return_value = getMeshByName ( meshName )
MESH getMesh ( in FIELD fieldPtr )
return_value = getMesh ( fieldPtr )
FIELD getField ( in string fieldName, in long pasTemps, in long numOrdre )
return_value = getField ( fieldName, pasTemps, numOrdre )
long addDriver ( in medDriverTypes driverType, in string fileName )
return_value = addDriver ( driverType, fileName )
void rmDriver ( in long i )
rmDriver ( i )
void readFileStruct ( in long i )
readFileStruct ( i )
void writeFrom ( in long i )
writeFrom ( i )
void write ( in long i )
write ( i )
void addMesh ( in MESH ptrMesh )
addMesh ( ptrMesh )
void addField ( in FIELD ptrField )
addField ( ptrField )
void addInStudy ( in Study myStudy, in MED medPtr )
addInStudy ( myStudy, medPtr )

+ diff --git a/doc/salome/tui/MED/HTML/MED_Gen.html b/doc/salome/tui/MED/HTML/MED_Gen.html new file mode 100644 index 000000000..44b43940b --- /dev/null +++ b/doc/salome/tui/MED/HTML/MED_Gen.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + +
interface MED_Gen
IDL file
Python
MESH readMeshInFile ( in string fileName, in string studyName, in string meshName )
return_value = readMeshInFile ( fileName, studyName, meshName )
FIELD readFieldInFile ( in string fileName, in string studyName, in string fieldName, in long ordre, in long iter )
return_value = readFieldInFile ( fileName, studyName, fieldName, ordre, iter )
MED readStructFile ( in string fileName, in string studyName )
return_value = readStructFile ( fileName, studyName )
void readStructFileWithFieldType ( in string fileName, in string studyName )
readStructFileWithFieldType ( fileName, studyName )

+ diff --git a/doc/salome/tui/MED/doxyfile b/doc/salome/tui/MED/doxyfile new file mode 100755 index 000000000..4cdbcad09 --- /dev/null +++ b/doc/salome/tui/MED/doxyfile @@ -0,0 +1,201 @@ +# Doxyfile 1.3-rc1 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "SALOME - MED - v.1.4.1" +PROJECT_NUMBER = id#1.1 +OUTPUT_DIRECTORY = ../ +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = NO +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = NO +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 5 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 25 +OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_JAVA = YES +SHOW_USED_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = log.txt +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../../../share/salome/idl/MED.idl \ + ../../../share/salome/idl/MED_Gen.idl +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = sources/ +INPUT_FILTER = +FILTER_SOURCE_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = MED +HTML_FILE_EXTENSION = .html +HTML_HEADER = sources/myheader.html +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = YES +TOC_EXPAND = YES +DISABLE_INDEX = YES +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_SCHEMA = +XML_DTD = +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = NO +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = NO +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = jpg +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1200 +GENERATE_LEGEND = NO +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/doc/salome/tui/MED/sources/Application-About.png b/doc/salome/tui/MED/sources/Application-About.png new file mode 100755 index 000000000..7b58330d5 Binary files /dev/null and b/doc/salome/tui/MED/sources/Application-About.png differ diff --git a/doc/salome/tui/MED/sources/Application-About1.jpg b/doc/salome/tui/MED/sources/Application-About1.jpg new file mode 100755 index 000000000..cf7ab8ba0 Binary files /dev/null and b/doc/salome/tui/MED/sources/Application-About1.jpg differ diff --git a/doc/salome/tui/MED/sources/application.gif b/doc/salome/tui/MED/sources/application.gif new file mode 100644 index 000000000..0b05d5c18 Binary files /dev/null and b/doc/salome/tui/MED/sources/application.gif differ diff --git a/doc/salome/tui/MED/sources/application.jpg b/doc/salome/tui/MED/sources/application.jpg new file mode 100755 index 000000000..a6979ab99 Binary files /dev/null and b/doc/salome/tui/MED/sources/application.jpg differ diff --git a/doc/salome/tui/MED/sources/bg_salome.gif b/doc/salome/tui/MED/sources/bg_salome.gif new file mode 100755 index 000000000..677b70468 Binary files /dev/null and b/doc/salome/tui/MED/sources/bg_salome.gif differ diff --git a/doc/salome/tui/MED/sources/logocorp.gif b/doc/salome/tui/MED/sources/logocorp.gif new file mode 100755 index 000000000..7697e0837 Binary files /dev/null and b/doc/salome/tui/MED/sources/logocorp.gif differ diff --git a/doc/salome/tui/MED/sources/myheader.html b/doc/salome/tui/MED/sources/myheader.html new file mode 100755 index 000000000..83ca543cd --- /dev/null +++ b/doc/salome/tui/MED/sources/myheader.html @@ -0,0 +1,24 @@ + + + + + + Main Page + + + +  +
+ + + + + + +
+
+
+ + + + diff --git a/doc/salome/tui/MED/sources/occ.gif b/doc/salome/tui/MED/sources/occ.gif new file mode 100755 index 000000000..ce017c8ae Binary files /dev/null and b/doc/salome/tui/MED/sources/occ.gif differ diff --git a/doc/salome/tui/MED/sources/static/doxygen.css b/doc/salome/tui/MED/sources/static/doxygen.css new file mode 100755 index 000000000..0a8e93d50 --- /dev/null +++ b/doc/salome/tui/MED/sources/static/doxygen.css @@ -0,0 +1,49 @@ +H1 { text-align: center; } +CAPTION { font-weight: bold } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: lightblue } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #CCCCCC } +DIV.ah { background-color: #CCCCCC; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: lightblue; font-weight: bold; } +TD.mdname1 { background-color: lightblue; font-weight: bold; color: #602020; } +TD.mdname { background-color: lightblue; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +BODY { background: url(sources/bg_salome.gif) } +TD.indexkey { + background-color: #CCCCCC; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +TD.indexvalue { + background-color: #CCCCCC; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +span.keyword { color: #008000 } +span.keywordtype { color: #604020 } +span.keywordflow { color: #e08000 } +span.comment { color: #800000 } +span.preprocessor { color: #806020 } +span.stringliteral { color: #002080 } +span.charliteral { color: #008080 } diff --git a/doc/salome/tui/MED/sources/static/page2.html b/doc/salome/tui/MED/sources/static/page2.html new file mode 100755 index 000000000..1891fe92c --- /dev/null +++ b/doc/salome/tui/MED/sources/static/page2.html @@ -0,0 +1,44 @@ + + + + + + + + Main Page + + + + +   +
+ + + + + + + + +
+ + +
+
+ + +
+ + diff --git a/doc/salome/tui/MED/sources/static/tree.js b/doc/salome/tui/MED/sources/static/tree.js new file mode 100755 index 000000000..7a2508999 --- /dev/null +++ b/doc/salome/tui/MED/sources/static/tree.js @@ -0,0 +1,20 @@ +foldersTree = gFld("SALOME v.1.4.1 ", "", "") + insDoc(foldersTree, gLnk("Main Page", "", "main.html")) + +aux1 = insFld(foldersTree, gFld("TUI Reference Guide", "")) + aux2 = insFld(aux1, gFld("Modules", "")) + aux3 = insFld(aux2, gFld("SALOME MED module", "")) +/*! insDoc(aux3, gLnk("Overview", "", "overview_Med.html"))*/ + aux4 = insFld(aux3, gFld("Packages", "")) + insDoc(aux4, gLnk("SALOME_MED", "", "namespaceSALOME__MED.html")) +/*! insDoc(aux3, gLnk("Examples", "", "examples_MED.html")) +*/ + + insDoc(aux1, gLnk("Data Structures", "", "annotated.html")) + insDoc(aux1, gLnk("Class Hierarchy", "", "hierarchy.html")) + insDoc(aux1, gLnk("Class methods list", "", "functions.html")) + insDoc(aux1, gLnk("Namespace Members", "", "namespacemembers.html")) + insDoc(aux1, gLnk("File List", "", "files.html")) + +aux1 = insFld(foldersTree, gFld("IDL/Python mapping", "")) + insDoc(aux1, gLnk("Mapping of MED IDL definitions to Python language", "", "page2.html")) diff --git a/doc/salome/tui/MED/sources/static/treeview.js b/doc/salome/tui/MED/sources/static/treeview.js new file mode 100644 index 000000000..55eb43d07 --- /dev/null +++ b/doc/salome/tui/MED/sources/static/treeview.js @@ -0,0 +1,505 @@ +//**************************************************************** +// You are free to copy the "Folder-Tree" script as long as you +// keep this copyright notice: +// Script found in: http://www.geocities.com/Paris/LeftBank/2178/ +// Author: Marcelino Alves Martins (martins@hks.com) December '97. +//**************************************************************** + +//Log of changes: +// 17 Feb 98 - Fix initialization flashing problem with Netscape +// +// 27 Jan 98 - Root folder starts open; support for USETEXTLINKS; +// make the ftien4 a js file +// +// DvH: Dec 2000 - Made some minor changes to support external +// references + +// Definition of class Folder +// ***************************************************************** + +function Folder(folderDescription, tagName, hreference) //constructor +{ + //constant data + this.desc = folderDescription + this.tagName = tagName + this.hreference = hreference + this.id = -1 + this.navObj = 0 + this.iconImg = 0 + this.nodeImg = 0 + this.isLastNode = 0 + + //dynamic data + this.isOpen = true + this.iconSrc = "ftv2folderopen.png" + this.children = new Array + this.nChildren = 0 + + //methods + this.initialize = initializeFolder + this.setState = setStateFolder + this.addChild = addChild + this.createIndex = createEntryIndex + this.hide = hideFolder + this.display = display + this.renderOb = drawFolder + this.totalHeight = totalHeight + this.subEntries = folderSubEntries + this.outputLink = outputFolderLink +} + +function setStateFolder(isOpen) +{ + var subEntries + var totalHeight + var fIt = 0 + var i=0 + + if (isOpen == this.isOpen) + return + + if (browserVersion == 2) + { + totalHeight = 0 + for (i=0; i < this.nChildren; i++) + totalHeight = totalHeight + this.children[i].navObj.clip.height + subEntries = this.subEntries() + if (this.isOpen) + totalHeight = 0 - totalHeight + for (fIt = this.id + subEntries + 1; fIt < nEntries; fIt++) + indexOfEntries[fIt].navObj.moveBy(0, totalHeight) + } + this.isOpen = isOpen + propagateChangesInState(this) +} + +function propagateChangesInState(folder) +{ + var i=0 + + if (folder.isOpen) + { + if (folder.nodeImg) + if (folder.isLastNode) + folder.nodeImg.src = "ftv2mlastnode.png" + else + folder.nodeImg.src = "ftv2mnode.png" + folder.iconImg.src = "ftv2folderopen.png" + for (i=0; i 0) + auxEv = "" + else + auxEv = "" + + if (level>0) + if (lastNode) //the last 'brother' in the children array + { + this.renderOb(leftSide + auxEv + "") +// leftSide = leftSide + "" + this.isLastNode = 1 + } + else + { + this.renderOb(leftSide + auxEv + "") + leftSide = leftSide + "" + this.isLastNode = 0 + } + else + this.renderOb("") + + if (nc > 0) + { + level = level + 1 + for (i=0 ; i < this.nChildren; i++) + { + if (i == this.nChildren-1) + this.children[i].initialize(level, 1, leftSide) + else + this.children[i].initialize(level, 0, leftSide) + } + } +} + +function drawFolder(leftSide) +{ + if (browserVersion == 2) { + if (!doc.yPos) + doc.yPos=8 + doc.write("") + } + if (browserVersion == 3) + { + doc.write("
") + } + + doc.write("\n") + doc.write("\n\n") + doc.write("\n
") + doc.write(leftSide) + this.outputLink() + doc.write("") + doc.write("") + if (USETEXTLINKS) + { + this.outputLink() + doc.write(this.desc + "") + } + else + doc.write(this.desc) + +/*! + if (this.tagName!="") + { + doc.write(" [external]") + } +*/ + doc.write("
\n") + + if (browserVersion == 2) { + doc.write("") + } + if (browserVersion == 3) { + doc.write("
") + } + + if (browserVersion == 1) { + this.navObj = doc.all["folder"+this.id] + this.iconImg = doc.all["folderIcon"+this.id] + this.nodeImg = doc.all["nodeIcon"+this.id] + } else if (browserVersion == 2) { + this.navObj = doc.layers["folder"+this.id] + this.iconImg = this.navObj.document.images["folderIcon"+this.id] + this.nodeImg = this.navObj.document.images["nodeIcon"+this.id] + doc.yPos=doc.yPos+this.navObj.clip.height + } else if (browserVersion == 3) { + this.navObj = doc.getElementById("folder"+this.id) + this.iconImg = doc.images.namedItem("folderIcon"+this.id) + this.nodeImg = doc.images.namedItem("nodeIcon"+this.id) + } +} + +function outputFolderLink() +{ + if (this.hreference) + { + doc.write(" 0) + doc.write("onClick='javascript:clickOnFolder("+this.id+")'") + doc.write(">") + } + else + doc.write("") +} + +function addChild(childNode) +{ + this.children[this.nChildren] = childNode + this.nChildren++ + return childNode +} + +function folderSubEntries() +{ + var i = 0 + var se = this.nChildren + + for (i=0; i < this.nChildren; i++){ + if (this.children[i].children) //is a folder + se = se + this.children[i].subEntries() + } + + return se +} + + +// Definition of class Item (a document or link inside a Folder) +// ************************************************************* + +function Item(itemDescription, tagName, itemLink) // Constructor +{ + // constant data + this.desc = itemDescription + this.tagName = tagName + this.link = itemLink + this.id = -1 //initialized in initalize() + this.navObj = 0 //initialized in render() + this.iconImg = 0 //initialized in render() + this.iconSrc = "ftv2doc.png" + + // methods + this.initialize = initializeItem + this.createIndex = createEntryIndex + this.hide = hideItem + this.display = display + this.renderOb = drawItem + this.totalHeight = totalHeight +} + +function hideItem() +{ + if (browserVersion == 1 || browserVersion == 3) { + if (this.navObj.style.display == "none") + return + this.navObj.style.display = "none" + } else { + if (this.navObj.visibility == "hidden") + return + this.navObj.visibility = "hidden" + } +} + +function initializeItem(level, lastNode, leftSide) +{ + this.createIndex() + + if (level>0) + if (lastNode) //the last 'brother' in the children array + { + this.renderOb(leftSide + "") + leftSide = leftSide + "" + } + else + { + this.renderOb(leftSide + "") + leftSide = leftSide + "" + } + else + this.renderOb("") +} + +function drawItem(leftSide) +{ + if (browserVersion == 2) + doc.write("") + if (browserVersion == 3) + doc.write("
") + + doc.write("\n\n") + doc.write("\n
") + doc.write(leftSide) + if (this.link!="") + { + doc.write("") + } + doc.write("") + if (this.link!="") + { + doc.write("") + } + doc.write("") + if (USETEXTLINKS && this.link!="") + doc.write("" + this.desc + "") + else + doc.write(this.desc) +/*! + if (this.tagName!="") + { + doc.write(" [external]"); + } +*/ + doc.write("\n
\n") + + if (browserVersion == 2) + doc.write("") + if (browserVersion == 3) + doc.write("
") + + if (browserVersion == 1) { + this.navObj = doc.all["item"+this.id] + this.iconImg = doc.all["itemIcon"+this.id] + } else if (browserVersion == 2) { + this.navObj = doc.layers["item"+this.id] + this.iconImg = this.navObj.document.images["itemIcon"+this.id] + doc.yPos=doc.yPos+this.navObj.clip.height + } else if (browserVersion == 3) { + this.navObj = doc.getElementById("item"+this.id) + this.iconImg = doc.images.namedItem("itemIcon"+this.id) + } +} + + +// Methods common to both objects (pseudo-inheritance) +// ******************************************************** + +function display() +{ + if (browserVersion == 1 || browserVersion == 3) + this.navObj.style.display = "block" + else + this.navObj.visibility = "show" +} + +function createEntryIndex() +{ + this.id = nEntries + indexOfEntries[nEntries] = this + nEntries++ +} + +// total height of subEntries open +function totalHeight() //used with browserVersion == 2 +{ + var h = this.navObj.clip.height + var i = 0 + + if (this.isOpen) //is a folder and _is_ open + for (i=0 ; i < this.nChildren; i++) + h = h + this.children[i].totalHeight() + + return h +} + + +// Events +// ********************************************************* + +function clickOnFolder(folderId) +{ + var clicked = indexOfEntries[folderId] + + if (!clicked.isOpen) + clickOnNode(folderId) + + return + + if (clicked.isSelected) + return +} + +function clickOnNode(folderId) +{ + var clickedFolder = 0 + var state = 0 + + clickedFolder = indexOfEntries[folderId] + state = clickedFolder.isOpen + + clickedFolder.setState(!state) //open<->close +} + +function initializeDocument() +{ + doc = document; + if (doc.all) + browserVersion = 1 //IE4 + else + if (doc.layers) + browserVersion = 2 //NS4 + else if(navigator.userAgent.toLowerCase().indexOf('gecko') != -1) + browserVersion = 3 //mozilla + else + browserVersion = 0 //other + + foldersTree.initialize(0, 1, "") + foldersTree.display() + + if (browserVersion > 0) + { + if(browserVersion != 3) + doc.write(" ") + + // close the whole tree + clickOnNode(0) + // open the root folder + clickOnNode(0) + } +} + +// Auxiliary Functions for Folder-Treee backward compatibility +// ********************************************************* + +function gFld(description, tagName, hreference) +{ + folder = new Folder(description, tagName, hreference) + return folder +} + +function gLnk(description, tagName, linkData) +{ + fullLink = "" + + if (linkData!="") + { + fullLink = "'"+linkData+"' target=\"basefrm\"" + } + + linkItem = new Item(description, tagName, fullLink) + return linkItem +} + +function insFld(parentFolder, childFolder) +{ + return parentFolder.addChild(childFolder) +} + +function insDoc(parentFolder, document) +{ + parentFolder.addChild(document) +} + +// Global variables +// **************** + +USETEXTLINKS = 1 +indexOfEntries = new Array +nEntries = 0 +doc = document +browserVersion = 0 +selectedFolder=0 diff --git a/doc/salome/tui/Makefile.in b/doc/salome/tui/Makefile.in new file mode 100644 index 000000000..1c1967600 --- /dev/null +++ b/doc/salome/tui/Makefile.in @@ -0,0 +1,43 @@ +# Copyright (C) 2003 CEA/DEN, EDF R&D +# +# +# +# File : Makefile.in +# Author : Vasily Rusyaev (Open Cascade NN) +# Module : doc +# $Header: + +top_srcdir=@top_srcdir@ +top_builddir=../../.. +root_srcdir=@ROOT_SRCDIR@ +srcdir=@srcdir@ +VPATH=.:@srcdir@ +doxygen=@DOXYGEN@ + +@COMMENCE@ + +docs: + cp -fr $(srcdir)/MED ./INPUT; \ + cd INPUT; \ + sed 's|../../../share/salome|$(root_srcdir)|' ./doxyfile > ./doxyfile1; \ + mv -f doxyfile1 doxyfile; \ + $(doxygen) ./doxyfile; \ + cd ..; \ + cp -fr $(srcdir)/MED/sources/static/*.* ./MED/ + cp -fr $(srcdir)/MED/sources/ MED/ + cp -fr $(srcdir)/MED/HTML/ MED/ + rm -fr INPUT + +clean: + rm -fr MED + +distclean: clean + rm -fr INPUT + +install: + $(INSTALL) -d $(docdir); \ + mkdir -p $(docdir)/tui + cp -fr MED $(docdir)/tui + +uninstall: + rm -fr $(docdir)/tui/MED