From 9314f61d6111280f2a02b09f9c2c0a7506cdbc79 Mon Sep 17 00:00:00 2001 From: Ariel Constenla-Haile Date: Sun, 4 Nov 2012 05:25:45 +0000 Subject: #i85426# - Document css::text::XAutoTextContainer paths handling --- offapi/com/sun/star/text/XAutoTextContainer.idl | 137 +++++++++++------------- 1 file changed, 60 insertions(+), 77 deletions(-) diff --git a/offapi/com/sun/star/text/XAutoTextContainer.idl b/offapi/com/sun/star/text/XAutoTextContainer.idl index da34ee4e2bde..0fc2aa80224a 100644 --- a/offapi/com/sun/star/text/XAutoTextContainer.idl +++ b/offapi/com/sun/star/text/XAutoTextContainer.idl @@ -1,103 +1,86 @@ /************************************************************** - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - *************************************************************/ - +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +*************************************************************/ #ifndef __com_sun_star_text_XAutoTextContainer_idl__ #define __com_sun_star_text_XAutoTextContainer_idl__ -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include -#endif - -#ifndef __com_sun_star_text_XAutoTextGroup_idl__ -#include -#endif - -#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ -#include -#endif - -#ifndef __com_sun_star_container_ElementExistException_idl__ #include -#endif - -#ifndef __com_sun_star_container_NoSuchElementException_idl__ #include -#endif - - -//============================================================================= - - module com { module sun { module star { module text { +#include +#include +#include -//============================================================================= +module com { module sun { module star { module text { -// DocMerge from xml: interface com::sun::star::text::XAutoTextContainer /** handles blocks of AutoTextEntry. - - - - - - - - @example 
-    AutoTextPath=d:\office\autotext;f:\user\autotext
-
-    groupname:  "standard*0"
-    -> the group file is located n the path d:\office\autotext
-    groupname:  "all*1"
-    -> the group file is located in the path f:\user\autotext\
-
- -

If the path extension is not specified, then the first directory - is used. For automatic text expansion, the name of an actual group is - set to search first in this group. - -

@see AutoTextContainer - */ + @see AutoTextContainer +*/ published interface XAutoTextContainer: com::sun::star::container::XNameAccess { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::text::XAutoTextContainer::insertNewByName /** creates a new AutoText group. - */ + + @param aGroupName the name of the AutoTextContainer + +

The name must follow the pattern groupname*pathid, where:

+ +
    +
  • groupname should contain only alphanumeric characters + (A-Za-z0-9), underscore (_) or space (0x20)
    • +
  • an asterisk (*) delimiter separates the group name from the path + identifier
    • +
  • pathid is a number (0 or 1) identifying the directory + where the AutoText file is stored. Paths are stored in the Office + configuration and accessed through + PathSettings::AutoText. +
      +
    • 0 indicates the path of the Office Basis layer
      • +
    • 1 indicates the path of the user directory
      • +
    +
    • +
+ If only groupname is specified, the path defaults to 0, the + Office Basis layer.
Note that in some systems the user may lack of + write access to the Office Basis directory. + + @example + +
    +
  • standard*0
    the "standard" AutoTextGroup in the Office Basis layer
    • +
  • template
    the "template" AutoTextGroup in the Office Basis layer
    • +
  • mytexts*1
    the "mytexts" AutoTextGroup in the user directory
    • +
+ + */ com::sun::star::text::XAutoTextGroup insertNewByName( [in] string aGroupName ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::text::XAutoTextContainer::removeByName /** deletes the specified AutoText group. - */ + @param aGroupName see the documentation for XAutoTextContainer::insertNewByName() + */ void removeByName( [in] string aGroupName ) raises( com::sun::star::container::NoSuchElementException ); }; -//============================================================================= - }; }; }; }; - #endif -- cgit