From 9ad74762e8f15a51057ea53d95818c92f0adf341 Mon Sep 17 00:00:00 2001 From: Christian Lohmaier Date: Mon, 4 Dec 2023 15:53:26 +0100 Subject: update translations for master and force-fix errors using pocheck Change-Id: If3a600f16773aad9242bc3231788d8bfaf8227d1 --- .../ja/helpcontent2/source/text/sbasic/python.po | 8 +- .../ja/helpcontent2/source/text/sbasic/shared.po | 24 +- .../helpcontent2/source/text/sbasic/shared/03.po | 25490 ++++++++++--------- source/ja/helpcontent2/source/text/scalc.po | 38 +- source/ja/helpcontent2/source/text/scalc/00.po | 497 +- source/ja/helpcontent2/source/text/scalc/01.po | 419 +- source/ja/helpcontent2/source/text/scalc/02.po | 20 +- source/ja/helpcontent2/source/text/scalc/guide.po | 14 +- source/ja/helpcontent2/source/text/schart/01.po | 6 +- source/ja/helpcontent2/source/text/shared/00.po | 80 +- source/ja/helpcontent2/source/text/shared/01.po | 61 +- source/ja/helpcontent2/source/text/shared/02.po | 87 +- source/ja/helpcontent2/source/text/shared/guide.po | 66 +- .../ja/helpcontent2/source/text/shared/optionen.po | 125 +- source/ja/helpcontent2/source/text/simpress/01.po | 152 +- source/ja/helpcontent2/source/text/simpress/02.po | 6 +- .../ja/helpcontent2/source/text/simpress/guide.po | 10 +- source/ja/helpcontent2/source/text/swriter/00.po | 10 +- source/ja/helpcontent2/source/text/swriter/01.po | 28 +- .../ja/helpcontent2/source/text/swriter/guide.po | 18 +- .../helpcontent2/source/text/swriter/librelogo.po | 6 +- 21 files changed, 15234 insertions(+), 11931 deletions(-) (limited to 'source/ja/helpcontent2') diff --git a/source/ja/helpcontent2/source/text/sbasic/python.po b/source/ja/helpcontent2/source/text/sbasic/python.po index 2bceded3860..e1355e33e5e 100644 --- a/source/ja/helpcontent2/source/text/sbasic/python.po +++ b/source/ja/helpcontent2/source/text/sbasic/python.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2022-12-07 19:22+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-12-12 13:30+0000\n" "Last-Translator: serval2412 \n" "Language-Team: Japanese \n" @@ -13,7 +13,7 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" "Plural-Forms: nplurals=1; plural=0;\n" "X-Accelerator-Marker: ~\n" -"X-Generator: Weblate 4.12.2\n" +"X-Generator: LibreOffice\n" #. naSFZ #: main0000.xhp @@ -2868,13 +2868,13 @@ msgctxt "" msgid "Returns a file URL for the given system path." msgstr "" -#. GEMGY +#. CRVmL #: python_programming.xhp msgctxt "" "python_programming.xhp\n" "N0272\n" "help.text" -msgid "LibreLogo and TableSample installation shared scripts use uno.py module." +msgid "LibreLogo, NamedRanges, SetCellColor and TableSample preinstalled scripts use uno.py module." msgstr "" #. 9NieC diff --git a/source/ja/helpcontent2/source/text/sbasic/shared.po b/source/ja/helpcontent2/source/text/sbasic/shared.po index d4cf111b7db..dcd11c6e483 100644 --- a/source/ja/helpcontent2/source/text/sbasic/shared.po +++ b/source/ja/helpcontent2/source/text/sbasic/shared.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-11 14:17+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-05-22 12:51+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -214,14 +214,14 @@ msgctxt "" msgid "Information" msgstr "情報" -#. jS8Ck +#. uBU7T #: 00000003.xhp msgctxt "" "00000003.xhp\n" "par_id3153381\n" "help.text" -msgid "You can set the locale used for controlling the formatting numbers, dates and currencies in $[officename] Basic in %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages. In Basic format codes, the decimal point (.) is always used as placeholder for the decimal separator defined in your locale and will be replaced by the corresponding character." -msgstr "$[officename] Basicでは %PRODUCTNAME - 書式設定ツール - オプション - 言語設定 - 言語 でローカルユーザーの使う書式設定した数、日付と通貨をコントロールを設定することができます。Basicフォーマットコードでは、小数点(.)は常にプレースホルダーとして使われるので、十進セパレーターはローカルで設定した対応する文字に置き換えられます。" +msgid "You can set the locale used for controlling the formatting numbers, dates and currencies in $[officename] Basic in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General. In Basic format codes, the decimal point (.) is always used as placeholder for the decimal separator defined in your locale and will be replaced by the corresponding character." +msgstr "" #. 6NcoV #: 00000003.xhp @@ -13111,13 +13111,13 @@ msgctxt "" msgid "date: A string that contains the date that will be converted to a Date object." msgstr "" -#. fAM5v +#. 2CiE4 #: 03030102.xhp msgctxt "" "03030102.xhp\n" "par_id841643046880968\n" "help.text" -msgid "The string passed to DateValue must be expressed in one of the date formats defined by your locale setting (see %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages) or using the ISO date format \"yyyy-mm-dd\" (year, month and day separated by hyphens)." +msgid "The string passed to DateValue must be expressed in one of the date formats defined by your locale setting (see %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General) or using the ISO date format \"yyyy-mm-dd\" (year, month and day separated by hyphens)." msgstr "" #. aGJzN @@ -24820,13 +24820,13 @@ msgctxt "" msgid "Expression: Any string or numeric expression that you want to convert." msgstr "Expression: 日付データに変換する文字列および数値表式。" -#. 5oesN +#. Doxp9 #: 03100300.xhp msgctxt "" "03100300.xhp\n" "par_id3125864\n" "help.text" -msgid "When you convert a string expression, the date and time must be entered either in one of the date acceptance patterns defined for your locale setting (see %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages) or in ISO date format (momentarily, only the ISO format with hyphens, e.g. \"2012-12-31\" is accepted). In numeric expressions, values to the left of the decimal represent the date, beginning from December 31, 1899. Values to the right of the decimal represent the time." +msgid "When you convert a string expression, the date and time must be entered either in one of the date acceptance patterns defined for your locale setting (see %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General) or in ISO date format (momentarily, only the ISO format with hyphens, e.g. \"2012-12-31\" is accepted). In numeric expressions, values to the left of the decimal represent the date, beginning from December 31, 1899. Values to the right of the decimal represent the time." msgstr "" #. 4NDxB @@ -25288,22 +25288,22 @@ msgctxt "" msgid "CSng (Expression As Variant) As Single" msgstr "" -#. xdo5y +#. HfcGo #: 03100900.xhp msgctxt "" "03100900.xhp\n" "par_id3153897\n" "help.text" -msgid "Expression: Any string or numeric expression that you want to convert. To convert a string expression, the number must be entered as normal text using the default number format of your %PRODUCTNAME language settings. For instance, the number must be entered using a dot \".\" as the decimal point and a comma \",\" as the thousands separator (for instance 123,456.78) for the English language setting." +msgid "Expression: Any string or numeric expression that you want to convert. To convert a string expression, the number must be entered as normal text using the default number format of your %PRODUCTNAME locale settings. For instance, the number must be entered using a dot \".\" as the decimal point and a comma \",\" as the thousands separator (for instance 123,456.78) for the English locale setting." msgstr "" -#. tgSuU +#. EqTGD #: 03100900.xhp msgctxt "" "03100900.xhp\n" "par_id761652451117906\n" "help.text" -msgid "Numeric expressions are displayed according to %PRODUCTNAME language settings:" +msgid "Numeric expressions are displayed according to %PRODUCTNAME locale settings:" msgstr "" #. DirnZ diff --git a/source/ja/helpcontent2/source/text/sbasic/shared/03.po b/source/ja/helpcontent2/source/text/sbasic/shared/03.po index 5e49191e57b..251b5bd55e1 100644 --- a/source/ja/helpcontent2/source/text/sbasic/shared/03.po +++ b/source/ja/helpcontent2/source/text/sbasic/shared/03.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-02 11:34+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2021-11-26 20:38+0000\n" "Last-Translator: Jun NOGATA \n" "Language-Team: Japanese \n" @@ -9133,6 +9133,267 @@ msgctxt "" msgid "To make SQL statements more readable, you may use square brackets \"[ ]\" to enclose names of tables, queries and fields instead of using other enclosing characters that may be exclusive to certain Relational Database Management Systems (RDBMS). But beware that enclosing characters are mandatory in this context." msgstr "" +#. Xcc8E +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"hd_id461701357494930\n" +"help.text" +msgid "Transaction handling" +msgstr "" + +#. 9is6W +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"bm_id121701365380522\n" +"help.text" +msgid "Database service; Transaction handling" +msgstr "" + +#. kEjYS +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id71701357507703\n" +"help.text" +msgid "By default the database handles transactions in auto-commit mode, meaning that a commit is done after every SQL statement." +msgstr "" + +#. dHSK7 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id321701357603871\n" +"help.text" +msgid "Use the SetTransactionMode method to change the default behavior, which allows for manual commits and rollbacks." +msgstr "" + +#. WXGcE +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id431701443412927\n" +"help.text" +msgid "The methods Commit and Rollback are used to delimit transactions." +msgstr "" + +#. 4UBP5 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id531701365474516\n" +"help.text" +msgid "In %PRODUCTNAME, there are five types of transaction isolation modes, as defined in the com.sun.star.sdbc.TransactionIsolation constant group:" +msgstr "" + +#. 7zGGY +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id631701441607725\n" +"help.text" +msgid "Constant" +msgstr "" + +#. 7n7YU +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id671701441607725\n" +"help.text" +msgid "Value" +msgstr "" + +#. YJ7FT +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id441701441607725\n" +"help.text" +msgid "Interpretation" +msgstr "" + +#. N2Ybb +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id681701441607725\n" +"help.text" +msgid "NONE" +msgstr "" + +#. AGVcL +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id831701441607725\n" +"help.text" +msgid "0" +msgstr "" + +#. HKAzv +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441607725\n" +"help.text" +msgid "Transaction handling is disabled and the database is set to the default auto-commit mode." +msgstr "" + +#. m3Ba6 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id681701441607147\n" +"help.text" +msgid "READ_UNCOMMITTED" +msgstr "" + +#. F7zmg +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id831701441607208\n" +"help.text" +msgid "1" +msgstr "" + +#. aAAV4 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441607099\n" +"help.text" +msgid "Dirty reads, non-repeatable reads and phantom reads can occur." +msgstr "" + +#. XefrK +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441603205\n" +"help.text" +msgid "If a row is changed by a transaction, another transaction will be able to read these changes even if they have not been committed." +msgstr "" + +#. bwY55 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id681701441607317\n" +"help.text" +msgid "READ_COMMITTED" +msgstr "" + +#. WpA5g +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id831701441607714\n" +"help.text" +msgid "2" +msgstr "" + +#. uNAxC +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441607012\n" +"help.text" +msgid "Dirty reads are prevented, however non-repeatable reads and phantom reads can occur." +msgstr "" + +#. dieTe +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441608244\n" +"help.text" +msgid "This level prevents that rows with uncommitted changes are read." +msgstr "" + +#. VA3sE +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id681701441607209\n" +"help.text" +msgid "REPEATABLE_READ" +msgstr "" + +#. t9SuL +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id831701441607103\n" +"help.text" +msgid "4" +msgstr "" + +#. Bpi2d +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441607300\n" +"help.text" +msgid "Dirty reads and non-repeatable reads are prevented. However, phantom reads can occur." +msgstr "" + +#. jbJiF +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441608161\n" +"help.text" +msgid "Besides preventing uncommitted data from being read, it also prevents that two read operations in the same transaction return different results." +msgstr "" + +#. 6EXCL +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id681701441607060\n" +"help.text" +msgid "SERIALIZABLE" +msgstr "" + +#. DYyES +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id831701441607688\n" +"help.text" +msgid "8" +msgstr "" + +#. Yxxsv +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441607896\n" +"help.text" +msgid "Dirty reads, non-repeatable reads and phantom reads are prevented." +msgstr "" + +#. rJaPT +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id601701441607117\n" +"help.text" +msgid "In addition to the constraints of the previous level, it also ensures that the set of records that match a WHERE clause remains unchanged inside the same transaction." +msgstr "" + +#. 8GoMd +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id991701357744355\n" +"help.text" +msgid "Read the Wikipedia page on Isolation in Database Systems to learn more about transaction integrity." +msgstr "" + #. CAFnK #: sf_database.xhp msgctxt "" @@ -9448,6 +9709,123 @@ msgctxt "" msgid "Closes the current database connection." msgstr "" +#. xhv9F +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id201587913264308\n" +"help.text" +msgid "Commits all updates done since the previous Commit or Rollback call." +msgstr "" + +#. P4TEF +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id391701355293522\n" +"help.text" +msgid "This method is ignored if commits are done automatically after each SQL statement, i.e. the database is set to the default auto-commit mode." +msgstr "" + +#. DHATj +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"bas_id141701355821478\n" +"help.text" +msgid "' Set the REPEATABLE_READ transaction level" +msgstr "" + +#. 2mfAJ +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"bas_id311701355662993\n" +"help.text" +msgid "' Test some condition before committing" +msgstr "" + +#. xNjdS +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"bas_id711701355663208\n" +"help.text" +msgid "' Restore auto-commit mode" +msgstr "" + +#. XigYX +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id41599488113502\n" +"help.text" +msgid "Creates a Dataset service instance based on a table, query or SQL SELECT statement." +msgstr "" + +#. MX6BM +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id591701267115505\n" +"help.text" +msgid "sqlcommand: A table name, a query name or a valid SQL SELECT statement. Identifiers may be enclosed with square brackets. This argument is case-sensitive." +msgstr "" + +#. HSKm4 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id841701267114060\n" +"help.text" +msgid "directsql: Set this argument to True to send the statement directly to the database engine without preprocessing by %PRODUCTNAME (Default = False)." +msgstr "" + +#. ZoWu5 +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id241701267114527\n" +"help.text" +msgid "filter: Specifies the condition that records must match to be included in the returned dataset. This argument is expressed as a SQL WHERE statement without the \"WHERE\" keyword." +msgstr "" + +#. SGBKv +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id471701267115093\n" +"help.text" +msgid "orderby: Specifies the ordering of the dataset as a SQL ORDER BY statement without the \"ORDER BY\" keyword." +msgstr "" + +#. V8pDK +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id941701267748877\n" +"help.text" +msgid "The following examples in Basic and Python return a dataset with the records of a table named \"Customers\"." +msgstr "" + +#. Ebnho +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"bas_id241701267631273\n" +"help.text" +msgid "oDataset = myDatabase.CreateDataset(\"Customers\", Filter := \"[Name] LIKE 'A'\")" +msgstr "" + +#. h2NSq +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"pyc_id931701267696812\n" +"help.text" +msgid "dataset = myDatabase.CreateDataset(\"Customers\", Filter = \"[Name] LIKE 'A'\")" +msgstr "" + #. nwbSh #: sf_database.xhp msgctxt "" @@ -9799,13 +10177,22 @@ msgctxt "" msgid "tablename: The name of an existing table as a case-sensitive String." msgstr "" -#. FMBEy +#. gU77J #: sf_database.xhp msgctxt "" "sf_database.xhp\n" -"par_id31599490609759\n" +"par_id31599490603311\n" "help.text" -msgid "Executes an action query of an SQL statement such as creating a table, as well as inserting, updating and deleting records." +msgid "Cancels all changes made to the database since the last Commit or Rollback call." +msgstr "" + +#. FMBEy +#: sf_database.xhp +msgctxt "" +"sf_database.xhp\n" +"par_id31599490609759\n" +"help.text" +msgid "Executes an action query of an SQL statement such as creating a table, as well as inserting, updating and deleting records." msgstr "" #. gyiQy @@ -9844,22180 +10231,24421 @@ msgctxt "" msgid "directsql: When True, the SQL command is sent to the database engine without pre-analysis. (Default = False). For queries, the applied option is the one set when the query was defined." msgstr "" -#. 4TmY5 -#: sf_datasheet.xhp +#. iNCig +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"tit\n" +"sf_database.xhp\n" +"par_id31599490604648\n" "help.text" -msgid "SFDatabases.Datasheet service" +msgid "Defines the level of isolation in database transactions." msgstr "" -#. 8xmoA -#: sf_datasheet.xhp +#. GQaTd +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bm_id781582391760253\n" +"sf_database.xhp\n" +"par_id281701459963822\n" "help.text" -msgid "SFDatabases.Datasheet service" +msgid "By default databases manage transactions in auto-commit mode, which means that a Commit is automatically performed after every SQL statement." msgstr "" -#. CCxPd -#: sf_datasheet.xhp +#. Yq5UG +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id901619031958273\n" +"sf_database.xhp\n" +"par_id181701460140309\n" "help.text" -msgid "The Datasheet service allows to visualize the contents of database tables as well as the results of queries and SQL statements using Base's Data View. Additionally, this service allows to:" +msgid "Use this method to manually determine the isolation level of transactions. When a transaction mode other than NONE is set, the script has to explicitly call the Commit method to apply the changes to the database." msgstr "" -#. MDMA7 -#: sf_datasheet.xhp +#. NKoDH +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id241619032289964\n" +"sf_database.xhp\n" +"par_id211701461020712\n" "help.text" -msgid "Add custom menus to the data view." +msgid "This method returns True when successful." msgstr "" -#. DucpD -#: sf_datasheet.xhp +#. GwemZ +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id291619032292829\n" +"sf_database.xhp\n" +"par_id831701530239962\n" "help.text" -msgid "Access values in specific positions of the data view." +msgid "Changing the transaction mode closes all Dataset instances created from the current database." msgstr "" -#. MrxfF -#: sf_datasheet.xhp +#. DeBne +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id421619032296454\n" +"sf_database.xhp\n" +"par_id701599490609584\n" "help.text" -msgid "Position the cursor in a specific cell of the data view." +msgid "transactionmode: Specifies the transaction mode. This argument must be one of the constants defined in com.sun.star.sdbc.TransactionIsolation (Default = NONE)" msgstr "" -#. xZtEL -#: sf_datasheet.xhp +#. NYvXV +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"hd_id581582885621841\n" +"sf_database.xhp\n" +"par_id301701459879269\n" "help.text" -msgid "Service invocation" +msgid "Read the section Transaction handling above to learn more about the transaction isolation levels used in %PRODUCTNAME." msgstr "" -#. GEQkg -#: sf_datasheet.xhp +#. DQkEN +#: sf_database.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id141609955500101\n" +"sf_database.xhp\n" +"bas_id951701460628717\n" "help.text" -msgid "Before using the Datasheet service the ScriptForge library needs to be loaded or imported:" +msgid "' Reset the transaction mode to default" msgstr "" -#. UDCjV -#: sf_datasheet.xhp +#. q2YAr +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id311619033224680\n" +"sf_dataset.xhp\n" +"tit\n" "help.text" -msgid "The Datasheet service can be invoked in two different ways depending on whether the database file is open." +msgid "SFDatabases.Dataset service" msgstr "" -#. LXxpq -#: sf_datasheet.xhp +#. p9Y5W +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id781671108693239\n" +"sf_dataset.xhp\n" +"hd_id731582733781114\n" "help.text" -msgid "The example below considers that the database file is open, hence the UI service can be used to retrieve the document and the OpenTable method from the Database service is used to get a Datasheet service instance." +msgid "SFDatabases.Dataset service" msgstr "" -#. uCvbC -#: sf_datasheet.xhp +#. CmkuE +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id981671039972329\n" +"sf_dataset.xhp\n" +"par_id571700837631557\n" "help.text" -msgid "' Object oBase is an instance of the Base service" +msgid "The Dataset service is used to represent tabular data produced by a database. With this service it is possible to:" msgstr "" -#. y8TZZ -#: sf_datasheet.xhp +#. HktQA +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id451671040032633\n" +"sf_dataset.xhp\n" +"par_id891589189452545\n" "help.text" -msgid "' Object oSheet is an instance of the Datasheet service" +msgid "Navigate through and access the data in a dataset." msgstr "" -#. cnJfg -#: sf_datasheet.xhp +#. 9PgHh +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id721671040093835\n" +"sf_dataset.xhp\n" +"par_id811589189463041\n" "help.text" -msgid "In the example above it is also possible to use the method OpenQuery from the Base service to get a Datasheet instance." +msgid "Update, insert and remove records in a dataset." msgstr "" -#. 5usm9 -#: sf_datasheet.xhp +#. rByVk +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id281619033570656\n" +"sf_dataset.xhp\n" +"par_id251701124711074\n" "help.text" -msgid "To invoke the Datasheet service when the database file is not open, use the OpenTable, OpenQuery or OpenSql methods from the Database service. The example below uses the OpenTable method to open an existing table in the database file:" +msgid "Updating and inserting records using the Dataset service is slower than using SQL statements. When updating or inserting large amounts of records, it is recommended to use SQL statements instead of using the methods in this service." msgstr "" -#. 6dFFb -#: sf_datasheet.xhp +#. WAVCq +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id451671040032621\n" +"sf_dataset.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "' Object oDatabase is an instance of the Database service" +msgid "Service invocation" msgstr "" -#. vFEti -#: sf_datasheet.xhp +#. HqBAw +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id451671040032011\n" +"sf_dataset.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "' Object oSheet is an instance of the Datasheet service" +msgid "Before using the Dataset service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. TGuKf -#: sf_datasheet.xhp +#. dBCRY +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id871623102536956\n" +"sf_dataset.xhp\n" +"par_id411700851985942\n" "help.text" -msgid "The examples above can be translated to Python as follows:" +msgid "The Dataset service is invoked using the CreateDataset method, which can be called either from a Database service instance or from another Dataset instance." msgstr "" -#. xFcX4 -#: sf_datasheet.xhp +#. uB7FC +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"hd_id711600788076834\n" +"sf_dataset.xhp\n" +"par_id771700853155061\n" "help.text" -msgid "Properties" +msgid "The following example creates a Dataset from the table \"Customers\" stored in a database file." msgstr "" -#. yaMir -#: sf_datasheet.xhp +#. BPxCC +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id31671041470077\n" +"sf_dataset.xhp\n" +"bas_id491701125551393\n" "help.text" -msgid "The following properties are available in the Datasheet service:" +msgid "oDataset = oDatabase.CreateDataset(\"Customers\")" msgstr "" -#. uVScA -#: sf_datasheet.xhp +#. kjDBm +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id461600788076917\n" +"sf_dataset.xhp\n" +"par_id821701125782721\n" "help.text" -msgid "Name" +msgid "Upon the creation of the Dataset, the current record is positioned before the first record." msgstr "" -#. o9D7n -#: sf_datasheet.xhp +#. 5RQVs +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id221600788076591\n" +"sf_dataset.xhp\n" +"par_id171700853415555\n" "help.text" -msgid "Read-only" +msgid "The example below creates a Dataset instance by filtering the original dataset." msgstr "" -#. ykDW3 -#: sf_datasheet.xhp +#. jsCLR +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id761600788076328\n" +"sf_dataset.xhp\n" +"pyc_id301701127357007\n" "help.text" -msgid "Type" +msgid "dataset = database.CreateDataset(\"Customers\")" msgstr "" -#. BJ9DV -#: sf_datasheet.xhp +#. vvGTe +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id67160078807636\n" +"sf_dataset.xhp\n" +"pyc_id181701127476970\n" "help.text" -msgid "Description" +msgid "new_dataset = dataset.CreateDataset(filter = \"[City]='New York'\")" msgstr "" -#. ETvvH -#: sf_datasheet.xhp +#. UbDcm +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id311600788076756\n" +"sf_dataset.xhp\n" +"hd_id351582885195476\n" "help.text" -msgid "Yes" +msgid "Properties" msgstr "" -#. 7Xcpx -#: sf_datasheet.xhp +#. 9jpZ5 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id831600788076785\n" +"sf_dataset.xhp\n" +"par_id41582885195836\n" "help.text" -msgid "Array of Strings" +msgid "Name" msgstr "" -#. DSDCy -#: sf_datasheet.xhp +#. wYVH2 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id441600788076826\n" +"sf_dataset.xhp\n" +"par_id31582885195372\n" "help.text" -msgid "Returns an Array with the names of column headers in the datasheet." +msgid "Readonly" msgstr "" -#. AawGx -#: sf_datasheet.xhp +#. BzGFs +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id49160078807654\n" +"sf_dataset.xhp\n" +"par_id31582885195238\n" "help.text" -msgid "Yes" +msgid "Type" msgstr "" -#. XVhow -#: sf_datasheet.xhp +#. uDWJe +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id81600788076419\n" +"sf_dataset.xhp\n" +"par_id931582885195131\n" "help.text" -msgid "Returns the currently selected column name." +msgid "Description" msgstr "" -#. 8ph7x -#: sf_datasheet.xhp +#. vvCt8 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id711600788076534\n" +"sf_dataset.xhp\n" +"par_id861582885655779\n" "help.text" -msgid "Yes" +msgid "No" msgstr "" -#. cLaaP -#: sf_datasheet.xhp +#. tbT3C +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id541600788076645\n" +"sf_dataset.xhp\n" +"par_id581582885655885\n" "help.text" -msgid "Returns the number of the currently selected row, starting at 1." +msgid "Returns True if the current record position is before the first record in the dataset, otherwise returns False." msgstr "" -#. h3vRR -#: sf_datasheet.xhp +#. EteGE +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id891600788076190\n" +"sf_dataset.xhp\n" +"par_id581582885655855\n" "help.text" -msgid "Yes" +msgid "Set this property to True to move the cursor to the beginning of the dataset. Setting this property to False is ignored." msgstr "" -#. 5FdAQ -#: sf_datasheet.xhp +#. Bqkq3 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id91600788076674\n" +"sf_dataset.xhp\n" +"par_id861582885655669\n" "help.text" -msgid "Returns the file name of the Base file in FSO.FileNaming format." +msgid "Yes" msgstr "" -#. 3TyFG -#: sf_datasheet.xhp +#. PPmEj +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id561633021747903\n" +"sf_dataset.xhp\n" +"par_id271582885623525\n" "help.text" -msgid "No" +msgid "Dictionary service" msgstr "" -#. Pv5DC -#: sf_datasheet.xhp +#. brqY4 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id831633021749007\n" +"sf_dataset.xhp\n" +"par_id581582885657885\n" "help.text" -msgid "Specifies a filter to be applied to the datasheet expressed as the WHERE clause of a SQL query without the WHERE keyword. If an empty string is specified then the active Filter is removed." +msgid "Returns a Dictionary with the default values used for each field in the dataset. The fields or columns in the dataset are the keys in the dictionary." msgstr "" -#. uiSkN -#: sf_datasheet.xhp +#. 3hnoA +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id391600788076253\n" +"sf_dataset.xhp\n" +"par_id581582885653105\n" "help.text" -msgid "Yes" +msgid "The database field types are converted to their corresponding Basic/Python data types. When the field type is undefined, the default value is Null if the field is nullable or Empty." msgstr "" -#. p4e8b -#: sf_datasheet.xhp +#. 9f7Zn +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id21600788076541\n" +"sf_dataset.xhp\n" +"par_id861582885655710\n" "help.text" -msgid "Returns the number of rows in the datasheet." +msgid "No" msgstr "" -#. ZERuR -#: sf_datasheet.xhp +#. 5DCq8 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id211600788076138\n" +"sf_dataset.xhp\n" +"par_id581582885611885\n" "help.text" -msgid "No" +msgid "Returns True if the current record position is after the last record in the dataset, otherwise returns False." msgstr "" -#. y8qWp -#: sf_datasheet.xhp +#. A4QYe +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id521600788076371\n" +"sf_dataset.xhp\n" +"par_id581582885609855\n" "help.text" -msgid "Specifies the order in which records are shown expressed as the ORDER BY clause of a SQL query without the ORDER BY keyword. If an empty string is specified then the active OrderBy is removed." +msgid "Set this property to True to move the cursor to the end of the dataset. Setting this property to False is ignored." msgstr "" -#. BJAwG -#: sf_datasheet.xhp +#. FXQzh +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id21600788076758\n" +"sf_dataset.xhp\n" +"par_id861582885655205\n" "help.text" msgid "Yes" msgstr "" -#. faBy9 -#: sf_datasheet.xhp +#. pKHRj +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id871600788076196\n" +"sf_dataset.xhp\n" +"par_id581582885655369\n" "help.text" -msgid "Object" +msgid "Returns an Array containing the names of all fields in the dataset." msgstr "" -#. iCABS -#: sf_datasheet.xhp +#. iDYwc +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id781600788076694\n" +"sf_dataset.xhp\n" +"par_id861582885655966\n" "help.text" -msgid "Returns the Database service instance to which the datasheet belongs." +msgid "Yes" msgstr "" -#. 3AG3X -#: sf_datasheet.xhp +#. 2wGrC +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id261600788076841\n" +"sf_dataset.xhp\n" +"par_id581582885655812\n" +"help.text" +msgid "Returns the filter applied in addition to the eventual WHERE clause(s) in the initial SQL statement. This property is expressed as a WHERE clause without the \"WHERE\" keyword." +msgstr "" + +#. niyhC +#: sf_dataset.xhp +msgctxt "" +"sf_dataset.xhp\n" +"par_id861582885655212\n" "help.text" msgid "Yes" msgstr "" -#. zE8Xg -#: sf_datasheet.xhp +#. QyUBG +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id11600788076757\n" +"sf_dataset.xhp\n" +"par_id581582885655344\n" "help.text" -msgid "Returns a String that represents the data source, which can be a SQL statement, a table name or a query name." +msgid "Returns the ordering clause that replaces the eventual ORDER BY clause present in the initial SQL statement. This property is expressed as a ORDER BY clause without the \"ORDER BY\" keywords." msgstr "" -#. 8VKAq -#: sf_datasheet.xhp +#. 4qKPb +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id531600789141795\n" +"sf_dataset.xhp\n" +"par_id861582885655788\n" "help.text" msgid "Yes" msgstr "" -#. TSNA5 -#: sf_datasheet.xhp +#. SCZG6 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id301600789141619\n" +"sf_dataset.xhp\n" +"par_id271582885655522\n" "help.text" -msgid "Returns the type of the data source, which can be one of the following values: \"SQL\", \"TABLE\" or \"QUERY\"." +msgid "Database service" msgstr "" -#. bZqAE -#: sf_datasheet.xhp +#. TCDSW +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id541600789286532\n" +"sf_dataset.xhp\n" +"par_id581582885655062\n" "help.text" -msgid "Yes" +msgid "Returns the Database instance corresponding to the parent database of the current dataset." msgstr "" -#. wxLJ4 -#: sf_datasheet.xhp +#. SBPcF +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id181600789286889\n" +"sf_dataset.xhp\n" +"par_id861582885650968\n" "help.text" -msgid "UNO Object" +msgid "Yes" msgstr "" -#. NDjRM -#: sf_datasheet.xhp +#. HoZCK +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id701600789286280\n" +"sf_dataset.xhp\n" +"par_id581582885656472\n" "help.text" -msgid "Returns the com.sun.star.lang.XComponent UNO object that represents the datasheet." +msgid "Returns the exact number of records in the dataset." msgstr "" -#. vEoc2 -#: sf_datasheet.xhp +#. CYZ2R +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941608709527698\n" +"sf_dataset.xhp\n" +"par_id581582885656491\n" "help.text" -msgid "Yes" +msgid "Note that the evaluation of this property implies browsing the whole dataset, which may be costly depending on the dataset size." msgstr "" -#. tCgaA -#: sf_datasheet.xhp +#. 8SziE +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id100100678952791\n" +"sf_dataset.xhp\n" +"par_id861582886340968\n" "help.text" -msgid "UNO Object" +msgid "Yes" msgstr "" -#. 8jt7B -#: sf_datasheet.xhp +#. ExPSX +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id661300789527859\n" +"sf_dataset.xhp\n" +"par_id581582884026472\n" "help.text" -msgid "Returns the com.sun.star.awt.XControl UNO object that represents the datasheet." +msgid "Returns the number of the current record starting at 1. Returns 0 if this property is unknown." msgstr "" -#. 62EDa -#: sf_datasheet.xhp +#. 3tm4G +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941600789527698\n" +"sf_dataset.xhp\n" +"par_id861582886349968\n" "help.text" msgid "Yes" msgstr "" -#. 7AReG -#: sf_datasheet.xhp +#. ZTuFP +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id100160078952791\n" +"sf_dataset.xhp\n" +"par_id581582884023472\n" "help.text" -msgid "UNO Object" +msgid "Returns the source of the dataset. It can be either a table name, a query name or a SQL statement." msgstr "" -#. nTQHe -#: sf_datasheet.xhp +#. bGyUH +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id631600789527859\n" +"sf_dataset.xhp\n" +"par_id861582886352968\n" "help.text" -msgid "Returns the com.sun.star.awt.XTabControllerModel UNO object that represents the datasheet." +msgid "Yes" msgstr "" -#. wfJfa -#: sf_datasheet.xhp +#. doL3q +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"hd_id501582887473754\n" +"sf_dataset.xhp\n" +"par_id581582884295472\n" "help.text" -msgid "Methods" +msgid "Returns the source of the dataset. It can be one of the following string values: TABLE, QUERY or SQL." msgstr "" -#. wgVfx -#: sf_datasheet.xhp +#. cA9pt +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id451619034669263\n" +"sf_dataset.xhp\n" +"par_id861582886368268\n" "help.text" -msgid "List of Methods in the Datasheet Service" +msgid "Yes" msgstr "" -#. euurc -#: sf_datasheet.xhp +#. XYGFy +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099743199\n" +"sf_dataset.xhp\n" +"par_id581582884255372\n" "help.text" -msgid "Brings to front the data view window referred to by the Datasheet instance." +msgid "Returns an Array containing the names of the fields of the dataset that are updatable." msgstr "" -#. ZQdnE -#: sf_datasheet.xhp +#. F6ZCq +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099748128\n" +"sf_dataset.xhp\n" +"par_id861582886302268\n" "help.text" -msgid "Closes the data view window referred to by the Datasheet instance." +msgid "Yes" msgstr "" -#. fStHW -#: sf_datasheet.xhp +#. ykZky +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099748639\n" +"sf_dataset.xhp\n" +"par_id581582884370372\n" "help.text" -msgid "Creates a new menu entry in the data view window and returns a SFWidgets.Menu service instance, with which menu items can be programmatically added." +msgid "Returns a Dictionary containing the pairs (field name: value) of the current record in the dataset." msgstr "" -#. H4ghA -#: sf_datasheet.xhp +#. aao9u +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id71671047526843\n" +"sf_dataset.xhp\n" +"par_id861582886325668\n" "help.text" -msgid "Menus added using the CreateMenu method are lost as soon as the data view window is closed." +msgid "Yes" msgstr "" -#. QC9Uh -#: sf_datasheet.xhp +#. hTAUU +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997155\n" +"sf_dataset.xhp\n" +"par_id271582887376762\n" "help.text" -msgid "menuheader: The name of the new menu." +msgid "UNO object" msgstr "" -#. yVxAC -#: sf_datasheet.xhp +#. rhAHw +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997180\n" +"sf_dataset.xhp\n" +"par_id581582884392072\n" "help.text" -msgid "before: This argument can be either the name of an existing menu entry before which the new menu will be placed or a number expressing the position of the new menu. If this argument is left blank the new menu is placed as the last entry." +msgid "Returns the com.sun.star.sdb.RowSet UNO object representing the dataset." msgstr "" -#. MXC5w -#: sf_datasheet.xhp +#. DCeqW +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997090\n" +"sf_dataset.xhp\n" +"par_id651606319520519\n" "help.text" -msgid "submenuchar: The delimiter used in menu trees (Default = \">\")" +msgid "List of Methods in the Dataset Service" msgstr "" -#. EMDiB -#: sf_datasheet.xhp +#. HPN2T +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id461619100382442\n" +"sf_dataset.xhp\n" +"par_id93158919969864\n" "help.text" -msgid "Set oMenu = oSheet.CreateMenu(\"My Menu\", Before := \"Data\")" +msgid "Closes the current dataset. This method returns True when successful." msgstr "" -#. zLvjn -#: sf_datasheet.xhp +#. EM77w +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id591671048413063\n" +"sf_dataset.xhp\n" +"par_id781701179217081\n" "help.text" -msgid ".AddItem(\"Item 1\", Command := \".uno:About\")" +msgid "It is recommended to close the dataset after its use to free resources." msgstr "" -#. DKtUn -#: sf_datasheet.xhp +#. 8ocyE +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"pyc_id361623165059667\n" +"sf_dataset.xhp\n" +"par_id93158919343864\n" "help.text" -msgid "menu = sheet.CreateMenu(\"My Menu\", before=\"Data\")" +msgid "Returns a Dataset service instance from an existing dataset by applying the specified filter and order by statements." msgstr "" -#. WAFYz -#: sf_datasheet.xhp +#. sTshg +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"pyc_id571671048780765\n" +"sf_dataset.xhp\n" +"par_id381701012509515\n" "help.text" -msgid "menu.AddItem(\"Item 1\", command=\".uno:About\")" +msgid "filter: Specifies the condition that records must match to be included in the returned dataset. This argument is expressed as a SQL WHERE statement without the \"WHERE\" keyword. If this argument is not specified, then the filter used in the current dataset is applied, otherwise the current filter is replaced by this argument." msgstr "" -#. K62eP -#: sf_datasheet.xhp +#. 96FYs +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id521671048538692\n" +"sf_dataset.xhp\n" +"par_id381701012563515\n" "help.text" -msgid "Read the Menu service help page to learn more about how to create menu and submenu entries and associate commands." +msgid "orderby: Specifies the ordering of the dataset as a SQL ORDER BY statement without the \"ORDER BY\" keyword. If this argument is not specified, then the sorting order used in the current dataset is applied, otherwise the current sorting order is replaced by this argument." msgstr "" -#. nXH8z -#: sf_datasheet.xhp +#. nGFDX +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099748009\n" +"sf_dataset.xhp\n" +"pyc_id221701180362978\n" "help.text" -msgid "Returns the text in a given column of the current row." +msgid "new_dataset = dataset.CreateDataset(filter = \"\")" msgstr "" -#. DJ8Ft -#: sf_datasheet.xhp +#. 3GUnc +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id161671050245887\n" +"sf_dataset.xhp\n" +"pyc_id581701180363338\n" "help.text" -msgid "This method does not change the position of the cursor in the data view window." +msgid "new_dataset = dataset.CreateDataset(filter = \"[Name] = 'John'\")" msgstr "" -#. 3qnwN -#: sf_datasheet.xhp +#. FfGsf +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997693\n" +"sf_dataset.xhp\n" +"pyc_id261701180365275\n" "help.text" -msgid "column: The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned." +msgid "new_dataset = dataset.CreateDataset(filter = \"[Name] LIKE 'A'\")" msgstr "" -#. ED6ma -#: sf_datasheet.xhp +#. xFhtG +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099747177\n" +"sf_dataset.xhp\n" +"pyc_id481701180365786\n" "help.text" -msgid "Returns the value in a given column of the current row as a valid Basic type." +msgid "new_dataset = dataset.CreateDataset(filter = f\"({dataset.Filter}) AND [Name] LIKE 'A'\")" msgstr "" -#. fXDwA -#: sf_datasheet.xhp +#. nSBrV +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id91671050315349\n" +"sf_dataset.xhp\n" +"par_id93158919961074\n" "help.text" -msgid "The types that can be returned are: String, Integer, Long, Single, Double, Date and Null." +msgid "Deletes the current record from the dataset. This method returns True when successful." msgstr "" -#. HADUe -#: sf_datasheet.xhp +#. DeLNv +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id411671050476363\n" +"sf_dataset.xhp\n" +"par_id101701180833688\n" "help.text" -msgid "Binary types are returned as a Long value indicating the length of the binary field." +msgid "After this operation the cursor is positioned at the record immediately after the deleted record. If the deleted record is the last in the dataset, then the cursor is positioned after it and the property EOF returns True." msgstr "" -#. nTQDh -#: sf_datasheet.xhp +#. GVCDT +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id141671050559691\n" +"sf_dataset.xhp\n" +"par_id93158955243864\n" "help.text" -msgid "An Empty value is returned if the required value could not be retrieved." +msgid "Exports the value of a binary field of the current record to the specified file." msgstr "" -#. BtN8B -#: sf_datasheet.xhp +#. tF5uw +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id161671050245365\n" +"sf_dataset.xhp\n" +"par_id171701181928026\n" "help.text" -msgid "This method does not change the position of the cursor in the data view window." +msgid "If the specified field is not binary or if it contains no data, then the output file is not created." msgstr "" -#. DwSZS -#: sf_datasheet.xhp +#. wmnpF +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997253\n" +"sf_dataset.xhp\n" +"par_id381701012500605\n" "help.text" -msgid "column: The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned." +msgid "fieldname: The name of the binary field to be exported, as a case-sensitive string." msgstr "" -#. ij88V -#: sf_datasheet.xhp +#. U7h8Q +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099747188\n" +"sf_dataset.xhp\n" +"par_id381701012563717\n" "help.text" -msgid "Moves the cursor to the specified row and column." +msgid "filename: The complete path to the file to be created using the notation defined in the FileSystem.FileNaming property." msgstr "" -#. 4CXzN -#: sf_datasheet.xhp +#. bLWJ5 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id161671050245147\n" +"sf_dataset.xhp\n" +"par_id417011815228395\n" "help.text" -msgid "This method does not change the position of the cursor in the data view window." +msgid "overwrite: Set this argument to True to allow the destination file to be overwritten (Default = False)." msgstr "" -#. CECkE -#: sf_datasheet.xhp +#. somcy +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id231671105664098\n" +"sf_dataset.xhp\n" +"par_id1001701183010649\n" "help.text" -msgid "row: The row number as a numeric value starting at 1. If the requested row exceeds the number of existing rows, the cursor is moved to the last row. If this argument is not specified, then the row is not changed." +msgid "In the example below the dataset contains a field named \"Picture\" that shall be exported to an image file." msgstr "" -#. 4AYCp -#: sf_datasheet.xhp +#. baa7B +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997124\n" +"sf_dataset.xhp\n" +"bas_id191701180096457\n" "help.text" -msgid "column: The name of the column as a String or the column position (starting at 1). If the requested column exceeds the number of existing columns, the cursor is moved to the last column. If this argument is not specified, then the column is not changed." +msgid "oDataset.ExportValueToFile(\"Picture\", \"C:\\my_image.png\", True)" msgstr "" -#. t7xYa -#: sf_datasheet.xhp +#. HSjEn +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id741671106250967\n" +"sf_dataset.xhp\n" +"pyc_id221701180362303\n" "help.text" -msgid "' Moves the cursor to the column \"LastName\" in row 4" +msgid "dataset.ExportValueToFile(\"Picture\", r\"C:\\my_image.png\", True)" msgstr "" -#. BRB4u -#: sf_datasheet.xhp +#. jUxfq +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id51671106293155\n" +"sf_dataset.xhp\n" +"par_id93158919349654\n" "help.text" -msgid "oSheet.GoToCell(4, \"LastName\")" +msgid "Returns the contents of the dataset in a 2-dimensional array, starting from the first record after the current record." msgstr "" -#. xvnqb -#: sf_datasheet.xhp +#. wKNGY +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id616711059619900\n" +"sf_dataset.xhp\n" +"par_id86170118381308\n" "help.text" -msgid "' Moves the cursor to the third column of the current row" +msgid "After execution, the cursor is positioned at the row that was last read or after the last record in the dataset, in which case the EOF property returns True." msgstr "" -#. sSJ4S -#: sf_datasheet.xhp +#. CYiz6 +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id611671106014685\n" +"sf_dataset.xhp\n" +"par_id86170118381410\n" "help.text" -msgid "' Moves cursor one row down leaving it in the same column" +msgid "This method can be used to read data from the dataset in chunks, whose size is defined by the maxrows argument." msgstr "" -#. hLAZS -#: sf_datasheet.xhp +#. Qa3iR +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"bas_id711671107842042\n" +"sf_dataset.xhp\n" +"par_id741701183770602\n" "help.text" -msgid "' Moves to the last column of the last row" +msgid "The returned array will always have two dimensions, even if the dataset contains a single column and a single record." msgstr "" -#. 4mHFQ -#: sf_datasheet.xhp +#. 4QAUM +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"pyc_id361623165059099\n" +"sf_dataset.xhp\n" +"par_id381701010547515\n" "help.text" -msgid "sheet.GoToCell(4, \"LastName\")" +msgid "header: Set this argument to True to make the first entry in the Array contain the column headers (Default = False)." msgstr "" -#. zU2uu -#: sf_datasheet.xhp +#. iCFyh +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id801916099747090\n" +"sf_dataset.xhp\n" +"par_id381701012520715\n" "help.text" -msgid "Removes a menu entry from the data view by its name." +msgid "maxrows: Define the maximum number of records to be returned. If the number of existing records is smaller than maxrows, then the returned array will have only the existing records. Leave this argument blank or set it to zero to return all rows in the dataset (Default = 0)" msgstr "" -#. FhSiD -#: sf_datasheet.xhp +#. mMgUE +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id511671106735805\n" +"sf_dataset.xhp\n" +"par_id171701202610657\n" "help.text" -msgid "This method can remove menus that belong to the standard user interface as well as menus that were programmatically added with the CreateMenu method. The removal of standard menus is not permanent and they will reappear after the window is closed and reopened." +msgid "The following example reads a dataset in chunks of 100 rows until all the dataset has been read." msgstr "" -#. ED3Co -#: sf_datasheet.xhp +#. jGCUD +#: sf_dataset.xhp msgctxt "" -"sf_datasheet.xhp\n" -"par_id941619079997083\n" +"sf_dataset.xhp\n" +"par_id93190955243864\n" "help.text" -msgid "menuheader: The case-sensitive name of the menu to be removed. The name must not include the tilde (\"~\") character." +msgid "Returns the value of the specified field from the current record of the dataset." msgstr "" -#. BC4Sc -#: sf_dialog.xhp +#. odbAa +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"tit\n" +"sf_dataset.xhp\n" +"par_id171701181922516\n" "help.text" -msgid "SFDialogs.Dialog service" +msgid "If the specified field is binary, then its length is returned." msgstr "" -#. ZQBAD -#: sf_dialog.xhp +#. Tb26K +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"bm_id781582391760253\n" +"sf_dataset.xhp\n" +"par_id381701012554805\n" "help.text" -msgid "SFDialogs.Dialog service" +msgid "fieldname: The name of the field to be returned, as a case-sensitive string." msgstr "" -#. tvCua -#: sf_dialog.xhp +#. 9DEBy +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id931583589764919\n" +"sf_dataset.xhp\n" +"bas_id191701180036057\n" "help.text" -msgid "The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor or dialogs created on-the-fly. Each instance of the current class represents a single dialog box displayed to the user." +msgid "currId = oDataset.GetValue(FieldName := \"ID\")" msgstr "" -#. vxEvV -#: sf_dialog.xhp +#. Km78M +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id831598110550771\n" +"sf_dataset.xhp\n" +"pyc_id221701180366903\n" "help.text" -msgid "A dialog box can be displayed in modal or in non-modal modes." +msgid "curr_id = dataset.GetValue(fieldname = \"ID\")" msgstr "" -#. LVjBj -#: sf_dialog.xhp +#. pDNd8 +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id221598110444025\n" +"sf_dataset.xhp\n" +"par_id93190998043864\n" "help.text" -msgid "In modal mode, the box is displayed and the execution of the macro process is suspended until one of the OK or Cancel buttons is pressed. In the meantime, user actions executed on the box can trigger specific actions." +msgid "Inserts a new record at the end of the dataset and initialize its fields with the specified values." msgstr "" -#. FFTSj -#: sf_dialog.xhp +#. HQzFF +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id981598110463521\n" +"sf_dataset.xhp\n" +"par_id941701206804894\n" "help.text" -msgid "In non-modal mode, the dialog box is \"floating\" on the user desktop and the execution of the macro process continues normally. A non-modal dialog closes when it is terminated with the Terminate() method or when the %PRODUCTNAME session ends. The window close button is inactive in non-modal dialogs." +msgid "If the primary key of the dataset is an auto value, then this method returns the primary key value of the new record. Otherwise, the method will return 0 (when successful) or -1 (when not successful)." msgstr "" -#. GrpyR -#: sf_dialog.xhp +#. bESBG +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id721598110472337\n" +"sf_dataset.xhp\n" +"par_id51701203344601\n" "help.text" -msgid "A dialog box disappears from memory after its explicit termination." +msgid "Updatable fields with unspecified values are initialized with their default values." msgstr "" -#. asacX -#: sf_dialog.xhp +#. Ee77f +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id891598188164936\n" +"sf_dataset.xhp\n" +"par_id171701181920016\n" "help.text" -msgid "The SFDialogs.Dialog service is closely related to the SFDialogs.DialogControl service." +msgid "If the specified field is binary, then its length is returned." msgstr "" -#. CByHp -#: sf_dialog.xhp +#. hzFC6 +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"hd_id581582885621841\n" +"sf_dataset.xhp\n" +"par_id381701012511805\n" "help.text" -msgid "Service invocation and usage" +msgid "pvargs: A Dictionary containing pairs of field names and their respective values. Alternatively, an even number of arguments can be specified alternating field names (as a String) and their values." msgstr "" -#. FfZWj -#: sf_dialog.xhp +#. UdWGr +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id141609955500101\n" +"sf_dataset.xhp\n" +"par_id641701259882955\n" "help.text" -msgid "Before using the Dialog service the ScriptForge library needs to be loaded or imported:" +msgid "Consider a table named \"Customers\" with 4 fields: \"ID\" (BigInt, auto value and primary key), \"Name\" (VarChar), \"Age\" (Integer), \"City\" (VarChar)." msgstr "" -#. EzMcF -#: sf_dialog.xhp +#. dEDJy +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id361598174756160\n" +"sf_dataset.xhp\n" +"par_id701701205243738\n" "help.text" -msgid "The Dialog service is invoked through the CreateScriptService method. It requires three supplemental positional arguments to specify the dialog box to activate:" +msgid "The example below inserts a new record into this dataset using a Dictionary." msgstr "" -#. KyBGV -#: sf_dialog.xhp +#. zucti +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id31612271944733\n" +"sf_dataset.xhp\n" +"bas_id131701260037206\n" "help.text" -msgid "Container: \"GlobalScope\" for preinstalled libraries or a window name as defined by ScriptForge.UI service. Empty string \"\" default value stands for the current document." +msgid "oDataset = oDatabase.CreateDataset(\"Customers\")" msgstr "" -#. juLgm -#: sf_dialog.xhp +#. FaMQe +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id311612271947124\n" +"sf_dataset.xhp\n" +"bas_id171701260037639\n" "help.text" -msgid "Library: The case-sensitive name of a library contained in the container. Default value is \"Standard\"." +msgid "oNewData.Add(\"Name\", \"John\")" msgstr "" -#. FSp5N -#: sf_dialog.xhp +#. cDNXj +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id821612271946316\n" +"sf_dataset.xhp\n" +"bas_id641701260037815\n" "help.text" -msgid "DialogName: A case-sensitive string designating the dialog." +msgid "oNewData.Add(\"Age\", 50)" msgstr "" -#. L5fJw -#: sf_dialog.xhp +#. J83BR +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id761620142701399\n" +"sf_dataset.xhp\n" +"bas_id401701260038016\n" "help.text" -msgid "The examples below in Basic and Python display the dlgConsole dialog that belongs to the ScriptForge shared library:" +msgid "oNewData.Add(\"City\", \"Chicago\")" msgstr "" -#. mqjFF -#: sf_dialog.xhp +#. BiEnX +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id321598171269873\n" +"sf_dataset.xhp\n" +"par_id671701260191972\n" "help.text" -msgid "'... controls initialization goes here..." +msgid "The same result can be achieved by passing all pairs of fields and values as arguments:" msgstr "" -#. yn6sy -#: sf_dialog.xhp +#. aPs48 +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id471598176518738\n" +"sf_dataset.xhp\n" +"bas_id91701260241574\n" "help.text" -msgid "'Default mode = Modal" +msgid "oDataset.Insert(\"Name\", \"John\", \"Age\", 50, \"City\", \"Chicago\")" msgstr "" -#. h9a9G -#: sf_dialog.xhp +#. GJrf8 +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id551598171288547\n" +"sf_dataset.xhp\n" +"pyc_id401701260819750\n" "help.text" -msgid "'... Process controls and do what is needed here" +msgid "dataset = database.CreateDataset(\"Customers\")" msgstr "" -#. VD35X -#: sf_dialog.xhp +#. GibCs +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id601619622310089\n" +"sf_dataset.xhp\n" +"pyc_id181701260820135\n" "help.text" -msgid "Or using Python:" +msgid "new_data = {\"Name\": \"John\", \"Age\": 30, \"City\": \"Chicago\"}" msgstr "" -#. knENA -#: sf_dialog.xhp +#. tEtaE +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id41619622700314\n" +"sf_dataset.xhp\n" +"pyc_id651701260820486\n" "help.text" -msgid "# ... controls initialization goes here..." +msgid "new_id = dataset.Insert(new_data)" msgstr "" -#. 2PTBU -#: sf_dialog.xhp +#. PL6Tb +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id661611699964814\n" +"sf_dataset.xhp\n" +"par_id971701261086678\n" "help.text" -msgid "# Default mode is Modal" +msgid "The following calls are accepted in Python:" msgstr "" -#. ABoA2 -#: sf_dialog.xhp +#. iVyAx +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id681619619965191\n" +"sf_dataset.xhp\n" +"pyc_id101701260954243\n" "help.text" -msgid "# ... Process controls and do what is needed here" +msgid "dataset.Insert(\"Name\", \"John\", \"Age\", 50, \"City\", \"Chicago\")" msgstr "" -#. BkTv6 -#: sf_dialog.xhp +#. SSUPT +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id811670854106781\n" +"sf_dataset.xhp\n" +"pyc_id131701261111943\n" "help.text" -msgid "Use the string \"GlobalScope\" as the container argument when the dialog is stored either in My Macros & Dialogs or in Application Macros & Dialogs." +msgid "dataset.Insert(Name = \"John\", Age = 50, City = \"Chicago\")" msgstr "" -#. vwuNC -#: sf_dialog.xhp +#. NYaXF +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id461688463074274\n" +"sf_dataset.xhp\n" +"par_id93190955243874\n" "help.text" -msgid "The dialog service offers methods that create new controls dynamically in an existing dialog predefined with the Dialog Editor. A dialog is initialized with controls in the Dialog Editor and new controls can be added at run-time before or after the dialog Execute() statement." +msgid "Moves the dataset cursor to the first (with MoveFirst) or to the last (with MoveLast) record." msgstr "" -#. 5PbBk -#: sf_dialog.xhp +#. MNACy +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id261688459210848\n" +"sf_dataset.xhp\n" +"par_id411701262609847\n" "help.text" -msgid "The Dialog service can equally be invoked - through the CreateScriptService method - when creating dialogs on-the-fly. It requires two supplemental positional arguments after the name of the ad-hoc service \"NewDialog\":" +msgid "This method returns True when successful." msgstr "" -#. B82Et -#: sf_dialog.xhp +#. 9vNrm +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id751688460276630\n" +"sf_dataset.xhp\n" +"par_id61701280052346\n" "help.text" -msgid "DialogName: A case-sensitive string designating the dialog." +msgid "Deleted records are ignored by this method." msgstr "" -#. VEJtV -#: sf_dialog.xhp +#. pHTs8 +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id751688460276640\n" +"sf_dataset.xhp\n" +"bas_id191701180876057\n" "help.text" -msgid "Place: Window location of the dialog being either :" +msgid "oDataset.MoveFirst()" msgstr "" -#. wXa8D -#: sf_dialog.xhp +#. 5E5mc +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id421598178080993\n" +"sf_dataset.xhp\n" +"pyc_id221701180096903\n" "help.text" -msgid "a Basic Array or Python tuple with 4 elements: (X, Y, width, height)" +msgid "dataset.MoveFirst()" msgstr "" -#. PnCAR -#: sf_dialog.xhp +#. YFTHA +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id881502858229301\n" +"sf_dataset.xhp\n" +"par_id93190955243345\n" "help.text" -msgid "a com.sun.star.awt.Rectangle [X, Y, Width, Height] object" +msgid "Moves the dataset cursor forward (with MoveNext) or backwards (with MovePrevious) by a given number of records." msgstr "" -#. HkCDF -#: sf_dialog.xhp +#. ZgZBd +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id241688051453685\n" +"sf_dataset.xhp\n" +"par_id411701262609872\n" "help.text" -msgid "All elements are expressed in Map AppFont units." +msgid "This method returns True when successful." msgstr "" -#. sKdLk -#: sf_dialog.xhp +#. P3w8A +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id601619633410089\n" +"sf_dataset.xhp\n" +"par_id617012800527025\n" "help.text" -msgid "Or using Python:" +msgid "Deleted records are ignored by this method." msgstr "" -#. 7D42J -#: sf_dialog.xhp +#. uETmF +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id981688462077340\n" +"sf_dataset.xhp\n" +"par_id381701012554644\n" "help.text" -msgid "dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40, 110))" +msgid "offset: The number of records by which the cursor shall be moved forward or backwards. This argument may be a negative value (Default = 1)." msgstr "" -#. wF8Se -#: sf_dialog.xhp +#. TBpEB +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id681619620065191\n" +"sf_dataset.xhp\n" +"bas_id191701180036941\n" "help.text" -msgid "# ... Process controls and do what is needed" +msgid "oDataset.MoveNext()" msgstr "" -#. JhBcB -#: sf_dialog.xhp +#. sAtoz +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id951688460698125\n" +"sf_dataset.xhp\n" +"bas_id951701262692898\n" "help.text" -msgid "All properties and methods applicable to predefined dialogs are available for such new dialogs. In particular the series of CreateXXX() methods for the additionof new dialog controls." +msgid "oDataset.MoveNext(5)" msgstr "" -#. 8iyqo -#: sf_dialog.xhp +#. vASBX +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"hd_id141670854511382\n" +"sf_dataset.xhp\n" +"pyc_id221701180366885\n" "help.text" -msgid "Retrieving the Dialog instance that triggered a dialog event" +msgid "dataset.MoveNext()" msgstr "" -#. BVcDA -#: sf_dialog.xhp +#. ovQ9A +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id951598174966322\n" +"sf_dataset.xhp\n" +"pyc_id601701262720188\n" "help.text" -msgid "An instance of the Dialog service can be retrieved via the SFDialogs.DialogEvent service, provided that the dialog was initiated with the Dialog service. In the example below, oDlg contains the Dialog instance that triggered the dialog event." +msgid "dataset.MoveNext(5)" msgstr "" -#. 4FBts -#: sf_dialog.xhp +#. gfYEg +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id741619625211462\n" +"sf_dataset.xhp\n" +"par_id93190955243383\n" "help.text" -msgid "Or using Python:" +msgid "Reloads the dataset from the database. The properties Filter and OrderBy may be defined when calling this method." msgstr "" -#. 5zauR -#: sf_dialog.xhp +#. qTLq2 +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id251598176312571\n" +"sf_dataset.xhp\n" +"par_id411701262522872\n" "help.text" -msgid "Note that in the previous examples, the prefix \"SFDialogs.\" may be omitted when deemed appropriate." +msgid "This method returns True when successful." msgstr "" -#. KCDyk -#: sf_dialog.xhp +#. 4N2Sk +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"hd_id681670854491710\n" +"sf_dataset.xhp\n" +"par_id681701263394717\n" "help.text" -msgid "Handling exceptions in event handlers" +msgid "Reloading the dataset is useful when records have been inserted to or deleted from the database. Note that the methods CreateDataset and Reload perform similar functions, however Reload reuses the same Dataset class instance." msgstr "" -#. 9kZzz -#: sf_dialog.xhp +#. BeqeG +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id971670855125683\n" +"sf_dataset.xhp\n" +"par_id381701012509626\n" "help.text" -msgid "When creating an event handler for dialog events it is good practice to handle errors inside the subroutine itself. For instance, suppose the event handler below is called when the mouse button is pressed in the dialog window." +msgid "filter: Specifies the condition that records must match to be included in the returned dataset. This argument is expressed as a SQL WHERE statement without the \"WHERE\" keyword. If this argument is not specified, then the filter used in the current dataset is applied, otherwise the current filter is replaced by this argument." msgstr "" -#. AVgYD -#: sf_dialog.xhp +#. 7kCWx +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id261670857160312\n" +"sf_dataset.xhp\n" +"par_id381701012563914\n" "help.text" -msgid "' Process the event" +msgid "orderby: Specifies the ordering of the dataset as a SQL ORDER BY statement without the \"ORDER BY\" keyword. If this argument is not specified, then the sorting order used in the current dataset is applied, otherwise the current sorting order is replaced by this argument." msgstr "" -#. fLvwj -#: sf_dialog.xhp +#. D4cHf +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id691670857377446\n" +"sf_dataset.xhp\n" +"bas_id191701180036128\n" "help.text" -msgid "Call SF_Exception.Clear if you do not want the error to propagate after the dialog execution ended." +msgid "oDataset.Reload()" msgstr "" -#. fJoDn -#: sf_dialog.xhp +#. xAG6h +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id741619625211445\n" +"sf_dataset.xhp\n" +"bas_id951701262692252\n" "help.text" -msgid "In Python use native try/except blocks for exception handling as shown below:" +msgid "oDataset.Reload(Filter := \"[Name] = 'John'\", OrderBy := \"Age\")" msgstr "" -#. vDjYf -#: sf_dialog.xhp +#. NK5Zg +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id491670866556493\n" +"sf_dataset.xhp\n" +"pyc_id221701180367255\n" "help.text" -msgid "# Process the event" +msgid "dataset.Reload()" msgstr "" -#. LNECW -#: sf_dialog.xhp +#. VxECB +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id416708660557072\n" +"sf_dataset.xhp\n" +"pyc_id601701262720097\n" "help.text" -msgid "# The object \"bas\" is an instance of the Basic service" +msgid "dataset.Reload(Filter = \"[Name] = 'John'\", OrderBy = \"Age\"" msgstr "" -#. nXGkZ -#: sf_dialog.xhp +#. AQgTY +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"hd_id651583668365757\n" +"sf_dataset.xhp\n" +"par_id93190955060783\n" "help.text" -msgid "Properties" +msgid "Update the values of the specified fields in the current record." msgstr "" -#. zVLEC -#: sf_dialog.xhp +#. 9y7wT +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id871583668386455\n" +"sf_dataset.xhp\n" +"par_id411701262529574\n" "help.text" -msgid "Name" +msgid "This method returns True when successful." msgstr "" -#. FBCFG -#: sf_dialog.xhp +#. AuDhR +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id491583668386455\n" +"sf_dataset.xhp\n" +"par_id381701012546805\n" "help.text" -msgid "ReadOnly" +msgid "pvargs: A Dictionary containing pairs of field names and their respective values. Alternatively, an even number of arguments can be specified alternating field names (as a String) and their values." msgstr "" -#. ByVDE -#: sf_dialog.xhp +#. UpZsi +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id271583668474014\n" +"sf_dataset.xhp\n" +"par_id791701264626511\n" "help.text" -msgid "Type" +msgid "The example below updates the current record using a Dictionary." msgstr "" -#. 8AUBJ -#: sf_dialog.xhp +#. 9XyJf +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id401583668386455\n" +"sf_dataset.xhp\n" +"bas_id617012650175222\n" "help.text" -msgid "Description" +msgid "oNewValues = CreateScriptService(\"Dictionary\")" msgstr "" -#. iZZec -#: sf_dialog.xhp +#. qjYTQ +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id371583668519172\n" +"sf_dataset.xhp\n" +"bas_id511701265017930\n" "help.text" -msgid "Yes" +msgid "oNewValues.Add(\"Age\", 51)" msgstr "" -#. av994 -#: sf_dialog.xhp +#. kDD7r +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id771583668386455\n" +"sf_dataset.xhp\n" +"bas_id491701265018498\n" "help.text" -msgid "Value = 1. An OK button was pressed." +msgid "oNewValues.Add(\"City\", \"New York\")" msgstr "" -#. GKcTG -#: sf_dialog.xhp +#. FTLwr +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id541583839708548\n" +"sf_dataset.xhp\n" +"bas_id401701265027933\n" "help.text" -msgid "Yes" +msgid "oDataset.Update(oNewValues)" msgstr "" -#. z4BZ4 -#: sf_dialog.xhp +#. ioYcY +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id731583839708412\n" +"sf_dataset.xhp\n" +"par_id221701264980261\n" "help.text" -msgid "Value = 0. A Cancel button was pressed." +msgid "The same result can be achieved by passing all pairs of fields and values as arguments:" msgstr "" -#. cThsX -#: sf_dialog.xhp +#. xfo7y +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id761584027709516\n" +"sf_dataset.xhp\n" +"bas_id191701180033508\n" "help.text" -msgid "No" +msgid "oDataset.Update(\"Age\", 51, \"City\", \"New York\")" msgstr "" -#. 48bDT -#: sf_dialog.xhp +#. VhWGr +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id971584027709752\n" +"sf_dataset.xhp\n" +"pyc_id221701180363025\n" "help.text" -msgid "Specify the title of the dialog." +msgid "new_values = {\"Age\": 51, \"City\": \"New York\"}" msgstr "" -#. 2pjyZ -#: sf_dialog.xhp +#. sPdJv +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id31583839767743\n" +"sf_dataset.xhp\n" +"pyc_id601701262720082\n" "help.text" -msgid "No" +msgid "dataset.Update(new_values)" msgstr "" -#. 3Rypn -#: sf_dialog.xhp +#. oWPDV +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id111583839767195\n" +"sf_dataset.xhp\n" +"pyc_id761701265203650\n" "help.text" -msgid "Specify the height of the dialog box." +msgid "dataset.Update(\"Age\", 51, \"City\", \"New York\")" msgstr "" -#. KD2zy -#: sf_dialog.xhp +#. 8RvfD +#: sf_dataset.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id771583839920487\n" +"sf_dataset.xhp\n" +"pyc_id141701265203921\n" "help.text" -msgid "Yes" +msgid "dataset.Update(Age = 51, City = \"New York\")" msgstr "" -#. ABrxD -#: sf_dialog.xhp +#. 4TmY5 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id451583839920858\n" +"sf_datasheet.xhp\n" +"tit\n" "help.text" -msgid "Specifies if the dialog box is currently in execution in modal mode." +msgid "SFDatabases.Datasheet service" msgstr "" -#. sA5Nj -#: sf_dialog.xhp +#. 8xmoA +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id571588333908716\n" +"sf_datasheet.xhp\n" +"bm_id781582391760253\n" "help.text" -msgid "Yes" +msgid "SFDatabases.Datasheet service" msgstr "" -#. JoAYu -#: sf_dialog.xhp +#. CCxPd +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id721588333908708\n" +"sf_datasheet.xhp\n" +"par_id901619031958273\n" "help.text" -msgid "The name of the dialog" +msgid "The Datasheet service allows to visualize the contents of database tables as well as the results of queries and SQL statements using Base's Data View. Additionally, this service allows to:" msgstr "" -#. jcbwB -#: sf_dialog.xhp +#. MDMA7 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id501583774433513\n" +"sf_datasheet.xhp\n" +"par_id241619032289964\n" "help.text" -msgid "No" +msgid "Add custom menus to the data view." msgstr "" -#. Tfrah -#: sf_dialog.xhp +#. DucpD +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id151598177605296\n" +"sf_datasheet.xhp\n" +"par_id291619032292829\n" "help.text" -msgid "A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active." +msgid "Access values in specific positions of the data view." msgstr "" -#. FZG3n -#: sf_dialog.xhp +#. MrxfF +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id271588334016191\n" +"sf_datasheet.xhp\n" +"par_id421619032296454\n" "help.text" -msgid "No" +msgid "Position the cursor in a specific cell of the data view." msgstr "" -#. 3sRE5 -#: sf_dialog.xhp +#. xZtEL +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id251588334016874\n" +"sf_datasheet.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "Specify if the dialog box is visible on the desktop. By default it is not visible until the Execute() method is run and visible afterwards." +msgid "Service invocation" msgstr "" -#. w6DwG -#: sf_dialog.xhp +#. GEQkg +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id451598177924437\n" +"sf_datasheet.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "Yes" +msgid "Before using the Datasheet service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. 2DaKv -#: sf_dialog.xhp +#. UDCjV +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id191598177924897\n" +"sf_datasheet.xhp\n" +"par_id311619033224680\n" "help.text" -msgid "The UNO object representing the dialog model. Refer to XControlModel and UnoControlDialogModel in Application Programming Interface (API) documentation for detailed information." +msgid "The Datasheet service can be invoked in two different ways depending on whether the database file is open." msgstr "" -#. YFYi4 -#: sf_dialog.xhp +#. LXxpq +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id811598178083501\n" +"sf_datasheet.xhp\n" +"par_id781671108693239\n" "help.text" -msgid "Yes" +msgid "The example below considers that the database file is open, hence the UI service can be used to retrieve the document and the OpenTable method from the Database service is used to get a Datasheet service instance." msgstr "" -#. yexon -#: sf_dialog.xhp +#. uCvbC +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id731598178083442\n" +"sf_datasheet.xhp\n" +"bas_id981671039972329\n" "help.text" -msgid "The UNO object representing the dialog view. Refer to XControl and UnoControlDialog in Application Programming Interface (API) documentation for detailed information." +msgid "' Object oBase is an instance of the Base service" msgstr "" -#. S4DWL -#: sf_dialog.xhp +#. y8TZZ +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id31385839767743\n" +"sf_datasheet.xhp\n" +"bas_id451671040032633\n" "help.text" -msgid "No" +msgid "' Object oSheet is an instance of the Datasheet service" msgstr "" -#. G6Qsw -#: sf_dialog.xhp +#. cnJfg +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id111583839717695\n" +"sf_datasheet.xhp\n" +"par_id721671040093835\n" "help.text" -msgid "Specify the width of the dialog box." +msgid "In the example above it is also possible to use the method OpenQuery from the Base service to get a Datasheet instance." msgstr "" -#. q8eyc -#: sf_dialog.xhp +#. 5usm9 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"hd_id421612628828054\n" +"sf_datasheet.xhp\n" +"par_id281619033570656\n" "help.text" -msgid "Event properties" +msgid "To invoke the Datasheet service when the database file is not open, use the OpenTable, OpenQuery or OpenSql methods from the Database service. The example below uses the OpenTable method to open an existing table in the database file:" msgstr "" -#. EQdEV -#: sf_dialog.xhp +#. 6dFFb +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id41612629140856\n" +"sf_datasheet.xhp\n" +"bas_id451671040032621\n" "help.text" -msgid "On… properties return a URI string with the reference to the script triggered by the event. On… properties can be set programmatically.
Read its specification in the scripting framework URI specification." +msgid "' Object oDatabase is an instance of the Database service" msgstr "" -#. XCC7C -#: sf_dialog.xhp +#. vFEti +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id961612628879819\n" +"sf_datasheet.xhp\n" +"bas_id451671040032011\n" "help.text" -msgid "Name" +msgid "' Object oSheet is an instance of the Datasheet service" msgstr "" -#. eFrre -#: sf_dialog.xhp +#. TGuKf +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id401612628879819\n" +"sf_datasheet.xhp\n" +"par_id871623102536956\n" "help.text" -msgid "Read/Write" +msgid "The examples above can be translated to Python as follows:" msgstr "" -#. uW85z -#: sf_dialog.xhp +#. xFcX4 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id281612628879819\n" +"sf_datasheet.xhp\n" +"hd_id711600788076834\n" "help.text" -msgid "Basic IDE Description" +msgid "Properties" msgstr "" -#. dFkbN -#: sf_dialog.xhp +#. yaMir +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id111612629836630\n" +"sf_datasheet.xhp\n" +"par_id31671041470077\n" "help.text" -msgid "Yes" +msgid "The following properties are available in the Datasheet service:" msgstr "" -#. aKBvg -#: sf_dialog.xhp +#. uVScA +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id1001612629836902\n" +"sf_datasheet.xhp\n" +"par_id461600788076917\n" "help.text" -msgid "When receiving focus" +msgid "Name" msgstr "" -#. 4FBaJ -#: sf_dialog.xhp +#. o9D7n +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id291612629836294\n" +"sf_datasheet.xhp\n" +"par_id221600788076591\n" "help.text" -msgid "Yes" +msgid "Read-only" msgstr "" -#. 8U7FZ -#: sf_dialog.xhp +#. ykDW3 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id62161262983683\n" +"sf_datasheet.xhp\n" +"par_id761600788076328\n" "help.text" -msgid "When losing focus" +msgid "Type" msgstr "" -#. wBCKi -#: sf_dialog.xhp +#. BJ9DV +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id81612629836634\n" +"sf_datasheet.xhp\n" +"par_id67160078807636\n" "help.text" -msgid "Yes" +msgid "Description" msgstr "" -#. CK5vU -#: sf_dialog.xhp +#. ETvvH +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id881612629836744\n" +"sf_datasheet.xhp\n" +"par_id311600788076756\n" "help.text" -msgid "Key pressed" +msgid "Yes" msgstr "" -#. gXJGu -#: sf_dialog.xhp +#. 7Xcpx +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id591612629836830\n" +"sf_datasheet.xhp\n" +"par_id831600788076785\n" "help.text" -msgid "Yes" +msgid "Array of Strings" msgstr "" -#. CJwi7 -#: sf_dialog.xhp +#. DSDCy +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id161612629836775\n" +"sf_datasheet.xhp\n" +"par_id441600788076826\n" "help.text" -msgid "Key released" +msgid "Returns an Array with the names of column headers in the datasheet." msgstr "" -#. wS7GH -#: sf_dialog.xhp +#. AawGx +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id891612629836630\n" +"sf_datasheet.xhp\n" +"par_id49160078807654\n" "help.text" msgid "Yes" msgstr "" -#. GcDU7 -#: sf_dialog.xhp +#. XVhow +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id461612629836679\n" +"sf_datasheet.xhp\n" +"par_id81600788076419\n" "help.text" -msgid "Mouse moved while key presses" +msgid "Returns the currently selected column name." msgstr "" -#. eUS49 -#: sf_dialog.xhp +#. 8ph7x +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id131612629836291\n" +"sf_datasheet.xhp\n" +"par_id711600788076534\n" "help.text" msgid "Yes" msgstr "" -#. QrByH -#: sf_dialog.xhp +#. cLaaP +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id151612629836151\n" +"sf_datasheet.xhp\n" +"par_id541600788076645\n" "help.text" -msgid "Mouse inside" +msgid "Returns the number of the currently selected row, starting at 1." msgstr "" -#. CRGTF -#: sf_dialog.xhp +#. h3vRR +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id211612629836725\n" +"sf_datasheet.xhp\n" +"par_id891600788076190\n" "help.text" msgid "Yes" msgstr "" -#. 69s4B -#: sf_dialog.xhp +#. 5FdAQ +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id361612629836624\n" +"sf_datasheet.xhp\n" +"par_id91600788076674\n" "help.text" -msgid "Mouse outside" +msgid "Returns the file name of the Base file in FSO.FileNaming format." msgstr "" -#. ojLRr -#: sf_dialog.xhp +#. 3TyFG +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id311612629836481\n" +"sf_datasheet.xhp\n" +"par_id561633021747903\n" "help.text" -msgid "Yes" +msgid "No" msgstr "" -#. XaS8A -#: sf_dialog.xhp +#. Pv5DC +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id721612629836752\n" +"sf_datasheet.xhp\n" +"par_id831633021749007\n" "help.text" -msgid "Mouse moved" +msgid "Specifies a filter to be applied to the datasheet expressed as the WHERE clause of a SQL query without the WHERE keyword. If an empty string is specified then the active Filter is removed." msgstr "" -#. MnMUF -#: sf_dialog.xhp +#. uiSkN +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id981612629836116\n" +"sf_datasheet.xhp\n" +"par_id391600788076253\n" "help.text" msgid "Yes" msgstr "" -#. NtqPz -#: sf_dialog.xhp +#. p4e8b +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id381612629836635\n" +"sf_datasheet.xhp\n" +"par_id21600788076541\n" "help.text" -msgid "Mouse button pressed" +msgid "Returns the number of rows in the datasheet." msgstr "" -#. czknv -#: sf_dialog.xhp +#. ZERuR +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id711612629836704\n" +"sf_datasheet.xhp\n" +"par_id211600788076138\n" "help.text" -msgid "Yes" +msgid "No" msgstr "" -#. J2uzg -#: sf_dialog.xhp +#. y8qWp +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id35161262983642\n" +"sf_datasheet.xhp\n" +"par_id521600788076371\n" "help.text" -msgid "Mouse button released" +msgid "Specifies the order in which records are shown expressed as the ORDER BY clause of a SQL query without the ORDER BY keyword. If an empty string is specified then the active OrderBy is removed." msgstr "" -#. Z4Lnx -#: sf_dialog.xhp +#. BJAwG +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id401687779361420\n" +"sf_datasheet.xhp\n" +"par_id21600788076758\n" "help.text" -msgid "Assigning events via the Basic IDE and assigning events via macros are mutually exclusive." +msgid "Yes" msgstr "" -#. 9uiAA -#: sf_dialog.xhp +#. faBy9 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id891611613601554\n" +"sf_datasheet.xhp\n" +"par_id871600788076196\n" "help.text" -msgid "List of Methods in the Dialog Service" +msgid "Object" msgstr "" -#. GbtVM -#: sf_dialog.xhp +#. iCABS +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id161660427825856\n" +"sf_datasheet.xhp\n" +"par_id781600788076694\n" "help.text" -msgid "Dimensioning a dialog is done by using Map AppFont units. A dialog or control model also uses AppFont units. While their views use pixels." +msgid "Returns the Database service instance to which the datasheet belongs." msgstr "" -#. DiCyL -#: sf_dialog.xhp +#. 3AG3X +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id871583933076448\n" +"sf_datasheet.xhp\n" +"par_id261600788076841\n" "help.text" -msgid "Set the focus on the current Dialog instance. Return True if focusing was successful." +msgid "Yes" msgstr "" -#. 7QdPA -#: sf_dialog.xhp +#. zE8Xg +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id151598178880227\n" +"sf_datasheet.xhp\n" +"par_id11600788076757\n" "help.text" -msgid "This method is called from a dialog or control event, or when a dialog is displayed in non-modal mode." +msgid "Returns a String that represents the data source, which can be a SQL statement, a table name or a query name." msgstr "" -#. uoBhE -#: sf_dialog.xhp +#. 8VKAq +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id811620109056270\n" +"sf_datasheet.xhp\n" +"par_id531600789141795\n" "help.text" -msgid "Python and %PRODUCTNAME Basic examples both assume that the dialog is stored in current document's Standard library." +msgid "Yes" msgstr "" -#. 7VrwE -#: sf_dialog.xhp +#. TSNA5 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id391651225506119\n" +"sf_datasheet.xhp\n" +"par_id301600789141619\n" "help.text" -msgid "Centers the current dialog instance in the middle of a parent window. Without arguments, the method centers the dialog in the middle of the current window." +msgid "Returns the type of the data source, which can be one of the following values: \"SQL\", \"TABLE\" or \"QUERY\"." msgstr "" -#. xEJEH -#: sf_dialog.xhp +#. bZqAE +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id391651552206119\n" +"sf_datasheet.xhp\n" +"par_id541600789286532\n" "help.text" -msgid "Returns True when successful." +msgid "Yes" msgstr "" -#. Woksx -#: sf_dialog.xhp +#. wxLJ4 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id1001585441257789\n" +"sf_datasheet.xhp\n" +"par_id181600789286889\n" "help.text" -msgid "Parent: An optional object that can be either …" +msgid "UNO Object" msgstr "" -#. DCeY9 -#: sf_dialog.xhp +#. NDjRM +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id412598177970993\n" +"sf_datasheet.xhp\n" +"par_id701600789286280\n" "help.text" -msgid "a ScriptForge dialog object" +msgid "Returns the com.sun.star.lang.XComponent UNO object that represents the datasheet." msgstr "" -#. D5yN3 -#: sf_dialog.xhp +#. vEoc2 +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id81591858229301\n" +"sf_datasheet.xhp\n" +"par_id941608709527698\n" "help.text" -msgid "a ScriptForge document (Calc, Base, ...) object" +msgid "Yes" msgstr "" -#. 8DDWf -#: sf_dialog.xhp +#. tCgaA +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id12598185484092\n" +"sf_datasheet.xhp\n" +"par_id100100678952791\n" "help.text" -msgid "Set oDialog1 = CreateScriptService(\"DialogEvent\", oEvent) ' The dialog that caused the event" +msgid "UNO Object" msgstr "" -#. dx9rf -#: sf_dialog.xhp +#. 8jt7B +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id641598184589492\n" +"sf_datasheet.xhp\n" +"par_id661300789527859\n" "help.text" -msgid "Set oDialog2 = CreateScriptService(\"Dialog\", ...) ' Open a second dialog" +msgid "Returns the com.sun.star.awt.XControl UNO object that represents the datasheet." msgstr "" -#. kqFdv -#: sf_dialog.xhp +#. 62EDa +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id351619267575732\n" +"sf_datasheet.xhp\n" +"par_id941600789527698\n" "help.text" -msgid "dlg1 = CreateScriptService('DialogEvent.Dialog', event) # The dialog having caused the event" +msgid "Yes" msgstr "" -#. fDQAG -#: sf_dialog.xhp +#. 7AReG +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id431619267576082\n" +"sf_datasheet.xhp\n" +"par_id100160078952791\n" "help.text" -msgid "dlg2 = CreateScriptService('Dialog', ...) # Open a second dialog" +msgid "UNO Object" msgstr "" -#. wAahr -#: sf_dialog.xhp +#. nTQHe +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id161584552357982\n" +"sf_datasheet.xhp\n" +"par_id631600789527859\n" "help.text" -msgid "Duplicate an existing control of any typein the actual dialog. The duplicated control is left unchanged and can be relocated." +msgid "Returns the com.sun.star.awt.XTabControllerModel UNO object that represents the datasheet." msgstr "" -#. CCUpB -#: sf_dialog.xhp +#. wfJfa +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id1992584541368789\n" +"sf_datasheet.xhp\n" +"hd_id501582887473754\n" "help.text" -msgid "SourceName: The name of the control to duplicate." +msgid "Methods" msgstr "" -#. Bv4DW -#: sf_dialog.xhp +#. wgVfx +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id1001584541368789\n" +"sf_datasheet.xhp\n" +"par_id451619034669263\n" "help.text" -msgid "ControlName: A valid control name as a case-sensitive string. It must not exist yet." +msgid "List of Methods in the Datasheet Service" msgstr "" -#. PFJHH -#: sf_dialog.xhp +#. euurc +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id31688475132631\n" +"sf_datasheet.xhp\n" +"par_id801916099743199\n" "help.text" -msgid "Left, Top: The coordinates of the new control expressed in Map AppFont units." +msgid "Brings to front the data view window referred to by the Datasheet instance." msgstr "" -#. 4qLn9 -#: sf_dialog.xhp +#. ZQdnE +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id161584541257982\n" +"sf_datasheet.xhp\n" +"par_id801916099748128\n" "help.text" -msgid "Return either:" +msgid "Closes the data view window referred to by the Datasheet instance." msgstr "" -#. isSnB -#: sf_dialog.xhp +#. fStHW +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id421598179770993\n" +"sf_datasheet.xhp\n" +"par_id801916099748639\n" "help.text" -msgid "the list of the controls contained in the dialog" +msgid "Creates a new menu entry in the data view window and returns a SFWidgets.Menu service instance, with which menu items can be programmatically added." msgstr "" -#. hdSWz -#: sf_dialog.xhp +#. H4ghA +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id81598185229301\n" +"sf_datasheet.xhp\n" +"par_id71671047526843\n" "help.text" -msgid "a DialogControl class instance based on its name" +msgid "Menus added using the CreateMenu method are lost as soon as the data view window is closed." msgstr "" -#. AEAHd -#: sf_dialog.xhp +#. QC9Uh +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id1001584541257789\n" +"sf_datasheet.xhp\n" +"par_id941619079997155\n" "help.text" -msgid "ControlName : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array." +msgid "menuheader: The name of the new menu." msgstr "" -#. YWeDt -#: sf_dialog.xhp +#. yVxAC +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id381591885776500\n" +"sf_datasheet.xhp\n" +"par_id941619079997180\n" "help.text" -msgid "Create a new control of type Button in the current dialog." +msgid "before: This argument can be either the name of an existing menu entry before which the new menu will be placed or a number expressing the position of the new menu. If this argument is left blank the new menu is placed as the last entry." msgstr "" -#. UUuAw -#: sf_dialog.xhp +#. MXC5w +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"parm_ControlName\n" +"sf_datasheet.xhp\n" +"par_id941619079997090\n" "help.text" -msgid "ControlName: the name of the new control. It must not exist yet." +msgid "submenuchar: The delimiter used in menu trees (Default = \">\")" msgstr "" -#. GDYGN -#: sf_dialog.xhp +#. EMDiB +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"parm_Place\n" +"sf_datasheet.xhp\n" +"bas_id461619100382442\n" "help.text" -msgid "Place: either …" +msgid "Set oMenu = oSheet.CreateMenu(\"My Menu\", Before := \"Data\")" msgstr "" -#. KNVZv -#: sf_dialog.xhp +#. zLvjn +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id421598177970993\n" +"sf_datasheet.xhp\n" +"bas_id591671048413063\n" "help.text" -msgid "a Basic Array or Python tuple with 4 elements: (X, Y, width, height)" +msgid ".AddItem(\"Item 1\", Command := \".uno:About\")" msgstr "" -#. HCiRn -#: sf_dialog.xhp +#. DKtUn +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id881591858229301\n" +"sf_datasheet.xhp\n" +"pyc_id361623165059667\n" "help.text" -msgid "a com.sun.star.awt.Rectangle [X, Y, Width, Height] object" +msgid "menu = sheet.CreateMenu(\"My Menu\", before=\"Data\")" msgstr "" -#. 3Mdpm -#: sf_dialog.xhp +#. WAFYz +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id241688051343685\n" +"sf_datasheet.xhp\n" +"pyc_id571671048780765\n" "help.text" -msgid "All elements are expressed in Map AppFont units." +msgid "menu.AddItem(\"Item 1\", command=\".uno:About\")" msgstr "" -#. f4DZt -#: sf_dialog.xhp +#. K62eP +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id971688053679708\n" +"sf_datasheet.xhp\n" +"par_id521671048538692\n" "help.text" -msgid "Toggle: when True a Toggle button is created. Default = False" +msgid "Read the Menu service help page to learn more about how to create menu and submenu entries and associate commands." msgstr "" -#. sR8Fy -#: sf_dialog.xhp +#. nXH8z +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id961688054652555\n" +"sf_datasheet.xhp\n" +"par_id801916099748009\n" "help.text" -msgid "Push: \"OK\", \"CANCEL\" or \"\" (default)" +msgid "Returns the text in a given column of the current row." msgstr "" -#. kjvhr -#: sf_dialog.xhp +#. DJ8Ft +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id961688054748539\n" +"sf_datasheet.xhp\n" +"par_id161671050245887\n" "help.text" -msgid "An instance of SFDialogs.DialogControl service or Nothing." +msgid "This method does not change the position of the cursor in the data view window." msgstr "" -#. ztBSW -#: sf_dialog.xhp +#. 3qnwN +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id991591995776500\n" +"sf_datasheet.xhp\n" +"par_id941619079997693\n" "help.text" -msgid "Create a new control of type CheckBox in the current dialog." +msgid "column: The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned." msgstr "" -#. NFpS6 -#: sf_dialog.xhp +#. ED6ma +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id241688132171052\n" +"sf_datasheet.xhp\n" +"par_id801916099747177\n" "help.text" -msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line." +msgid "Returns the value in a given column of the current row as a valid Basic type." msgstr "" -#. c7gRE -#: sf_dialog.xhp +#. fXDwA +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id991591885776500\n" +"sf_datasheet.xhp\n" +"par_id91671050315349\n" "help.text" -msgid "Create a new control of type ComboBox in the current dialog." +msgid "The types that can be returned are: String, Integer, Long, Single, Double, Date and Null." msgstr "" -#. EBEZu -#: sf_dialog.xhp +#. HADUe +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id241688132526109\n" +"sf_datasheet.xhp\n" +"par_id411671050476363\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "Binary types are returned as a Long value indicating the length of the binary field." msgstr "" -#. xAa2y -#: sf_dialog.xhp +#. nTQDh +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id641688132528598\n" +"sf_datasheet.xhp\n" +"par_id141671050559691\n" "help.text" -msgid "DropDown: When True (default), a drop down button is displayed" +msgid "An Empty value is returned if the required value could not be retrieved." msgstr "" -#. tYvPA -#: sf_dialog.xhp +#. BtN8B +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id901688132529427\n" +"sf_datasheet.xhp\n" +"par_id161671050245365\n" "help.text" -msgid "LineCount: Specifies the maximum line count displayed in the drop down (default = 5)" +msgid "This method does not change the position of the cursor in the data view window." msgstr "" -#. No6yL -#: sf_dialog.xhp +#. DwSZS +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"bas_id571688391233995\n" +"sf_datasheet.xhp\n" +"par_id941619079997253\n" "help.text" -msgid "Set myComboBox = oDlg.CreateComboBox(\"ComboBox1\", Array(20, 20, 60, 15), Dropdown := True)" +msgid "column: The name of the column as a String or the column position (starting at 1). If a position greater than the number of columns is given, the last column is returned." msgstr "" -#. vQ37B -#: sf_dialog.xhp +#. ij88V +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"pyc_id681688391240490\n" +"sf_datasheet.xhp\n" +"par_id801916099747188\n" "help.text" -msgid "myComboBox = dlg.CreateComboBox('ComboBox1', (20, 20, 60, 15), Dropdown = True)" +msgid "Moves the cursor to the specified row and column." msgstr "" -#. CzvWq -#: sf_dialog.xhp +#. 4CXzN +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id991591005776500\n" +"sf_datasheet.xhp\n" +"par_id161671050245147\n" "help.text" -msgid "Create a new control of type CurrencyField in the current dialog." +msgid "This method does not change the position of the cursor in the data view window." msgstr "" -#. CzJFF -#: sf_dialog.xhp +#. CECkE +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id511688132750220\n" +"sf_datasheet.xhp\n" +"par_id231671105664098\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "row: The row number as a numeric value starting at 1. If the requested row exceeds the number of existing rows, the cursor is moved to the last row. If this argument is not specified, then the row is not changed." msgstr "" -#. 9Y7sF -#: sf_dialog.xhp +#. 4AYCp +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id751688132750844\n" +"sf_datasheet.xhp\n" +"par_id941619079997124\n" "help.text" -msgid "SpinButton: when True (default = False), a spin button is present" +msgid "column: The name of the column as a String or the column position (starting at 1). If the requested column exceeds the number of existing columns, the cursor is moved to the last column. If this argument is not specified, then the column is not changed." msgstr "" -#. kCCaS -#: sf_dialog.xhp +#. t7xYa +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id741688132751443\n" +"sf_datasheet.xhp\n" +"bas_id741671106250967\n" "help.text" -msgid "MinValue: the smallest value that can be entered in the control. Default = -1000000" +msgid "' Moves the cursor to the column \"LastName\" in row 4" msgstr "" -#. MAm9M -#: sf_dialog.xhp +#. BRB4u +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id361688132752004\n" +"sf_datasheet.xhp\n" +"bas_id51671106293155\n" "help.text" -msgid "MaxValue: the largest value that can be entered in the control. Default = +1000000" +msgid "oSheet.GoToCell(4, \"LastName\")" msgstr "" -#. UHBgk -#: sf_dialog.xhp +#. xvnqb +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id371688132752523\n" +"sf_datasheet.xhp\n" +"bas_id616711059619900\n" "help.text" -msgid "Increment: the step when the spin button is pressed. Default = 1" +msgid "' Moves the cursor to the third column of the current row" msgstr "" -#. mWecS -#: sf_dialog.xhp +#. sSJ4S +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id321688132753003\n" +"sf_datasheet.xhp\n" +"bas_id611671106014685\n" "help.text" -msgid "Accuracy: specifies the decimal accuracy. Default = 2 decimal digits" +msgid "' Moves cursor one row down leaving it in the same column" msgstr "" -#. WEbJY -#: sf_dialog.xhp +#. hLAZS +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id199598185776500\n" +"sf_datasheet.xhp\n" +"bas_id711671107842042\n" "help.text" -msgid "Create a new control of type DateField in the current dialog." +msgid "' Moves to the last column of the last row" msgstr "" -#. WJDCR -#: sf_dialog.xhp +#. 4mHFQ +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id831688133418579\n" +"sf_datasheet.xhp\n" +"pyc_id361623165059099\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "sheet.GoToCell(4, \"LastName\")" msgstr "" -#. LiKFk -#: sf_dialog.xhp +#. zU2uu +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id521688133422980\n" +"sf_datasheet.xhp\n" +"par_id801916099747090\n" "help.text" -msgid "DropDown: when True (default = False), a dropdown button is shown" +msgid "Removes a menu entry from the data view by its name." msgstr "" -#. cpD54 -#: sf_dialog.xhp +#. FhSiD +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id361688133423860\n" +"sf_datasheet.xhp\n" +"par_id511671106735805\n" "help.text" -msgid "MinDate: the smallest date that can be entered in the control. Default = 1900-01-01" +msgid "This method can remove menus that belong to the standard user interface as well as menus that were programmatically added with the CreateMenu method. The removal of standard menus is not permanent and they will reappear after the window is closed and reopened." msgstr "" -#. wEzbr -#: sf_dialog.xhp +#. ED3Co +#: sf_datasheet.xhp msgctxt "" -"sf_dialog.xhp\n" -"par_id221688133424380\n" +"sf_datasheet.xhp\n" +"par_id941619079997083\n" "help.text" -msgid "MaxDate: the largest date that can be entered in the control. Default = 2200-12-31" +msgid "menuheader: The case-sensitive name of the menu to be removed. The name must not include the tilde (\"~\") character." msgstr "" -#. xP5vF +#. BC4Sc #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199591885776511\n" +"tit\n" "help.text" -msgid "Create a new control of type FileControl in the current dialog." +msgid "SFDialogs.Dialog service" msgstr "" -#. Z8TBR +#. ZQBAD #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id1001688133702877\n" +"bm_id781582391760253\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "SFDialogs.Dialog service" msgstr "" -#. GB9hB +#. tvCua #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199195885776500\n" +"par_id931583589764919\n" "help.text" -msgid "Create a new control of type FixedLine in the current dialog." +msgid "The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor or dialogs created on-the-fly. Each instance of the current class represents a single dialog box displayed to the user." msgstr "" -#. FstFf +#. vxEvV #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id351688134656035\n" +"par_id831598110550771\n" "help.text" -msgid "Orientation: \"H[orizontal]\" or \"V[ertical]\"." +msgid "A dialog box can be displayed in modal or in non-modal modes." msgstr "" -#. fQ7cw +#. LVjBj #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199721885776533\n" +"par_id221598110444025\n" "help.text" -msgid "Create a new control of type FixedText in the current dialog." +msgid "In modal mode, the box is displayed and the execution of the macro process is suspended until one of the OK or Cancel buttons is pressed. In the meantime, user actions executed on the box can trigger specific actions." msgstr "" -#. qWysV +#. FFTSj #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id781688134809419\n" +"par_id981598110463521\n" "help.text" -msgid "Border: \"NONE\" (default) or \"FLAT\" or \"3D\"" +msgid "In non-modal mode, the dialog box is \"floating\" on the user desktop and the execution of the macro process continues normally. A non-modal dialog closes when it is terminated with the Terminate() method or when the %PRODUCTNAME session ends. The window close button is inactive in non-modal dialogs." msgstr "" -#. dG4NW +#. GrpyR #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id311688134819532\n" +"par_id721598110472337\n" "help.text" -msgid "Multiline: When True (default = False), the caption may be displayed on more than one line" +msgid "A dialog box disappears from memory after its explicit termination." msgstr "" -#. 24XQ9 +#. asacX #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id121688134820022\n" +"par_id891598188164936\n" "help.text" -msgid "Align: horizontal alignment, \"LEFT\" (default) or \"CENTER\" or \"RIGHT\"" +msgid "The SFDialogs.Dialog service is closely related to the SFDialogs.DialogControl service." msgstr "" -#. AabE3 +#. CByHp #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id316881340820555\n" +"hd_id581582885621841\n" "help.text" -msgid "VerticalAlign: vertical alignment, \"TOP\" (default) or \"MIDDLE\" or \"BOTTOM\"" +msgid "Service invocation and usage" msgstr "" -#. BFyLA +#. FfZWj #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199591885776500\n" +"par_id141609955500101\n" "help.text" -msgid "Create a new control of type FormattedField in the current dialog." +msgid "Before using the Dialog service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. Egi57 +#. EzMcF #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id561688135183954\n" +"par_id361598174756160\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "The Dialog service is invoked through the CreateScriptService method. It requires three supplemental positional arguments to specify the dialog box to activate:" msgstr "" -#. yEPP4 +#. KyBGV #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id691688135184764\n" +"par_id31612271944733\n" "help.text" -msgid "SpinButton: when True (default = False), a spin button is present" +msgid "Container: \"GlobalScope\" for preinstalled libraries or a window name as defined by ScriptForge.UI service. Empty string \"\" default value stands for the current document." msgstr "" -#. gGMo2 +#. juLgm #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id941688135185218\n" +"par_id311612271947124\n" "help.text" -msgid "MinValue: the smallest value that can be entered in the control. Default = -1000000" +msgid "Library: The case-sensitive name of a library contained in the container. Default value is \"Standard\"." msgstr "" -#. LurdS +#. FSp5N #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id881688135185626\n" +"par_id821612271946316\n" "help.text" -msgid "MaxValue: the largest value that can be entered in the control. Default = +1000000" +msgid "DialogName: A case-sensitive string designating the dialog." msgstr "" -#. fnPFv +#. L5fJw #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id100691885776500\n" +"par_id761620142701399\n" "help.text" -msgid "Create a new control of type GroupBox in the current dialog." +msgid "The examples below in Basic and Python display the dlgConsole dialog that belongs to the ScriptForge shared library:" msgstr "" -#. mSbuC +#. mqjFF #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id101701885776500\n" +"bas_id321598171269873\n" "help.text" -msgid "Create a new control of type Hyperlink in the current dialog." +msgid "'... controls initialization goes here..." msgstr "" -#. ZLjCH +#. yn6sy #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id731688542076471\n" +"bas_id471598176518738\n" "help.text" -msgid "Border: \"NONE\" (default) or \"FLAT\" or \"3D\"" +msgid "'Default mode = Modal" msgstr "" -#. kibrW +#. h9a9G #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id241688542076988\n" +"bas_id551598171288547\n" "help.text" -msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line" +msgid "'... Process controls and do what is needed here" msgstr "" -#. oBCY5 +#. VD35X #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id831688542077407\n" +"par_id601619622310089\n" "help.text" -msgid "Align: horizontal alignment, \"LEFT\" (default) or \"CENTER\" or \"RIGHT\"" +msgid "Or using Python:" msgstr "" -#. E45Rv +#. knENA #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id941688542077873\n" +"pyc_id41619622700314\n" "help.text" -msgid "VerticalAlign: vertical alignment, \"TOP\" (default) or \"MIDDLE\" or \"BOTTOM\"" +msgid "# ... controls initialization goes here..." msgstr "" -#. RSnLh +#. 2PTBU #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199591885776504\n" +"pyc_id661611699964814\n" "help.text" -msgid "Create a new control of type ImageControl in the current dialog." +msgid "# Default mode is Modal" msgstr "" -#. oYoCP +#. ABoA2 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id551688135418418\n" +"pyc_id681619619965191\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "# ... Process controls and do what is needed here" msgstr "" -#. mFJZ4 +#. BkTv6 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id431688135405342\n" +"par_id811670854106781\n" "help.text" -msgid "Scale: One of next values: \"FITTOSIZE\" (default), \"KEEPRATIO\" or \"NO\"" +msgid "Use the string \"GlobalScope\" as the container argument when the dialog is stored either in My Macros & Dialogs or in Application Macros & Dialogs." msgstr "" -#. qBHYH +#. vwuNC #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199591885776506\n" +"par_id461688463074274\n" "help.text" -msgid "Create a new control of type ListBox in the current dialog." +msgid "The dialog service offers methods that create new controls dynamically in an existing dialog predefined with the Dialog Editor. A dialog is initialized with controls in the Dialog Editor and new controls can be added at run-time before or after the dialog Execute() statement." msgstr "" -#. EJiPj +#. 5PbBk #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id1001688135548955\n" +"par_id261688459210848\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "The Dialog service can equally be invoked - through the CreateScriptService method - when creating dialogs on-the-fly. It requires two supplemental positional arguments after the name of the ad-hoc service \"NewDialog\":" msgstr "" -#. FQ6Eh +#. B82Et #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id11688135550412\n" +"par_id751688460276630\n" "help.text" -msgid "DropDown: When True (default), a drop down button is displayed" +msgid "DialogName: A case-sensitive string designating the dialog." msgstr "" -#. GJVah +#. VEJtV #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id121688135552418\n" +"par_id751688460276640\n" "help.text" -msgid "LineCount: Specifies the maximum line count displayed in the drop down (default = 5)" +msgid "Place: Window location of the dialog being either :" msgstr "" -#. C3VzG +#. wXa8D #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id661688135552802\n" +"par_id421598178080993\n" "help.text" -msgid "MultiSelect: When True, more than 1 entry may be selected. Default = False" +msgid "a Basic Array or Python tuple with 4 elements: (X, Y, width, height)" msgstr "" -#. 2td5s +#. PnCAR #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id199591885776510\n" +"par_id881502858229301\n" "help.text" -msgid "Create a new control of type NumericField in the current dialog." +msgid "a com.sun.star.awt.Rectangle [X, Y, Width, Height] object" msgstr "" -#. zzVVQ +#. HkCDF #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id841688135885946\n" +"par_id241688051453685\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "All elements are expressed in Map AppFont units." msgstr "" -#. TMyYy +#. sKdLk #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id781688135886499\n" +"par_id601619633410089\n" "help.text" -msgid "SpinButton: when True (default = False), a spin button is present" +msgid "Or using Python:" msgstr "" -#. XbJfV +#. 7D42J #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id481688135887010\n" +"pyc_id981688462077340\n" "help.text" -msgid "MinValue: the smallest value that can be entered in the control. Default = -1000000" +msgid "dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40, 110))" msgstr "" -#. UxiQT +#. wF8Se #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id371688135887594\n" +"pyc_id681619620065191\n" "help.text" -msgid "MaxValue: the largest value that can be entered in the control. Default = +1000000" +msgid "# ... Process controls and do what is needed" msgstr "" -#. geRML +#. h9PeA #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id191688135888122\n" +"par_id951688460698125\n" "help.text" -msgid "Increment: the step when the spin button is pressed. Default = 1" +msgid "All properties and methods applicable to predefined dialogs are available for such new dialogs. In particular the series of CreateXXX() methods for the addition of new dialog controls." msgstr "" -#. GEbxq +#. 8iyqo #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id451688135888638\n" +"hd_id141670854511382\n" "help.text" -msgid "Accuracy: specifies the decimal accuracy. Default = 2 decimal digits" +msgid "Retrieving the Dialog instance that triggered a dialog event" msgstr "" -#. XDRog +#. BVcDA #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200591996776500\n" +"par_id951598174966322\n" "help.text" -msgid "Create a new control of type PatternField in the current dialog." +msgid "An instance of the Dialog service can be retrieved via the SFDialogs.DialogEvent service, provided that the dialog was initiated with the Dialog service. In the example below, oDlg contains the Dialog instance that triggered the dialog event." msgstr "" -#. hHGWt +#. 4FBts #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id251688136173107\n" +"par_id741619625211462\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "Or using Python:" msgstr "" -#. rtHid +#. 5zauR #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id631688136173778\n" +"par_id251598176312571\n" "help.text" -msgid "EditMask: a character code that determines what the user may enter
Refer to Pattern_Field in the wiki for more information." +msgid "Note that in the previous examples, the prefix \"SFDialogs.\" may be omitted when deemed appropriate." msgstr "" -#. EAbCo +#. KCDyk #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id321688136174244\n" +"hd_id681670854491710\n" "help.text" -msgid "LiteralMask: contains the initial values that are displayed in the pattern field" +msgid "Handling exceptions in event handlers" msgstr "" -#. amC4c +#. 9kZzz #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id311591885776500\n" +"par_id971670855125683\n" "help.text" -msgid "Create a new control of type ProgressBar in the current dialog." +msgid "When creating an event handler for dialog events it is good practice to handle errors inside the subroutine itself. For instance, suppose the event handler below is called when the mouse button is pressed in the dialog window." msgstr "" -#. 4BBzC +#. AVgYD #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id551688136587329\n" +"bas_id261670857160312\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "' Process the event" msgstr "" -#. JvdPM +#. fLvwj #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id411688136587778\n" +"par_id691670857377446\n" "help.text" -msgid "MinValue: the smallest value that can be entered in the control. Default = 0" +msgid "Call SF_Exception.Clear if you do not want the error to propagate after the dialog execution ended." msgstr "" -#. W3vPH +#. fJoDn #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id261688136588146\n" +"par_id741619625211445\n" "help.text" -msgid "MaxValue: the largest value that can be entered in the control. Default = 100" +msgid "In Python use native try/except blocks for exception handling as shown below:" msgstr "" -#. orPfn +#. vDjYf #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200502985776500\n" +"pyc_id491670866556493\n" "help.text" -msgid "Create a new control of type RadioButton in the current dialog." +msgid "# Process the event" msgstr "" -#. NFUPV +#. LNECW #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id211688136829297\n" +"pyc_id416708660557072\n" "help.text" -msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line" +msgid "# The object \"bas\" is an instance of the Basic service" msgstr "" -#. uXqbU +#. nXGkZ #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"bas_id61688393673927\n" +"hd_id651583668365757\n" "help.text" -msgid "Set myRadioButton = oDlg.CreateRadioButton(\"RadioButton1\", Array(20, 20, 60, 15), MultiLine := True)" +msgid "Properties" msgstr "" -#. 9zbeK +#. zVLEC #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"pyc_id751688393681262\n" +"par_id871583668386455\n" "help.text" -msgid "myRadioButton = dlg.CreateRadioButton('RadioButton1', (20, 20, 60, 15), MultiLine = True)" +msgid "Name" msgstr "" -#. FXgot +#. FBCFG #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200591886886500\n" +"par_id491583668386455\n" "help.text" -msgid "Create a new control of type ScrollBar in the current dialog." +msgid "ReadOnly" msgstr "" -#. eqt7D +#. ByVDE #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id731688136882518\n" +"par_id271583668474014\n" "help.text" -msgid "Orientation: H[orizontal] or V[ertical]" +msgid "Type" msgstr "" -#. ukFA2 +#. 8AUBJ #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id341688136882960\n" +"par_id401583668386455\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "Description" msgstr "" -#. 5azTe +#. iZZec #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id621688136883363\n" +"par_id371583668519172\n" "help.text" -msgid "MinValue: the smallest value that can be entered in the control. Default = 0" +msgid "Yes" msgstr "" -#. rCC4o +#. av994 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id241688136883785\n" +"par_id771583668386455\n" "help.text" -msgid "MaxValue: the largest value that can be entered in the control. Default = 100" +msgid "Value = 1. An OK button was pressed." msgstr "" -#. PfwHb +#. GKcTG #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200502985776722\n" +"par_id541583839708548\n" "help.text" -msgid "Create a new control of type TableControl in the current dialog." +msgid "Yes" msgstr "" -#. iFFvS +#. z4BZ4 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id541688393982300\n" +"par_id731583839708412\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "Value = 0. A Cancel button was pressed." msgstr "" -#. gjYXC +#. cThsX #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id351688393983486\n" +"par_id761584027709516\n" "help.text" -msgid "RowHeaders: when True (default), the row Headers are shown" +msgid "No" msgstr "" -#. mB59k +#. 48bDT #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id941688393983846\n" +"par_id971584027709752\n" "help.text" -msgid "ColumnHeaders: when True (default), the column Headers are shown" +msgid "Specify the title of the dialog." msgstr "" -#. 7CcWA +#. 2pjyZ #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id141688393984239\n" +"par_id31583839767743\n" "help.text" -msgid "ScrollBars: H[orizontal] or V[ertical] or B[oth] or N[one] (default). Scrollbars appear dynamically when they are needed." +msgid "No" msgstr "" -#. SjB3M +#. 3Rypn #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id741688393984702\n" +"par_id111583839767195\n" "help.text" -msgid "GridLines: when True (default = False) horizontal and vertical lines are painted between the grid cells" +msgid "Specify the height of the dialog box." msgstr "" -#. Afff6 +#. KD2zy #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200591895776500\n" +"par_id771583839920487\n" "help.text" -msgid "Create a new control of type TextField in the current dialog." +msgid "Yes" msgstr "" -#. VeTxt +#. ABrxD #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id281688394635114\n" +"par_id451583839920858\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "Specifies if the dialog box is currently in execution in modal mode." msgstr "" -#. g2ZgE +#. sA5Nj #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id341688394635645\n" +"par_id571588333908716\n" "help.text" -msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line" +msgid "Yes" msgstr "" -#. BVC62 +#. JoAYu #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id671688394636092\n" +"par_id721588333908708\n" "help.text" -msgid "MaximumLength: the maximum character count (default = 0 meaning unlimited)" +msgid "The name of the dialog" msgstr "" -#. WqBWr +#. jcbwB #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id231688394641827\n" +"par_id501583774433513\n" "help.text" -msgid "PasswordCharacter: a single character specifying the echo for a password text field (default = \"\")" +msgid "No" msgstr "" -#. eFECE +#. Tfrah #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200591895776611\n" +"par_id151598177605296\n" "help.text" -msgid "Create a new control of type TimeField in the current dialog." +msgid "A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active." msgstr "" -#. ADdEz +#. FZG3n #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id771688394821811\n" +"par_id271588334016191\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "No" msgstr "" -#. rEYM9 +#. 3sRE5 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id711688394822256\n" +"par_id251588334016874\n" "help.text" -msgid "MinTime: the smallest time that can be entered in the control. Default = 0" +msgid "Specify if the dialog box is visible on the desktop. By default it is not visible until the Execute() method is run and visible afterwards." msgstr "" -#. 9m7F9 +#. w6DwG #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id491688394822582\n" +"par_id451598177924437\n" "help.text" -msgid "MaxTime: the largest time that can be entered in the control. Default = 24h" +msgid "Yes" msgstr "" -#. CcyYS +#. 2DaKv #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id200692885776500\n" +"par_id191598177924897\n" "help.text" -msgid "Create a new control of type TreeControl in the current dialog." +msgid "The UNO object representing the dialog model. Refer to XControlModel and UnoControlDialogModel in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. KBrUN +#. YFYi4 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id241688394984562\n" +"par_id811598178083501\n" "help.text" -msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" +msgid "Yes" msgstr "" -#. cFso7 +#. yexon #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"bas_id941688395020850\n" +"par_id731598178083442\n" "help.text" -msgid "Set myTreeControl = oDlg.CreateTreeControl(\"TreeControl1\", Array(20, 20, 60, 15))" +msgid "The UNO object representing the dialog view. Refer to XControl and UnoControlDialog in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. GDWGT +#. S4DWL #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"pyc_id721688395030169\n" +"par_id31385839767743\n" "help.text" -msgid "myTreeControl = dlg.CreateTreeControl('TreeControl1', (20, 20, 60, 15))" +msgid "No" msgstr "" -#. j8x9C +#. G6Qsw #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id381598185776500\n" +"par_id111583839717695\n" "help.text" -msgid "Ends the display of a modal dialog and gives back the argument as return value for the current Execute() running action." +msgid "Specify the width of the dialog box." msgstr "" -#. gjvwy +#. q8eyc #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id551598185953362\n" +"hd_id421612628828054\n" "help.text" -msgid "EndExecute() is usually contained in the processing of a macro triggered by a dialog or control event." +msgid "Event properties" msgstr "" -#. yukGC +#. EQdEV #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id451598185776957\n" +"par_id41612629140856\n" "help.text" -msgid "returnvalue: The value passed to the running Execute() method." +msgid "On… properties return a URI string with the reference to the script triggered by the event. On… properties can be set programmatically.
Read its specification in the scripting framework URI specification." msgstr "" -#. aizuC +#. XCC7C #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id81620201915101\n" +"par_id961612628879819\n" "help.text" -msgid "Above com.sun.star.lang.EventObject mentions are optional. Such annotations help identify %PRODUCTNAME Application Programming Interface (API)." +msgid "Name" msgstr "" -#. FD9fr +#. eFrre #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id29159818646178\n" +"par_id401612628879819\n" "help.text" -msgid "Display the dialog box and, when modal, wait for its termination by the user. The returned value is either:" +msgid "Read/Write" msgstr "" -#. PRCaG +#. uW85z #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id541598186676277\n" +"par_id281612628879819\n" "help.text" -msgid "0 : Cancel button pressed" +msgid "Basic IDE Description" msgstr "" -#. eCGBY +#. dFkbN #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id821598186716345\n" +"par_id111612629836630\n" "help.text" -msgid "1 : OK button pressed" +msgid "Yes" msgstr "" -#. MovhC +#. aKBvg #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id951598186738346\n" +"par_id1001612629836902\n" "help.text" -msgid "Otherwise the dialog stopped with an EndExecute() statement issued by a dialog or control event" +msgid "When receiving focus" msgstr "" -#. eBFXT +#. 4FBaJ #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id741598187335869\n" +"par_id291612629836294\n" "help.text" -msgid "For non-modal dialog boxes the method always returns 0 and the execution of the macro continues." +msgid "Yes" msgstr "" -#. Ej2iF +#. 8U7FZ #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id11598186461227\n" +"par_id62161262983683\n" "help.text" -msgid "modal: False when non-modal dialog. Default = True." +msgid "When losing focus" msgstr "" -#. fGatm +#. wBCKi #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id231620110023843\n" +"par_id81612629836634\n" "help.text" -msgid "In this Basic example myDialog dialog is stored in current document's Standard library." +msgid "Yes" msgstr "" -#. ouEVN +#. CK5vU #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id191620110162627\n" +"par_id881612629836744\n" "help.text" -msgid "This Python code displays DlgConvert modal dialog from Euro shared Basic library." +msgid "Key pressed" msgstr "" -#. HU6Jv +#. gXJGu #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id21598187900349\n" +"par_id591612629836830\n" "help.text" -msgid "Replaces all fixed text strings in a dialog by their translated versions based on a L10N service instance. This method translates the following strings:" +msgid "Yes" msgstr "" -#. JixXU +#. CJwi7 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id641625855723650\n" +"par_id161612629836775\n" "help.text" -msgid "The method returns True if successful." +msgid "Key released" msgstr "" -#. 3wcE6 +#. wS7GH #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id61637871260604\n" +"par_id891612629836630\n" "help.text" -msgid "To create a list of translatable strings in a dialog use the AddTextsFromDialog method from the L10N service." +msgid "Yes" msgstr "" -#. ECNVg +#. GcDU7 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id451598185776205\n" +"par_id461612629836679\n" "help.text" -msgid "l10n: A L10N service instance from which translated strings will be retrieved." +msgid "Mouse moved while key presses" msgstr "" -#. MeJAT +#. eUS49 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id951620300689850\n" +"par_id131612629836291\n" "help.text" -msgid "The following example loads translated strings and applies them to the dialog \"MyDialog\"." +msgid "Yes" msgstr "" -#. 3dcGG +#. QrByH #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id901637872163895\n" +"par_id151612629836151\n" "help.text" -msgid "Read the L10N service help page to learn more about how PO and POT files are handled." +msgid "Mouse inside" msgstr "" -#. yGR7U +#. CRGTF #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id21598298953697\n" +"par_id211612629836725\n" "help.text" -msgid "Set the tabulation index of a series of controls. The sequence of controls are given as an array of control names from the first to the last." +msgid "Yes" msgstr "" -#. GfyZ2 +#. 69s4B #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id921688543457317\n" +"par_id361612629836624\n" "help.text" -msgid "Controls with an index >= 1 are not accessible with the TAB key if:
- they are omitted from the given list
- their type is FixedLine, GroupBox or ProgressBar
- they are disabled" +msgid "Mouse outside" msgstr "" -#. sx3QG +#. ojLRr #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id111688543698861\n" +"par_id311612629836481\n" "help.text" -msgid "TabsList: an array of valid control names in the order of tabulation" +msgid "Yes" msgstr "" -#. dqQvh +#. XaS8A #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id381688543699284\n" +"par_id721612629836752\n" "help.text" -msgid "Start: the tab index to be assigned to the 1st control in the list. Default = 1" +msgid "Mouse moved" msgstr "" -#. CEhSS +#. MnMUF #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id321688543699637\n" +"par_id981612629836116\n" "help.text" -msgid "Increment: the difference between 2 successive tab indexes. Default = 1" +msgid "Yes" msgstr "" -#. DFWjc +#. NtqPz #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id401688543845094\n" +"par_id381612629836635\n" "help.text" -msgid "True when successful." +msgid "Mouse button pressed" msgstr "" -#. 3XGLC +#. czknv #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"bas_id791620301085031\n" +"par_id711612629836704\n" "help.text" -msgid "oDlg.OrderTabs(Array(\"myListBox\", \"myTextField\", \"myNumericField\"), Start := 10)" +msgid "Yes" msgstr "" -#. UGwcg +#. J2uzg #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"pyc_id941620303073866\n" +"par_id35161262983642\n" "help.text" -msgid "dlg.OrderTabs(('myListBox', 'myTextField', 'myNumericField'), Start = 10)" +msgid "Mouse button released" msgstr "" -#. 4FcCi +#. Z4Lnx #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id21598187953697\n" +"par_id401687779361420\n" "help.text" -msgid "Moves the topleft corner of a dialog to new coordinates and/or modify its dimensions. All distances are expressed in AppFont units. Without arguments, the method resets the initial dimensions. Return True if the resize was successful." +msgid "Assigning events via the Basic IDE and assigning events via macros are mutually exclusive." msgstr "" -#. XRdLE +#. 9uiAA #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id481651236673068\n" +"par_id891611613601554\n" "help.text" -msgid "Left: the horizontal distance from the top-left corner" +msgid "List of Methods in the Dialog Service" msgstr "" -#. FcTcU +#. GbtVM #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id721651236674379\n" +"par_id161660427825856\n" "help.text" -msgid "Top: the vertical distance from the top-left corner" +msgid "Dimensioning a dialog is done by using Map AppFont units. A dialog or control model also uses AppFont units. While their views use pixels." msgstr "" -#. uX7ps +#. DiCyL #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id991651236674995\n" +"par_id871583933076448\n" "help.text" -msgid "Width: the width of the rectangle containing the dialog" +msgid "Set the focus on the current Dialog instance. Return True if focusing was successful." msgstr "" -#. ApqA8 +#. 7QdPA #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id771651236675564\n" +"par_id151598178880227\n" "help.text" -msgid "Height: the height of the rectangle containing the dialog" +msgid "This method is called from a dialog or control event, or when a dialog is displayed in non-modal mode." msgstr "" -#. nEvvd +#. uoBhE #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id211651236676180\n" +"par_id811620109056270\n" "help.text" -msgid "Missing arguments are left unchanged" +msgid "Python and %PRODUCTNAME Basic examples both assume that the dialog is stored in current document's Standard library." msgstr "" -#. aADKy +#. 7VrwE #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"bas_id791621411085031\n" +"par_id391651225506119\n" "help.text" -msgid "oDlg.Resize(1000, 2000, Height := 6000) ' Width is not changed" +msgid "Centers the current dialog instance in the middle of a parent window. Without arguments, the method centers the dialog in the middle of the current window." msgstr "" -#. DwqUe +#. xEJEH #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"pyc_id941620304183866\n" +"par_id391651552206119\n" "help.text" -msgid "dlg.Resize(1000, 2000, Height = 6000) # Width is not changed" +msgid "Returns True when successful." msgstr "" -#. 6DRxV +#. Woksx #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id21598187950047\n" +"par_id1001585441257789\n" "help.text" -msgid "Defines which controls in a dialog are responsible for switching pages, making it easier to manage the Page property of a dialog and its controls." +msgid "Parent: An optional object that can be either …" msgstr "" -#. DDxnE +#. DCeY9 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id291670871829824\n" +"par_id412598177970993\n" "help.text" -msgid "Dialogs may have multiple pages and the currently visible page is defined by the Page dialog property. If the Page property is left unchanged, the default visible page is equal to 0 (zero), meaning that no particular page is defined and all visible controls are displayed regardless of the value set in their own Page property." +msgid "a ScriptForge dialog object" msgstr "" -#. YB97d +#. D5yN3 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id431670872095503\n" +"par_id81591858229301\n" "help.text" -msgid "When the Page property of a dialog is changed to some other value such as 1, 2, 3 and so forth, then only the controls whose Page property match the current dialog page will be displayed." +msgid "a ScriptForge document (Calc, Base, ...) object" msgstr "" -#. 4oNFA +#. 8DDWf #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id161670872517032\n" +"bas_id12598185484092\n" "help.text" -msgid "By using the SetPageManager method it is possible to define four types of page managers:" +msgid "Set oDialog1 = CreateScriptService(\"DialogEvent\", oEvent) ' The dialog that caused the event" msgstr "" -#. Bdjcu +#. dx9rf #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id161670872665432\n" +"bas_id641598184589492\n" "help.text" -msgid "List box or combo box: in this case, each entry in the list box or combo box corresponds to a page. The first item refers to Page 1, the second items refers to Page 2 and so on." +msgid "Set oDialog2 = CreateScriptService(\"Dialog\", ...) ' Open a second dialog" msgstr "" -#. 2cbkh +#. kqFdv #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id141670872835955\n" +"pyc_id351619267575732\n" "help.text" -msgid "Group of radio buttons: defines a group of radio buttons that will control which page is visible." +msgid "dlg1 = CreateScriptService('DialogEvent.Dialog', event) # The dialog having caused the event" msgstr "" -#. 37XCi +#. fDQAG #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id11670872840588\n" +"pyc_id431619267576082\n" "help.text" -msgid "Sequence of buttons: defines a set of buttons, each of which corresponding to a dialog page. This can be used to emulate a tabbed interface by placing buttons side by side in the dialog." +msgid "dlg2 = CreateScriptService('Dialog', ...) # Open a second dialog" msgstr "" -#. qFQHA +#. T2ARe #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id461670873122132\n" +"par_id161584552357982\n" "help.text" -msgid "Previous/Next buttons: defines which buttons in the dialog that will be used to navigate to the Previous/Next page in the dialog." +msgid "Duplicate an existing control of any type in the actual dialog. The duplicated control is left unchanged and can be relocated." msgstr "" -#. dANup +#. CCUpB #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id871670874232499\n" +"par_id1992584541368789\n" "help.text" -msgid "It is possible to use more than one page management mechanism at the same time." +msgid "SourceName: The name of the control to duplicate." msgstr "" -#. JLw7E +#. Bv4DW #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id831670873941232\n" +"par_id1001584541368789\n" "help.text" -msgid "This method is supposed to be called just once before calling the Execute method. Subsequent calls are ignored." +msgid "ControlName: A valid control name as a case-sensitive string. It must not exist yet." msgstr "" -#. NAsqC +#. PFJHH #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id371670874142972\n" +"par_id31688475132631\n" "help.text" -msgid "If successful this method returns True." +msgid "Left, Top: The coordinates of the new control expressed in Map AppFont units." msgstr "" -#. iyTJv +#. 4qLn9 #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id481651236673466\n" +"par_id161584541257982\n" "help.text" -msgid "pilotcontrols: a comma-separated list of ListBox, ComboBox or RadioButton control names used as page managers. For RadioButton controls, specify the name of the first control in the group to be used." +msgid "Return either:" msgstr "" -#. vNxtV +#. isSnB #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id721651236670589\n" +"par_id421598179770993\n" "help.text" -msgid "tabcontrols: a comma-separated list of button names that will be used as page managers. The order in which they are specified in this argument corresponds to the page number they are associated with." +msgid "the list of the controls contained in the dialog" msgstr "" -#. VXVDL +#. hdSWz #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id991651236674963\n" +"par_id81598185229301\n" "help.text" -msgid "wizardcontrols: a comma-separated list with the names of two buttons that will be used as the Previous/Next buttons." +msgid "a DialogControl class instance based on its name" msgstr "" -#. AEFZz +#. AEAHd #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id771651236671764\n" +"par_id1001584541257789\n" "help.text" -msgid "lastpage: the number of the last available page. It is recommended to specify this value when using the Previous/Next page manager." +msgid "ControlName : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array." msgstr "" -#. sWmg6 +#. YWeDt #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id861670874176863\n" +"par_id381591885776500\n" "help.text" -msgid "Consider a dialog with three pages. The dialog has a ListBox control named \"aPageList\" that will be used to control the visible page. Additionally, there are two buttons named \"btnPrevious\" and \"btnNext\" that will be used as the Previous/Next buttons in the dialog." +msgid "Create a new control of type Button in the current dialog." msgstr "" -#. ARCGg +#. UUuAw #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id21598187953679\n" +"parm_ControlName\n" "help.text" -msgid "Terminate the Dialog service for the current instance. Return True if the termination was successful." +msgid "ControlName: the name of the new control. It must not exist yet." msgstr "" -#. CgAYf +#. GDYGN #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id951620300687150\n" +"parm_Place\n" "help.text" -msgid "Below Basic and Python examples open DlgConsole and dlgTrace non-modal dialogs. They are respectively stored in ScriptForge and Access2Base shared libraries. Dialog close buttons are disabled and explicit termination is performed at the end of a running process." +msgid "Place: either …" msgstr "" -#. W3W3Y +#. KNVZv #: sf_dialog.xhp msgctxt "" "sf_dialog.xhp\n" -"par_id301620302137482\n" +"par_id421598177970993\n" "help.text" -msgid "In this example a button in DlgConsole is substituting inhibited window closing:" +msgid "a Basic Array or Python tuple with 4 elements: (X, Y, width, height)" msgstr "" -#. BFfGX -#: sf_dialogcontrol.xhp +#. HCiRn +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"tit\n" +"sf_dialog.xhp\n" +"par_id881591858229301\n" "help.text" -msgid "SFDialogs.DialogControl service" +msgid "a com.sun.star.awt.Rectangle [X, Y, Width, Height] object" msgstr "" -#. 2KEBr -#: sf_dialogcontrol.xhp +#. 3Mdpm +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"bm_id781582391760253\n" +"sf_dialog.xhp\n" +"par_id241688051343685\n" "help.text" -msgid "SFDialogs.DialogControl service" +msgid "All elements are expressed in Map AppFont units." msgstr "" -#. RDcyi -#: sf_dialogcontrol.xhp +#. f4DZt +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id931583589764919\n" +"sf_dialog.xhp\n" +"par_id971688053679708\n" "help.text" -msgid "The DialogControl service manages the controls belonging to a dialog defined with the Basic Dialog Editor. Each instance of the current service represents a single control within a dialog box." +msgid "Toggle: when True a Toggle button is created. Default = False" msgstr "" -#. 7dDgL -#: sf_dialogcontrol.xhp +#. sR8Fy +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id701598191157426\n" +"sf_dialog.xhp\n" +"par_id961688054652555\n" "help.text" -msgid "The focus is set on getting and setting the values displayed by the controls of the dialog box. Formatting is accessible via the XControlModel and XControlView properties." +msgid "Push: \"OK\", \"CANCEL\" or \"\" (default)" msgstr "" -#. fFfwe -#: sf_dialogcontrol.xhp +#. kjvhr +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id981598191184526\n" +"sf_dialog.xhp\n" +"par_id961688054748539\n" "help.text" -msgid "Note that the unique DialogControl.Value property content varies according to the control type." +msgid "An instance of SFDialogs.DialogControl service or Nothing." msgstr "" -#. MBrzA -#: sf_dialogcontrol.xhp +#. ztBSW +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id991612698027551\n" +"sf_dialog.xhp\n" +"par_id991591995776500\n" "help.text" -msgid "A special attention is given to controls of type tree control. It is easy to populate a tree, either branch by branch, or with a set of branches at once. Populating a tree control can be performed statically or dynamically." +msgid "Create a new control of type CheckBox in the current dialog." msgstr "" -#. hag3A -#: sf_dialogcontrol.xhp +#. NFpS6 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id891598188164936\n" +"sf_dialog.xhp\n" +"par_id241688132171052\n" "help.text" -msgid "The SFDialogs.DialogControl service is closely related to the SFDialogs.Dialog service." +msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line." msgstr "" -#. uGTGK -#: sf_dialogcontrol.xhp +#. c7gRE +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_id581582885621841\n" +"sf_dialog.xhp\n" +"par_id991591885776500\n" "help.text" -msgid "Service invocation" +msgid "Create a new control of type ComboBox in the current dialog." msgstr "" -#. LGkgR -#: sf_dialogcontrol.xhp +#. EBEZu +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id141609955500101\n" +"sf_dialog.xhp\n" +"par_id241688132526109\n" "help.text" -msgid "Before using the DialogControl service the ScriptForge library needs to be loaded or imported:" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. EnxDs -#: sf_dialogcontrol.xhp +#. xAa2y +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id361598174756160\n" +"sf_dialog.xhp\n" +"par_id641688132528598\n" "help.text" -msgid "The DialogControl service is invoked from an existing Dialog service instance through its Controls() method. The dialog must be initiated with the SFDialogs.Dialog service." +msgid "DropDown: When True (default), a drop down button is displayed" msgstr "" -#. RCFrE -#: sf_dialogcontrol.xhp +#. tYvPA +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"bas_id581598453210170\n" +"sf_dialog.xhp\n" +"par_id901688132529427\n" "help.text" -msgid "myControl.Value = \"Dialog started at \" & Now()" +msgid "LineCount: Specifies the maximum line count displayed in the drop down (default = 5)" msgstr "" -#. WVG8J -#: sf_dialogcontrol.xhp +#. CzvWq +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"bas_id961598453222539\n" +"sf_dialog.xhp\n" +"par_id991591005776500\n" "help.text" -msgid "' ... process the controls actual values" +msgid "Create a new control of type CurrencyField in the current dialog." msgstr "" -#. gxhUu -#: sf_dialogcontrol.xhp +#. CzJFF +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"pyc_id861620225235002\n" +"sf_dialog.xhp\n" +"par_id511688132750220\n" "help.text" -msgid "text.Value = \"Dialog started at \" + strftime(\"%a, %d %b %Y %H:%M:%S\", localtime())" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. nu3f3 -#: sf_dialogcontrol.xhp +#. 9Y7sF +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"pyc_id841620225235377\n" +"sf_dialog.xhp\n" +"par_id751688132750844\n" "help.text" -msgid "# ... process the controls actual values" +msgid "SpinButton: when True (default = False), a spin button is present" msgstr "" -#. GZ3ia -#: sf_dialogcontrol.xhp +#. kCCaS +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_id141670854511382\n" +"sf_dialog.xhp\n" +"par_id741688132751443\n" "help.text" -msgid "Retrieving the DialogControl instance that triggered a control event" +msgid "MinValue: the smallest value that can be entered in the control. Default = -1000000" msgstr "" -#. CcXYE -#: sf_dialogcontrol.xhp +#. MAm9M +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id951598174966322\n" +"sf_dialog.xhp\n" +"par_id361688132752004\n" "help.text" -msgid "An instance of the DialogControl service can be retrieved via the SFDialogs.DialogEvent service, provided that the dialog was initiated with the Dialog service. In the example below, oControl contains the DialogControl instance that triggered the control event." +msgid "MaxValue: the largest value that can be entered in the control. Default = +1000000" msgstr "" -#. jeLRp -#: sf_dialogcontrol.xhp +#. UHBgk +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id741619625211462\n" +"sf_dialog.xhp\n" +"par_id371688132752523\n" "help.text" -msgid "Or using Python:" +msgid "Increment: the step when the spin button is pressed. Default = 1" msgstr "" -#. EroTy -#: sf_dialogcontrol.xhp +#. mWecS +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id251598176312571\n" +"sf_dialog.xhp\n" +"par_id321688132753003\n" "help.text" -msgid "Note that in the previous examples, the prefix \"SFDialogs.\" may be omitted when deemed appropriate." +msgid "Accuracy: specifies the decimal accuracy. Default = 2 decimal digits" msgstr "" -#. KazD8 -#: sf_dialogcontrol.xhp +#. WEbJY +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_id681670854491710\n" +"sf_dialog.xhp\n" +"par_id199598185776500\n" "help.text" -msgid "Handling exceptions in event handlers" +msgid "Create a new control of type DateField in the current dialog." msgstr "" -#. isdwE -#: sf_dialogcontrol.xhp +#. WJDCR +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id971670855125683\n" +"sf_dialog.xhp\n" +"par_id831688133418579\n" "help.text" -msgid "When creating an event handler for control events it is good practice to handle errors inside the subroutine itself. For instance, suppose the event handler below is called when button is clicked." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. HSAhd -#: sf_dialogcontrol.xhp +#. LiKFk +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"bas_id261670857160312\n" +"sf_dialog.xhp\n" +"par_id521688133422980\n" "help.text" -msgid "' Process the event" +msgid "DropDown: when True (default = False), a dropdown button is shown" msgstr "" -#. wUTZB -#: sf_dialogcontrol.xhp +#. cpD54 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id691670857377446\n" +"sf_dialog.xhp\n" +"par_id361688133423860\n" "help.text" -msgid "Call SF_Exception.Clear if you do not want the error to propagate after the dialog execution ended." +msgid "MinDate: the smallest date that can be entered in the control. Default = 1900-01-01" msgstr "" -#. GVfqQ -#: sf_dialogcontrol.xhp +#. wEzbr +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id741619625211445\n" +"sf_dialog.xhp\n" +"par_id221688133424380\n" "help.text" -msgid "In Python use native try/except blocks for exception handling as shown below:" +msgid "MaxDate: the largest date that can be entered in the control. Default = 2200-12-31" msgstr "" -#. UAGhF -#: sf_dialogcontrol.xhp +#. xP5vF +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"pyc_id491670866556493\n" +"sf_dialog.xhp\n" +"par_id199591885776511\n" "help.text" -msgid "# Process the event" +msgid "Create a new control of type FileControl in the current dialog." msgstr "" -#. KY75S -#: sf_dialogcontrol.xhp +#. Z8TBR +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"pyc_id416708660557072\n" +"sf_dialog.xhp\n" +"par_id1001688133702877\n" "help.text" -msgid "# The object \"bas\" below is an instance of the Basic service" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. F9uKj -#: sf_dialogcontrol.xhp +#. GB9hB +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_id71598455687512\n" +"sf_dialog.xhp\n" +"par_id199195885776500\n" "help.text" -msgid "Control types" +msgid "Create a new control of type FixedLine in the current dialog." msgstr "" -#. jKJBV -#: sf_dialogcontrol.xhp +#. FstFf +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id851598455863395\n" +"sf_dialog.xhp\n" +"par_id351688134656035\n" "help.text" -msgid "The DialogControl service is available for these control types:" +msgid "Orientation: \"H[orizontal]\" or \"V[ertical]\"." msgstr "" -#. gTfDQ -#: sf_dialogcontrol.xhp +#. fQ7cw +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id271687789435391\n" +"sf_dialog.xhp\n" +"par_id199721885776533\n" "help.text" -msgid "• TableControl
• TextField
• TimeField
• TreeControl

" +msgid "Create a new control of type FixedText in the current dialog." msgstr "" -#. 7xddb -#: sf_dialogcontrol.xhp +#. qWysV +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_id651583668365757\n" +"sf_dialog.xhp\n" +"par_id781688134809419\n" "help.text" -msgid "Properties" +msgid "Border: \"NONE\" (default) or \"FLAT\" or \"3D\"" msgstr "" -#. 94RMV -#: sf_dialogcontrol.xhp +#. dG4NW +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id871583668386455\n" +"sf_dialog.xhp\n" +"par_id311688134819532\n" "help.text" -msgid "Name" +msgid "Multiline: When True (default = False), the caption may be displayed on more than one line" msgstr "" -#. eccsg -#: sf_dialogcontrol.xhp +#. 24XQ9 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id491583668386455\n" +"sf_dialog.xhp\n" +"par_id121688134820022\n" "help.text" -msgid "ReadOnly" +msgid "Align: horizontal alignment, \"LEFT\" (default) or \"CENTER\" or \"RIGHT\"" msgstr "" -#. KRYNv -#: sf_dialogcontrol.xhp +#. AabE3 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id271583668474014\n" +"sf_dialog.xhp\n" +"par_id316881340820555\n" "help.text" -msgid "Type" +msgid "VerticalAlign: vertical alignment, \"TOP\" (default) or \"MIDDLE\" or \"BOTTOM\"" msgstr "" -#. U9ZYU -#: sf_dialogcontrol.xhp +#. BFyLA +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id291598538799794\n" +"sf_dialog.xhp\n" +"par_id199591885776500\n" "help.text" -msgid "Applicable to" +msgid "Create a new control of type FormattedField in the current dialog." msgstr "" -#. emDac -#: sf_dialogcontrol.xhp +#. Egi57 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id401583668386455\n" +"sf_dialog.xhp\n" +"par_id561688135183954\n" "help.text" -msgid "Description" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. cAKRH -#: sf_dialogcontrol.xhp +#. yEPP4 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id372693668519172\n" +"sf_dialog.xhp\n" +"par_id691688135184764\n" "help.text" -msgid "Yes" +msgid "SpinButton: when True (default = False), a spin button is present" msgstr "" -#. M4GR3 -#: sf_dialogcontrol.xhp +#. gGMo2 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id771583778386455\n" +"sf_dialog.xhp\n" +"par_id941688135185218\n" "help.text" -msgid "The Border property refers to the surrounding of the control: 3D, FLAT or NONE." +msgid "MinValue: the smallest value that can be entered in the control. Default = -1000000" msgstr "" -#. xNGhR -#: sf_dialogcontrol.xhp +#. LurdS +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id371583668519172\n" +"sf_dialog.xhp\n" +"par_id881688135185626\n" "help.text" -msgid "No" +msgid "MaxValue: the largest value that can be entered in the control. Default = +1000000" msgstr "" -#. aTyMC -#: sf_dialogcontrol.xhp +#. fnPFv +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id771583668386455\n" +"sf_dialog.xhp\n" +"par_id100691885776500\n" "help.text" -msgid "Specifies if a command button has or not the behaviour of a Cancel button." +msgid "Create a new control of type GroupBox in the current dialog." msgstr "" -#. Gft3Z -#: sf_dialogcontrol.xhp +#. mSbuC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id541583839708548\n" +"sf_dialog.xhp\n" +"par_id101701885776500\n" "help.text" -msgid "No" +msgid "Create a new control of type Hyperlink in the current dialog." msgstr "" -#. UXoyn -#: sf_dialogcontrol.xhp +#. ZLjCH +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id731583839708412\n" +"sf_dialog.xhp\n" +"par_id731688542076471\n" "help.text" -msgid "Specifies the text associated with the control." +msgid "Border: \"NONE\" (default) or \"FLAT\" or \"3D\"" msgstr "" -#. Uo2SP -#: sf_dialogcontrol.xhp +#. kibrW +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id761584027709516\n" +"sf_dialog.xhp\n" +"par_id241688542076988\n" "help.text" -msgid "Yes" +msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line" msgstr "" -#. YKEAg -#: sf_dialogcontrol.xhp +#. oBCY5 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id261598539120502\n" +"sf_dialog.xhp\n" +"par_id831688542077407\n" "help.text" -msgid "All" +msgid "Align: horizontal alignment, \"LEFT\" (default) or \"CENTER\" or \"RIGHT\"" msgstr "" -#. c5GAw -#: sf_dialogcontrol.xhp +#. E45Rv +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id971584027709752\n" +"sf_dialog.xhp\n" +"par_id941688542077873\n" "help.text" -msgid "One of the types listed above." +msgid "VerticalAlign: vertical alignment, \"TOP\" (default) or \"MIDDLE\" or \"BOTTOM\"" msgstr "" -#. oMipU -#: sf_dialogcontrol.xhp +#. RSnLh +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id67161270548283\n" +"sf_dialog.xhp\n" +"par_id199591885776504\n" "help.text" -msgid "No" +msgid "Create a new control of type ImageControl in the current dialog." msgstr "" -#. 59ovD -#: sf_dialogcontrol.xhp +#. oYoCP +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id341612705482566\n" +"sf_dialog.xhp\n" +"par_id551688135418418\n" "help.text" -msgid "UNO
object" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. tM7T7 -#: sf_dialogcontrol.xhp +#. mFJZ4 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id1001612705482919\n" +"sf_dialog.xhp\n" +"par_id431688135405342\n" "help.text" -msgid "The currently upmost node selected in the tree control. Refer to XmutableTreeNode in Application Programming Interface (API) documentation for detailed information." +msgid "Scale: One of next values: \"FITTOSIZE\" (default), \"KEEPRATIO\" or \"NO\"" msgstr "" -#. veivJ -#: sf_dialogcontrol.xhp +#. qBHYH +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id31583839767743\n" +"sf_dialog.xhp\n" +"par_id199591885776506\n" "help.text" -msgid "No" +msgid "Create a new control of type ListBox in the current dialog." msgstr "" -#. y2irQ -#: sf_dialogcontrol.xhp +#. EJiPj +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id111583839767195\n" +"sf_dialog.xhp\n" +"par_id1001688135548955\n" "help.text" -msgid "Specifies whether a command button is the default (OK) button." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. GAdvJ -#: sf_dialogcontrol.xhp +#. FQ6Eh +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id771583839920487\n" +"sf_dialog.xhp\n" +"par_id11688135550412\n" "help.text" -msgid "No" +msgid "DropDown: When True (default), a drop down button is displayed" msgstr "" -#. tBmrq -#: sf_dialogcontrol.xhp +#. GJVah +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id891598539196786\n" +"sf_dialog.xhp\n" +"par_id121688135552418\n" "help.text" -msgid "All" +msgid "LineCount: Specifies the maximum line count displayed in the drop down (default = 5)" msgstr "" -#. 8S9xG -#: sf_dialogcontrol.xhp +#. C3VzG +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id451583839920858\n" +"sf_dialog.xhp\n" +"par_id661688135552802\n" "help.text" -msgid "Specifies if the control is accessible with the cursor." +msgid "MultiSelect: When True, more than 1 entry may be selected. Default = False" msgstr "" -#. 2E9Cb -#: sf_dialogcontrol.xhp +#. 2td5s +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id571588333908716\n" +"sf_dialog.xhp\n" +"par_id199591885776510\n" "help.text" -msgid "No" +msgid "Create a new control of type NumericField in the current dialog." msgstr "" -#. 6L9ke -#: sf_dialogcontrol.xhp +#. zzVVQ +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id491598529331618\n" +"sf_dialog.xhp\n" +"par_id841688135885946\n" "help.text" -msgid "(read-only)" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. QbN5U -#: sf_dialogcontrol.xhp +#. TMyYy +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id721588333908708\n" +"sf_dialog.xhp\n" +"par_id781688135886499\n" "help.text" -msgid "Specifies the format used to display dates and times. It must be one these strings:" +msgid "SpinButton: when True (default = False), a spin button is present" msgstr "" -#. 5eRkE -#: sf_dialogcontrol.xhp +#. XbJfV +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id891598456980194\n" +"sf_dialog.xhp\n" +"par_id481688135887010\n" "help.text" -msgid "For dates: \"Standard (short)\", \"Standard (short YY)\", \"Standard (short YYYY)\", \"Standard (long)\", \"DD/MM/YY\", \"MM/DD/YY\", \"YY/MM/DD\", \"DD/MM/YYYY\", \"MM/DD/YYYY\" , \"YYYY/MM/DD\", \"YY-MM-DD\", \"YYYY-MM-DD\"." +msgid "MinValue: the smallest value that can be entered in the control. Default = -1000000" msgstr "" -#. CDCLC -#: sf_dialogcontrol.xhp +#. UxiQT +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id221598456991070\n" +"sf_dialog.xhp\n" +"par_id371688135887594\n" "help.text" -msgid "For times: \"24h short\", \"24h long\", \"12h short\", \"12h long\"." +msgid "MaxValue: the largest value that can be entered in the control. Default = +1000000" msgstr "" -#. nLCxq -#: sf_dialogcontrol.xhp +#. geRML +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id501583774433513\n" +"sf_dialog.xhp\n" +"par_id191688135888122\n" "help.text" -msgid "Yes" +msgid "Increment: the step when the spin button is pressed. Default = 1" msgstr "" -#. rDJFC -#: sf_dialogcontrol.xhp +#. GEbxq +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id151598177605296\n" +"sf_dialog.xhp\n" +"par_id451688135888638\n" "help.text" -msgid "Specifies the number of rows in a ListBox, a ComboBox or a TableControl." +msgid "Accuracy: specifies the decimal accuracy. Default = 2 decimal digits" msgstr "" -#. kaaLt -#: sf_dialogcontrol.xhp +#. XDRog +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id271588334016191\n" +"sf_dialog.xhp\n" +"par_id200591996776500\n" "help.text" -msgid "No" +msgid "Create a new control of type PatternField in the current dialog." msgstr "" -#. Ey9iG -#: sf_dialogcontrol.xhp +#. hHGWt +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id251588334016874\n" +"sf_dialog.xhp\n" +"par_id251688136173107\n" "help.text" -msgid "Specifies which item is selected in a ListBox, a ComboBox or a TableControl." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. azv7C -#: sf_dialogcontrol.xhp +#. rtHid +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id961598457655506\n" +"sf_dialog.xhp\n" +"par_id631688136173778\n" "help.text" -msgid "No" +msgid "EditMask: a character code that determines what the user may enter
Refer to Pattern_Field in the wiki for more information." msgstr "" -#. 6N6Eb -#: sf_dialogcontrol.xhp +#. EAbCo +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id2159845765568\n" +"sf_dialog.xhp\n" +"par_id321688136174244\n" "help.text" -msgid "Specifies if the control is read-only." +msgid "LiteralMask: contains the initial values that are displayed in the pattern field" msgstr "" -#. bubBB -#: sf_dialogcontrol.xhp +#. amC4c +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id621598457951781\n" +"sf_dialog.xhp\n" +"par_id311591885776500\n" "help.text" -msgid "No" +msgid "Create a new control of type ProgressBar in the current dialog." msgstr "" -#. r83sC -#: sf_dialogcontrol.xhp +#. 4BBzC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id821598457951782\n" +"sf_dialog.xhp\n" +"par_id551688136587329\n" "help.text" -msgid "Specifies whether a user can make multiple selections in a listbox." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. BBJCw -#: sf_dialogcontrol.xhp +#. JvdPM +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id351598458170114\n" +"sf_dialog.xhp\n" +"par_id411688136587778\n" "help.text" -msgid "Yes" +msgid "MinValue: the smallest value that can be entered in the control. Default = 0" msgstr "" -#. uHsgi -#: sf_dialogcontrol.xhp +#. W3vPH +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id151598539764402\n" +"sf_dialog.xhp\n" +"par_id261688136588146\n" "help.text" -msgid "All" +msgid "MaxValue: the largest value that can be entered in the control. Default = 100" msgstr "" -#. HLjFU -#: sf_dialogcontrol.xhp +#. orPfn +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id621598458170392\n" +"sf_dialog.xhp\n" +"par_id200502985776500\n" "help.text" -msgid "The name of the control." +msgid "Create a new control of type RadioButton in the current dialog." msgstr "" -#. jSSnv -#: sf_dialogcontrol.xhp +#. NFUPV +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id80159845835726\n" +"sf_dialog.xhp\n" +"par_id211688136829297\n" "help.text" -msgid "No" +msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line" msgstr "" -#. 8GZkA -#: sf_dialogcontrol.xhp +#. FXgot +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id841598539781888\n" +"sf_dialog.xhp\n" +"par_id200591886886500\n" "help.text" -msgid "All" +msgid "Create a new control of type ScrollBar in the current dialog." msgstr "" -#. BdxvF -#: sf_dialogcontrol.xhp +#. eqt7D +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id791598458357756\n" +"sf_dialog.xhp\n" +"par_id731688136882518\n" "help.text" -msgid "A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active." +msgid "Orientation: H[orizontal] or V[ertical]" msgstr "" -#. isrYW -#: sf_dialogcontrol.xhp +#. ukFA2 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id441598458459145\n" +"sf_dialog.xhp\n" +"par_id341688136882960\n" "help.text" -msgid "The Page property of a control defines the page of the dialog on which the control is visible." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. Cj3Kq -#: sf_dialogcontrol.xhp +#. 5azTe +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id161598458580581\n" +"sf_dialog.xhp\n" +"par_id621688136883363\n" "help.text" -msgid "Yes" +msgid "MinValue: the smallest value that can be entered in the control. Default = 0" msgstr "" -#. 6EFh7 -#: sf_dialogcontrol.xhp +#. rCC4o +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id921598458580608\n" +"sf_dialog.xhp\n" +"par_id241688136883785\n" "help.text" -msgid "Dialog
service" +msgid "MaxValue: the largest value that can be entered in the control. Default = 100" msgstr "" -#. SDCx4 -#: sf_dialogcontrol.xhp +#. PfwHb +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id181598539807426\n" +"sf_dialog.xhp\n" +"par_id200502985776722\n" "help.text" -msgid "All" +msgid "Create a new control of type TableControl in the current dialog." msgstr "" -#. sqEuV -#: sf_dialogcontrol.xhp +#. iFFvS +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id801598458580456\n" +"sf_dialog.xhp\n" +"par_id541688393982300\n" "help.text" -msgid "The parent SFDialogs.Dialog class object instance." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. GTGu9 -#: sf_dialogcontrol.xhp +#. gjYXC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id971598458773352\n" +"sf_dialog.xhp\n" +"par_id351688393983486\n" "help.text" -msgid "No" +msgid "RowHeaders: when True (default), the row Headers are shown" msgstr "" -#. LP96H -#: sf_dialogcontrol.xhp +#. mB59k +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id451598458773588\n" +"sf_dialog.xhp\n" +"par_id941688393983846\n" "help.text" -msgid "Specifies the file name containing a bitmap or other type of graphic to be displayed on the specified control. The filename must comply with the FileNaming attribute of the ScriptForge.FileSystem service." +msgid "ColumnHeaders: when True (default), the column Headers are shown" msgstr "" -#. LZLsc -#: sf_dialogcontrol.xhp +#. 7CcWA +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id831612700624650\n" +"sf_dialog.xhp\n" +"par_id141688393984239\n" "help.text" -msgid "Yes" +msgid "ScrollBars: H[orizontal] or V[ertical] or B[oth] or N[one] (default). Scrollbars appear dynamically when they are needed." msgstr "" -#. QxAW9 -#: sf_dialogcontrol.xhp +#. SjB3M +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id711612700624483\n" +"sf_dialog.xhp\n" +"par_id741688393984702\n" "help.text" -msgid "UNO
object" +msgid "GridLines: when True (default = False) horizontal and vertical lines are painted between the grid cells" msgstr "" -#. m4uz7 -#: sf_dialogcontrol.xhp +#. Afff6 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id11612700624514\n" +"sf_dialog.xhp\n" +"par_id200591895776500\n" "help.text" -msgid "An object representing the lowest root node (usually there is only one such root node). Refer to XmutableTreeNode in Application Programming Interface (API) documentation for detailed information." +msgid "Create a new control of type TextField in the current dialog." msgstr "" -#. PqsSY -#: sf_dialogcontrol.xhp +#. VeTxt +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id401598516577225\n" +"sf_dialog.xhp\n" +"par_id281688394635114\n" "help.text" -msgid "No" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. AciNr -#: sf_dialogcontrol.xhp +#. g2ZgE +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id311598516577712\n" +"sf_dialog.xhp\n" +"par_id341688394635645\n" "help.text" -msgid "Specifies the data contained in a combobox or a listbox." +msgid "MultiLine: When True (default = False), the caption may be displayed on more than one line" msgstr "" -#. PmMEu -#: sf_dialogcontrol.xhp +#. BVC62 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id781598516674550\n" +"sf_dialog.xhp\n" +"par_id671688394636092\n" "help.text" -msgid "Yes" +msgid "MaximumLength: the maximum character count (default = 0 meaning unlimited)" msgstr "" -#. PEFC6 -#: sf_dialogcontrol.xhp +#. WqBWr +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id11159815676440\n" +"sf_dialog.xhp\n" +"par_id231688394641827\n" "help.text" -msgid "The TabIndex property specifies a control's place in the tab order in the dialog." +msgid "PasswordCharacter: a single character specifying the echo for a password text field (default = \"\")" msgstr "" -#. q532w -#: sf_dialogcontrol.xhp +#. eFECE +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id781598516764550\n" +"sf_dialog.xhp\n" +"par_id200591895776611\n" "help.text" -msgid "Yes" +msgid "Create a new control of type TimeField in the current dialog." msgstr "" -#. 4h8VF -#: sf_dialogcontrol.xhp +#. ADdEz +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id11159851676440\n" +"sf_dialog.xhp\n" +"par_id771688394821811\n" "help.text" -msgid "Gives access to the text being displayed by the control." +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. We5gv -#: sf_dialogcontrol.xhp +#. rEYM9 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id411598517275112\n" +"sf_dialog.xhp\n" +"par_id711688394822256\n" "help.text" -msgid "No" +msgid "MinTime: the smallest time that can be entered in the control. Default = 0" msgstr "" -#. EijF2 -#: sf_dialogcontrol.xhp +#. 9m7F9 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id171598539985022\n" +"sf_dialog.xhp\n" +"par_id491688394822582\n" "help.text" -msgid "All" +msgid "MaxTime: the largest time that can be entered in the control. Default = 24h" msgstr "" -#. CbBZJ -#: sf_dialogcontrol.xhp +#. CcyYS +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id651598517275384\n" +"sf_dialog.xhp\n" +"par_id200692885776500\n" "help.text" -msgid "Specifies the text that appears as a tooltip when you hold the mouse pointer over the control." +msgid "Create a new control of type TreeControl in the current dialog." msgstr "" -#. kVtki -#: sf_dialogcontrol.xhp +#. KBrUN +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id821598517418463\n" +"sf_dialog.xhp\n" +"par_id241688394984562\n" "help.text" -msgid "No" +msgid "Border: \"3D\" (default) or \"FLAT\" or \"NONE\"" msgstr "" -#. ZemBe -#: sf_dialogcontrol.xhp +#. j8x9C +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id141598517418822\n" +"sf_dialog.xhp\n" +"par_id381598185776500\n" "help.text" -msgid "Specifies if the checkbox control may appear dimmed (grayed) or not." +msgid "Ends the display of a modal dialog and gives back the argument as return value for the current Execute() running action." msgstr "" -#. rZGBG -#: sf_dialogcontrol.xhp +#. gjvwy +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id701598517671337\n" +"sf_dialog.xhp\n" +"par_id551598185953362\n" "help.text" -msgid "No" +msgid "EndExecute() is usually contained in the processing of a macro triggered by a dialog or control event." msgstr "" -#. vQoQG -#: sf_dialogcontrol.xhp +#. yukGC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id481687785271551\n" +"sf_dialog.xhp\n" +"par_id451598185776957\n" "help.text" -msgid "Hyperlink" +msgid "returnvalue: The value passed to the running Execute() method." msgstr "" -#. MmMXv -#: sf_dialogcontrol.xhp +#. aizuC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id1001598540024252\n" +"sf_dialog.xhp\n" +"par_id81620201915101\n" "help.text" -msgid "The URL to open when the control is clicked." +msgid "Above com.sun.star.lang.EventObject mentions are optional. Such annotations help identify %PRODUCTNAME Application Programming Interface (API)." msgstr "" -#. BDWA7 -#: sf_dialogcontrol.xhp +#. FD9fr +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id701598517671373\n" +"sf_dialog.xhp\n" +"par_id29159818646178\n" "help.text" -msgid "No" +msgid "Display the dialog box and, when modal, wait for its termination by the user. The returned value is either:" msgstr "" -#. GYx9T -#: sf_dialogcontrol.xhp +#. PRCaG +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id1001598540024225\n" +"sf_dialog.xhp\n" +"par_id541598186676277\n" "help.text" -msgid "Refer to Value property" +msgid "0 : Cancel button pressed" msgstr "" -#. PqKgo -#: sf_dialogcontrol.xhp +#. eCGBY +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id661598517730941\n" +"sf_dialog.xhp\n" +"par_id821598186716345\n" "help.text" -msgid "No" +msgid "1 : OK button pressed" msgstr "" -#. 8r3sG -#: sf_dialogcontrol.xhp +#. MovhC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id761598540042290\n" +"sf_dialog.xhp\n" +"par_id951598186738346\n" "help.text" -msgid "All" +msgid "Otherwise the dialog stopped with an EndExecute() statement issued by a dialog or control event" msgstr "" -#. xLL83 -#: sf_dialogcontrol.xhp +#. eBFXT +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id881598517730836\n" +"sf_dialog.xhp\n" +"par_id741598187335869\n" "help.text" -msgid "Specifies if the control is hidden or visible." +msgid "For non-modal dialog boxes the method always returns 0 and the execution of the macro continues." msgstr "" -#. Xw6X9 -#: sf_dialogcontrol.xhp +#. Ej2iF +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id451598177924437\n" +"sf_dialog.xhp\n" +"par_id11598186461227\n" "help.text" -msgid "Yes" +msgid "modal: False when non-modal dialog. Default = True." msgstr "" -#. dBNCA -#: sf_dialogcontrol.xhp +#. fGatm +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id94159817792441\n" +"sf_dialog.xhp\n" +"par_id231620110023843\n" "help.text" -msgid "UNO
object" +msgid "In this Basic example myDialog dialog is stored in current document's Standard library." msgstr "" -#. gbjHB -#: sf_dialogcontrol.xhp +#. ouEVN +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id311598540066789\n" +"sf_dialog.xhp\n" +"par_id191620110162627\n" "help.text" -msgid "All" +msgid "This Python code displays DlgConvert modal dialog from Euro shared Basic library." msgstr "" -#. Erxx8 -#: sf_dialogcontrol.xhp +#. HU6Jv +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id191598177924897\n" +"sf_dialog.xhp\n" +"par_id21598187900349\n" "help.text" -msgid "The UNO object representing the control model. Refer to XControlModel and UnoControlDialogModel in Application Programming Interface (API) documentation for detailed information." +msgid "Replaces all fixed text strings in a dialog by their translated versions based on a L10N service instance. This method translates the following strings:" msgstr "" -#. xfhaP -#: sf_dialogcontrol.xhp +#. JixXU +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id811598178083501\n" +"sf_dialog.xhp\n" +"par_id641625855723650\n" "help.text" -msgid "Yes" +msgid "The method returns True if successful." msgstr "" -#. o2H9W -#: sf_dialogcontrol.xhp +#. 3wcE6 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id981598178083938\n" +"sf_dialog.xhp\n" +"par_id61637871260604\n" "help.text" -msgid "UNO
object" +msgid "To create a list of translatable strings in a dialog use the AddTextsFromDialog method from the L10N service." msgstr "" -#. rrwm6 -#: sf_dialogcontrol.xhp +#. ECNVg +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id551598540079329\n" +"sf_dialog.xhp\n" +"par_id451598185776205\n" "help.text" -msgid "All" +msgid "l10n: A L10N service instance from which translated strings will be retrieved." msgstr "" -#. TCTcr -#: sf_dialogcontrol.xhp +#. MeJAT +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id731598178083442\n" +"sf_dialog.xhp\n" +"par_id951620300689850\n" "help.text" -msgid "The UNO object representing the control view. Refer to XControl and UnoControlDialog in Application Programming Interface (API) documentation for detailed information." +msgid "The following example loads translated strings and applies them to the dialog \"MyDialog\"." msgstr "" -#. SAkJX -#: sf_dialogcontrol.xhp +#. 3dcGG +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id741612699446459\n" +"sf_dialog.xhp\n" +"par_id901637872163895\n" "help.text" -msgid "Yes" +msgid "Read the L10N service help page to learn more about how PO and POT files are handled." msgstr "" -#. yuAdF -#: sf_dialogcontrol.xhp +#. yGR7U +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id311612699446893\n" +"sf_dialog.xhp\n" +"par_id21598298953697\n" "help.text" -msgid "UNO
object" +msgid "Set the tabulation index of a series of controls. The sequence of controls are given as an array of control names from the first to the last." msgstr "" -#. s7nM8 -#: sf_dialogcontrol.xhp +#. GfyZ2 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id691612699446892\n" +"sf_dialog.xhp\n" +"par_id921688543457317\n" "help.text" -msgid "The UNO object representing the tree control data model. Refer to XMutableTreeDataModel in Application Programming Interface (API) documentation for detailed information." +msgid "Controls with an index >= 1 are not accessible with the TAB key if:
- they are omitted from the given list
- their type is FixedLine, GroupBox or ProgressBar
- they are disabled" msgstr "" -#. VLPsS -#: sf_dialogcontrol.xhp +#. sx3QG +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_ValueProperty\n" +"sf_dialog.xhp\n" +"par_id111688543698861\n" "help.text" -msgid "The Value property" +msgid "TabsList: an array of valid control names in the order of tabulation" msgstr "" -#. JHK7w -#: sf_dialogcontrol.xhp +#. dqQvh +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id10159854325492\n" +"sf_dialog.xhp\n" +"par_id381688543699284\n" "help.text" -msgid "Control type" +msgid "Start: the tab index to be assigned to the 1st control in the list. Default = 1" msgstr "" -#. 33wWa -#: sf_dialogcontrol.xhp +#. CEhSS +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id741598543254158\n" +"sf_dialog.xhp\n" +"par_id321688543699637\n" "help.text" -msgid "Type" +msgid "Increment: the difference between 2 successive tab indexes. Default = 1" msgstr "" -#. QLVMB -#: sf_dialogcontrol.xhp +#. DFWjc +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id961598543254444\n" +"sf_dialog.xhp\n" +"par_id401688543845094\n" "help.text" -msgid "Description" +msgid "True when successful." msgstr "" -#. jEyx9 -#: sf_dialogcontrol.xhp +#. 4FcCi +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id741598543254108\n" +"sf_dialog.xhp\n" +"par_id21598187953697\n" "help.text" -msgid "For toggle buttons only" +msgid "Moves the topleft corner of a dialog to new coordinates and/or modify its dimensions. All distances are expressed in AppFont units. Without arguments, the method resets the initial dimensions. Return True if the resize was successful." msgstr "" -#. gCWiY -#: sf_dialogcontrol.xhp +#. XRdLE +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id741598543254376\n" +"sf_dialog.xhp\n" +"par_id481651236673068\n" "help.text" -msgid "Boolean or Integer" +msgid "Left: the horizontal distance from the top-left corner" msgstr "" -#. 7GZGS -#: sf_dialogcontrol.xhp +#. FcTcU +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id521598543254630\n" +"sf_dialog.xhp\n" +"par_id721651236674379\n" "help.text" -msgid "0, False: not checked
1, True: checked
2: grayed, don't know" +msgid "Top: the vertical distance from the top-left corner" msgstr "" -#. nZVA5 -#: sf_dialogcontrol.xhp +#. uX7ps +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id331598543254947\n" -"help.text" -msgid "The selected value. The ListIndex property is an alternate option." +"sf_dialog.xhp\n" +"par_id991651236674995\n" +"help.text" +msgid "Width: the width of the rectangle containing the dialog" msgstr "" -#. MWkEW -#: sf_dialogcontrol.xhp +#. ApqA8 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id5159854325443\n" +"sf_dialog.xhp\n" +"par_id771651236675564\n" "help.text" -msgid "Numeric" +msgid "Height: the height of the rectangle containing the dialog" msgstr "" -#. kgfXR -#: sf_dialogcontrol.xhp +#. nEvvd +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id971598543254757\n" +"sf_dialog.xhp\n" +"par_id211651236676180\n" "help.text" -msgid "A file name formatted in accordance with the FileNaming property of the ScriptForge.FileSystem service" +msgid "Missing arguments are left unchanged" msgstr "" -#. 9NVHN -#: sf_dialogcontrol.xhp +#. aADKy +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id221598543254760\n" +"sf_dialog.xhp\n" +"bas_id791621411085031\n" "help.text" -msgid "String or Numeric" +msgid "oDlg.Resize(1000, 2000, Height := 6000) ' Width is not changed" msgstr "" -#. 53Ztp -#: sf_dialogcontrol.xhp +#. DwqUe +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id42159854325422\n" +"sf_dialog.xhp\n" +"pyc_id941620304183866\n" "help.text" -msgid "String or array of strings" +msgid "dlg.Resize(1000, 2000, Height = 6000) # Width is not changed" msgstr "" -#. 9NwJs -#: sf_dialogcontrol.xhp +#. 6DRxV +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id601598543254780\n" +"sf_dialog.xhp\n" +"par_id21598187950047\n" "help.text" -msgid "The selected row(s) as a scalar or as an array depending on the MultiSelect attribute" +msgid "Defines which controls in a dialog are responsible for switching pages, making it easier to manage the Page property of a dialog and its controls." msgstr "" -#. tFGhf -#: sf_dialogcontrol.xhp +#. DDxnE +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id461598543254909\n" +"sf_dialog.xhp\n" +"par_id291670871829824\n" "help.text" -msgid "Numeric" +msgid "Dialogs may have multiple pages and the currently visible page is defined by the Page dialog property. If the Page property is left unchanged, the default visible page is equal to 0 (zero), meaning that no particular page is defined and all visible controls are displayed regardless of the value set in their own Page property." msgstr "" -#. YvPAp -#: sf_dialogcontrol.xhp +#. YB97d +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id631598543254771\n" +"sf_dialog.xhp\n" +"par_id431670872095503\n" "help.text" -msgid "Numeric" +msgid "When the Page property of a dialog is changed to some other value such as 1, 2, 3 and so forth, then only the controls whose Page property match the current dialog page will be displayed." msgstr "" -#. fBArb -#: sf_dialogcontrol.xhp +#. 4oNFA +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id91598543254766\n" +"sf_dialog.xhp\n" +"par_id161670872517032\n" "help.text" -msgid "Must be within the predefined bounds" +msgid "By using the SetPageManager method it is possible to define four types of page managers:" msgstr "" -#. ZragT -#: sf_dialogcontrol.xhp +#. Bdjcu +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id851598543254624\n" +"sf_dialog.xhp\n" +"par_id161670872665432\n" "help.text" -msgid "Each button has its own name. They are linked together if their TAB positions are contiguous. If a radiobutton is set to True, the other related buttons are automatically set to False" +msgid "List box or combo box: in this case, each entry in the list box or combo box corresponds to a page. The first item refers to Page 1, the second items refers to Page 2 and so on." msgstr "" -#. m6Uyb -#: sf_dialogcontrol.xhp +#. 2cbkh +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id531598543254869\n" +"sf_dialog.xhp\n" +"par_id141670872835955\n" "help.text" -msgid "Numeric" +msgid "Group of radio buttons: defines a group of radio buttons that will control which page is visible." msgstr "" -#. MWdGb -#: sf_dialogcontrol.xhp +#. 37XCi +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id21598543254994\n" +"sf_dialog.xhp\n" +"par_id11670872840588\n" "help.text" -msgid "Must be within the predefined bounds" +msgid "Sequence of buttons: defines a set of buttons, each of which corresponding to a dialog page. This can be used to emulate a tabbed interface by placing buttons side by side in the dialog." msgstr "" -#. CVTcE -#: sf_dialogcontrol.xhp +#. qFQHA +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id441598543254951\n" +"sf_dialog.xhp\n" +"par_id461670873122132\n" "help.text" -msgid "One-dimensional array with the data of the currently selected row." +msgid "Previous/Next buttons: defines which buttons in the dialog that will be used to navigate to the Previous/Next page in the dialog." msgstr "" -#. a9AMF -#: sf_dialogcontrol.xhp +#. dANup +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id441598543254738\n" +"sf_dialog.xhp\n" +"par_id871670874232499\n" "help.text" -msgid "The text appearing in the field" +msgid "It is possible to use more than one page management mechanism at the same time." msgstr "" -#. DRtmo -#: sf_dialogcontrol.xhp +#. JLw7E +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id61687963745108\n" +"sf_dialog.xhp\n" +"par_id831670873941232\n" "help.text" -msgid "There's no Value property for GroupBox, Hyperlink, ImageControl and TreeControl dialog controls." +msgid "This method is supposed to be called just once before calling the Execute method. Subsequent calls are ignored." msgstr "" -#. CABLr -#: sf_dialogcontrol.xhp +#. NAsqC +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"hd_id421612628828054\n" +"sf_dialog.xhp\n" +"par_id371670874142972\n" "help.text" -msgid "Event properties" +msgid "If successful this method returns True." msgstr "" -#. fkFAt -#: sf_dialogcontrol.xhp +#. iyTJv +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id961612628879819\n" +"sf_dialog.xhp\n" +"par_id481651236673466\n" "help.text" -msgid "Name" +msgid "pilotcontrols: a comma-separated list of ListBox, ComboBox or RadioButton control names used as page managers. For RadioButton controls, specify the name of the first control in the group to be used." msgstr "" -#. 2sB8F -#: sf_dialogcontrol.xhp +#. vNxtV +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id401612628879819\n" +"sf_dialog.xhp\n" +"par_id721651236670589\n" "help.text" -msgid "ReadOnly" +msgid "tabcontrols: a comma-separated list of button names that will be used as page managers. The order in which they are specified in this argument corresponds to the page number they are associated with." msgstr "" -#. 2A2Ex -#: sf_dialogcontrol.xhp +#. VXVDL +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id281612628879819\n" +"sf_dialog.xhp\n" +"par_id991651236674963\n" "help.text" -msgid "Description as labeled in the Basic IDE" +msgid "wizardcontrols: a comma-separated list with the names of two buttons that will be used as the Previous/Next buttons." msgstr "" -#. rSRBQ -#: sf_dialogcontrol.xhp +#. AEFZz +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id91612707166532\n" +"sf_dialog.xhp\n" +"par_id771651236671764\n" "help.text" -msgid "Yes" +msgid "lastpage: the number of the last available page. It is recommended to specify this value when using the Previous/Next page manager." msgstr "" -#. aABgD -#: sf_dialogcontrol.xhp +#. sWmg6 +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id291612707166258\n" +"sf_dialog.xhp\n" +"par_id861670874176863\n" "help.text" -msgid "Execute action" +msgid "Consider a dialog with three pages. The dialog has a ListBox control named \"aPageList\" that will be used to control the visible page. Additionally, there are two buttons named \"btnPrevious\" and \"btnNext\" that will be used as the Previous/Next buttons in the dialog." msgstr "" -#. KnFdW -#: sf_dialogcontrol.xhp +#. ARCGg +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id79161270716675\n" +"sf_dialog.xhp\n" +"par_id21598187953679\n" "help.text" -msgid "Yes" +msgid "Terminate the Dialog service for the current instance. Return True if the termination was successful." msgstr "" -#. JrRob -#: sf_dialogcontrol.xhp +#. CgAYf +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id831612707166731\n" +"sf_dialog.xhp\n" +"par_id951620300687150\n" "help.text" -msgid "While adjusting" +msgid "Below Basic and Python examples open DlgConsole and dlgTrace non-modal dialogs. They are respectively stored in ScriptForge and Access2Base shared libraries. Dialog close buttons are disabled and explicit termination is performed at the end of a running process." msgstr "" -#. mpuj3 -#: sf_dialogcontrol.xhp +#. W3W3Y +#: sf_dialog.xhp msgctxt "" -"sf_dialogcontrol.xhp\n" -"par_id111612629836630\n" +"sf_dialog.xhp\n" +"par_id301620302137482\n" "help.text" -msgid "Yes" +msgid "In this example a button in DlgConsole is substituting inhibited window closing:" msgstr "" -#. 7Swj5 +#. BFfGX #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id1001612629836902\n" +"tit\n" "help.text" -msgid "When receiving focus" +msgid "SFDialogs.DialogControl service" msgstr "" -#. Mp4i7 +#. 2KEBr #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id291612629836294\n" +"bm_id781582391760253\n" "help.text" -msgid "Yes" +msgid "SFDialogs.DialogControl service" msgstr "" -#. ozGia +#. RDcyi #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id62161262983683\n" +"par_id931583589764919\n" "help.text" -msgid "When losing focus" +msgid "The DialogControl service manages the controls belonging to a dialog defined with the Basic Dialog Editor. Each instance of the current service represents a single control within a dialog box." msgstr "" -#. TR5uW +#. 7dDgL #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id51612707354544\n" +"par_id701598191157426\n" "help.text" -msgid "Yes" +msgid "The focus is set on getting and setting the values displayed by the controls of the dialog box. Formatting is accessible via the XControlModel and XControlView properties." msgstr "" -#. HREcr +#. fFfwe #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id211612707354899\n" +"par_id981598191184526\n" "help.text" -msgid "Item status changed" +msgid "Note that the unique DialogControl.Value property content varies according to the control type." msgstr "" -#. L6e2x +#. MBrzA #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id81612629836634\n" +"par_id991612698027551\n" "help.text" -msgid "Yes" +msgid "A special attention is given to controls of type tree control. It is easy to populate a tree, either branch by branch, or with a set of branches at once. Populating a tree control can be performed statically or dynamically." msgstr "" -#. sVo6A +#. hag3A #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id881612629836744\n" +"par_id891598188164936\n" "help.text" -msgid "Key pressed" +msgid "The SFDialogs.DialogControl service is closely related to the SFDialogs.Dialog service." msgstr "" -#. pPBHX +#. uGTGK #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id591612629836830\n" +"hd_id581582885621841\n" "help.text" -msgid "Yes" +msgid "Service invocation" msgstr "" -#. P6NX8 +#. LGkgR #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id161612629836775\n" +"par_id141609955500101\n" "help.text" -msgid "Key released" +msgid "Before using the DialogControl service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. XJGHA +#. EnxDs #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id891612629836630\n" +"par_id361598174756160\n" "help.text" -msgid "Yes" +msgid "The DialogControl service is invoked from an existing Dialog service instance through its Controls() method. The dialog must be initiated with the SFDialogs.Dialog service." msgstr "" -#. oCDXm +#. RCFrE #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id461612629836679\n" +"bas_id581598453210170\n" "help.text" -msgid "Mouse moved while key presses" +msgid "myControl.Value = \"Dialog started at \" & Now()" msgstr "" -#. nLbMG +#. WVG8J #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id131612629836291\n" +"bas_id961598453222539\n" "help.text" -msgid "Yes" +msgid "' ... process the controls actual values" msgstr "" -#. 9XdcG +#. gxhUu #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id151612629836151\n" +"pyc_id861620225235002\n" "help.text" -msgid "Mouse inside" +msgid "text.Value = \"Dialog started at \" + strftime(\"%a, %d %b %Y %H:%M:%S\", localtime())" msgstr "" -#. BZ7sC +#. nu3f3 #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id211612629836725\n" +"pyc_id841620225235377\n" "help.text" -msgid "Yes" +msgid "# ... process the controls actual values" msgstr "" -#. mzbBD +#. GZ3ia #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id361612629836624\n" +"hd_id141670854511382\n" "help.text" -msgid "Mouse outside" +msgid "Retrieving the DialogControl instance that triggered a control event" msgstr "" -#. fAD8Y +#. CcXYE #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id311612629836481\n" +"par_id951598174966322\n" "help.text" -msgid "Yes" +msgid "An instance of the DialogControl service can be retrieved via the SFDialogs.DialogEvent service, provided that the dialog was initiated with the Dialog service. In the example below, oControl contains the DialogControl instance that triggered the control event." msgstr "" -#. FCBxu +#. jeLRp #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id721612629836752\n" +"par_id741619625211462\n" "help.text" -msgid "Mouse moved" +msgid "Or using Python:" msgstr "" -#. 4DCtC +#. EroTy #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id981612629836116\n" +"par_id251598176312571\n" "help.text" -msgid "Yes" +msgid "Note that in the previous examples, the prefix \"SFDialogs.\" may be omitted when deemed appropriate." msgstr "" -#. 8B9ct +#. KazD8 #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id381612629836635\n" +"hd_id681670854491710\n" "help.text" -msgid "Mouse button pressed" +msgid "Handling exceptions in event handlers" msgstr "" -#. krueU +#. isdwE #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id711612629836704\n" +"par_id971670855125683\n" "help.text" -msgid "Yes" +msgid "When creating an event handler for control events it is good practice to handle errors inside the subroutine itself. For instance, suppose the event handler below is called when button is clicked." msgstr "" -#. 4c5qE +#. HSAhd #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id35161262983642\n" +"bas_id261670857160312\n" "help.text" -msgid "Mouse button released" +msgid "' Process the event" msgstr "" -#. FkyLb +#. wUTZB #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id851612707606863\n" +"par_id691670857377446\n" "help.text" -msgid "No" +msgid "Call SF_Exception.Clear if you do not want the error to propagate after the dialog execution ended." msgstr "" -#. VudpK +#. GVfqQ #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id351612707606197\n" +"par_id741619625211445\n" "help.text" -msgid "(Not in Basic IDE) when the expansion button is pressed on a node in a tree control" +msgid "In Python use native try/except blocks for exception handling as shown below:" msgstr "" -#. TkEgQ +#. UAGhF #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id121612707606251\n" +"pyc_id491670866556493\n" "help.text" -msgid "No" +msgid "# Process the event" msgstr "" -#. quWBQ +#. KY75S #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id881612707606121\n" +"pyc_id416708660557072\n" "help.text" -msgid "(Not in Basic IDE) when a node in a tree control is selected" +msgid "# The object \"bas\" below is an instance of the Basic service" msgstr "" -#. qyb3B +#. F9uKj #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id811612707606330\n" +"hd_id71598455687512\n" "help.text" -msgid "Yes" +msgid "Control types" msgstr "" -#. th6Kr +#. jKJBV #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id621612707606219\n" +"par_id851598455863395\n" "help.text" -msgid "Text modified" +msgid "The DialogControl service is available for these control types:" msgstr "" -#. YFbGT +#. gTfDQ #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"hd_id421583670049913\n" +"par_id271687789435391\n" "help.text" -msgid "Methods" +msgid "• TableControl
• TextField
• TimeField
• TreeControl

" msgstr "" -#. xNrc5 +#. 7xddb #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id891611613601554\n" +"hd_id651583668365757\n" "help.text" -msgid "List of Methods in the DialogControl Service" +msgid "Properties" msgstr "" -#. uHbTG +#. 94RMV #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id831612711823126\n" +"par_id871583668386455\n" "help.text" -msgid "Create and return a new node of the tree control as a UNO object subordinate to a parent node. Refer to XMutableTreeNode in Application Programming Interface (API) documentation for detailed information." +msgid "Name" msgstr "" -#. MrQnS +#. eccsg #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id741612711823706\n" +"par_id491583668386455\n" "help.text" -msgid "This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event - using the OnNodeExpanded event - to complete the tree dynamically." +msgid "ReadOnly" msgstr "" -#. T8xdA +#. KRYNv #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id761612711823834\n" +"par_id271583668474014\n" "help.text" -msgid "parentnode: A node UNO object, of type com.sun.star.awt.tree.XMutableTreeNode." +msgid "Type" msgstr "" -#. qJ9ej +#. U9ZYU #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id791612711823819\n" +"par_id291598538799794\n" "help.text" -msgid "displayvalue: The text appearing in the tree control box." +msgid "Applicable to" msgstr "" -#. Pzz72 +#. emDac #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id911612711823382\n" +"par_id401583668386455\n" "help.text" -msgid "datavalue: Any value associated with the new node. datavalue may be a string, a number or a date. Omit the argument when not applicable." +msgid "Description" msgstr "" -#. 2pLPL +#. cAKRH #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id901620317110685\n" +"par_id372693668519172\n" "help.text" -msgid "%PRODUCTNAME Basic and Python examples pick up current document's myDialog dialog from Standard library." +msgid "Yes" msgstr "" -#. 8B3qP +#. M4GR3 #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id221612713087885\n" +"par_id771583778386455\n" "help.text" -msgid "Return True when a subtree, subordinate to a parent node, could be inserted successfully in a tree control. If the parent node had already child nodes before calling this method, the child nodes are erased." +msgid "The Border property refers to the surrounding of the control: 3D, FLAT or NONE." msgstr "" -#. beond +#. xNGhR #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id781612713087722\n" +"par_id371583668519172\n" "help.text" -msgid "parentnode: A node UNO object, of type com.sun.star.awt.tree.XMutableTreeNode." +msgid "No" msgstr "" -#. QJ73V +#. aTyMC #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id36161271308759\n" +"par_id771583668386455\n" "help.text" -msgid "flattree: a two dimension array sorted on the columns containing the display values. Such an array can be issued by the GetRows method applied on the SFDatabases.Database service. When an array item containing the text to be displayed is Empty or Null, no new subnode is created and the remainder of the row is skipped." +msgid "Specifies if a command button has or not the behaviour of a Cancel button." msgstr "" -#. r5QNj +#. Gft3Z #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"bas_id61612716027443\n" +"par_id541583839708548\n" "help.text" -msgid "Flat tree >>>> Resulting subtree" +msgid "No" msgstr "" -#. MUi8U +#. UXoyn #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id51612713087915\n" +"par_id731583839708412\n" "help.text" -msgid "withdatavalue: When False default value is used, every column of flattree contains the text to be displayed in the tree control. When True, the texts to be displayed (displayvalue) are in columns 0, 2, 4, ... while the data values (datavalue) are in columns 1, 3, 5, ..." +msgid "Specifies the text associated with the control." msgstr "" -#. fWnhZ +#. Uo2SP #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id151612780723320\n" +"par_id761584027709516\n" "help.text" -msgid "Returns a new root node of the tree control, as a node UNO object of type com.sun.star.awt.tree.XMutableTreeNode. The new tree root is inserted below pre-existing root nodes. " +msgid "Yes" msgstr "" -#. YT845 +#. YKEAg #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id821612780723965\n" +"par_id261598539120502\n" "help.text" -msgid "This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event to complete the tree dynamically." +msgid "All" msgstr "" -#. JXyjD +#. c5GAw #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id791612117823819\n" +"par_id971584027709752\n" "help.text" -msgid "displayvalue: The text appearing in the tree control box." +msgid "One of the types listed above." msgstr "" -#. XxGFd +#. oMipU #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id171612781589503\n" +"par_id67161270548283\n" "help.text" -msgid "Traverses the tree and finds recursively, starting from the root, a node meeting some criteria. Either - 1 match is enough - having its display value matching displayvalue pattern or having its data value equal to datavalue. The comparisons may be or not case-sensitive. The first matching occurrence is returned as a node UNO object of type com.sun.star.awt.tree.XMutableTreeNode. " +msgid "No" msgstr "" -#. 5Jxkj +#. 59ovD #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id741612782475457\n" +"par_id341612705482566\n" "help.text" -msgid "When not found, the method returns Nothing, to be tested with the IsNull() builtin function." +msgid "UNO
object" msgstr "" -#. n7pE8 +#. tM7T7 #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id41612781589363\n" +"par_id1001612705482919\n" "help.text" -msgid "This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event." +msgid "The currently upmost node selected in the tree control. Refer to XmutableTreeNode in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. Dd4Ti +#. veivJ #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id541613670199211\n" +"par_id31583839767743\n" "help.text" -msgid "One argument out of displayvalue or datavalue must be specified. If both present, one match is sufficient to select the node." +msgid "No" msgstr "" -#. 4xxwd +#. y2irQ #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id591612781589560\n" +"par_id111583839767195\n" "help.text" -msgid "displayvalue: The pattern to be matched. Refer to SF_String.IsLike() method for the list of possible wildcards. When equal to the zero-length string (default), this display value is not searched for." +msgid "Specifies whether a command button is the default (OK) button." msgstr "" -#. BE58W +#. GAdvJ #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id141582384726168\n" +"par_id771583839920487\n" "help.text" -msgid "casesensitive: Default value is False" +msgid "No" msgstr "" -#. tCfF4 +#. tBmrq #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id871583933076484\n" +"par_id891598539196786\n" "help.text" -msgid "Move the top-left corner of a dialog control to new coordinates and/or modify its dimensions. Return True if resizing was successful." +msgid "All" msgstr "" -#. pzYAg +#. 8S9xG #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id351687783159237\n" +"par_id451583839920858\n" "help.text" -msgid "All distances are expressed in Map AppFont units and are measured from the top-left corner of the parent dialog. Without arguments the method resizes the control to its \"preferred size\", a size adjusted depending on its actual content. Missing arguments are left unchanged." +msgid "Specifies if the control is accessible with the cursor." msgstr "" -#. 7RcPA +#. 2E9Cb #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id911687783094143\n" +"par_id571588333908716\n" "help.text" -msgid "Left: The horizontal distance from the top-left corner" +msgid "No" msgstr "" -#. n6cEo +#. 6L9ke #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id251687783287236\n" +"par_id491598529331618\n" "help.text" -msgid "Top: The vertical distance from the top-left corner" +msgid "(read-only)" msgstr "" -#. EpNL7 +#. QbN5U #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id291687783328508\n" +"par_id721588333908708\n" "help.text" -msgid "Width: the horizontal width of the rectangle containing the control" +msgid "Specifies the format used to display dates and times. It must be one these strings:" msgstr "" -#. RMsh8 +#. 5eRkE #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id901687783339292\n" +"par_id891598456980194\n" "help.text" -msgid "Height: the vertical height of the rectangle containing the control" +msgid "For dates: \"Standard (short)\", \"Standard (short YY)\", \"Standard (short YYYY)\", \"Standard (long)\", \"DD/MM/YY\", \"MM/DD/YY\", \"YY/MM/DD\", \"DD/MM/YYYY\", \"MM/DD/YYYY\" , \"YYYY/MM/DD\", \"YY-MM-DD\", \"YYYY-MM-DD\"." msgstr "" -#. k6MEJ +#. CDCLC #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"bas_id361598179153096\n" +"par_id221598456991070\n" "help.text" -msgid "oControl.Resize(100, 200, Height:=6000) ' Width is unchanged" +msgid "For times: \"24h short\", \"24h long\", \"12h short\", \"12h long\"." msgstr "" -#. Cay6f +#. nLCxq #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"pyc_id821620319176082\n" +"par_id501583774433513\n" "help.text" -msgid "ctrl.Resize(300, 200, 1500) # Height is unchanged" +msgid "Yes" msgstr "" -#. 3oU3L +#. rDJFC #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id871583933076448\n" +"par_id151598177605296\n" "help.text" -msgid "Set the focus on the control. Return True if focusing was successful." +msgid "Specifies the number of rows in a ListBox, a ComboBox or a TableControl." msgstr "" -#. 6YvuU +#. kaaLt #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id151598178880227\n" +"par_id271588334016191\n" "help.text" -msgid "This method is often called from a dialog or control event." +msgid "No" msgstr "" -#. it2QN +#. Ey9iG #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id541638553960464\n" +"par_id251588334016874\n" "help.text" -msgid "Fills a TableControl with the given data. All preexisting data is cleared before inserting the new data passed as argument." +msgid "Specifies which item is selected in a ListBox, a ComboBox or a TableControl." msgstr "" -#. Vmmag +#. azv7C #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id551638554058131\n" +"par_id961598457655506\n" "help.text" -msgid "When the TableControl is added to the dialog, it is possible to use the Basic IDE to define whether column and row headers will be shown in the table. If the TableControl has column and/or row headers, the first column and/or row in the provided data array are used as labels for the table headers." +msgid "No" msgstr "" -#. qn4UN +#. 6N6Eb #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id411638569396108\n" +"par_id2159845765568\n" "help.text" -msgid "This method returns True when successful." +msgid "Specifies if the control is read-only." msgstr "" -#. LESVB +#. bubBB #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id1001584541257133\n" +"par_id621598457951781\n" "help.text" -msgid "dataarray: Data to be entered into the table represented as an Array of Arrays in Basic or a tuple of tuples in Python. The data must include column and row headers if they are to be displayed by the TableControl." +msgid "No" msgstr "" -#. zGc73 +#. r83sC #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id1001584541257025\n" +"par_id821598457951782\n" "help.text" -msgid "widths: Array containing the relative widths of each column. In other words, widths = (1, 2) means that the second column is twice as wide as the first one. If the number of values in the array is smaller than the number of columns in the table, then the last value in the array is used to define the width of the remaining columns." +msgid "Specifies whether a user can make multiple selections in a listbox." msgstr "" -#. AEGq3 +#. BBJCw #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id1001584541257007\n" +"par_id351598458170114\n" "help.text" -msgid "alignments: Defines the alignment in each column as a string in which each character can be \"L\" (Left), \"C\" (Center), \"R\" (Right) or \" \" (whitespace, default, meaning left for strings and right for numeric values). If the length of the string is shorter than the number of columns in the table, then the last character in the string is used to define the alignment of the remaining columns." +msgid "Yes" msgstr "" -#. i3UBY +#. uHsgi #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id551688397846388\n" +"par_id151598539764402\n" "help.text" -msgid "RowHeaderWidth: width of the row header column expressed in Map AppFont units. Default = 10. The argument is ignored when the TableControl has no row header." +msgid "All" msgstr "" -#. CK6RC +#. HLjFU #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id381638569172413\n" +"par_id621598458170392\n" "help.text" -msgid "The following example assumes that the dialog myDialog has a TableControl named Grid1 with \"Show row header\" and \"Show column header\" properties set to \"Yes\"." +msgid "The name of the control." msgstr "" -#. N9Byz +#. jSSnv #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id171638650502346\n" +"par_id80159845835726\n" "help.text" -msgid "The Value property returns the selected row in the table. If no row is selected, an empty Array object is returned. The following code snippet shows how to test if any row is selected in the table." +msgid "No" msgstr "" -#. C3f3k +#. 8GZkA #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"bas_id361638651540588\n" +"par_id841598539781888\n" "help.text" -msgid "MsgBox \"No row selected.\"" +msgid "All" msgstr "" -#. iQ94A +#. BdxvF #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"bas_id781638651541028\n" +"par_id791598458357756\n" "help.text" -msgid "MsgBox \"Row \" & oTable.ListIndex & \" is selected.\"" +msgid "A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active." msgstr "" -#. HNmmm +#. isrYW #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id671598619892378\n" +"par_id441598458459145\n" "help.text" -msgid "Add a new line at the end of a multiline text field. A newline character will be inserted when appropriate. The method returns True when successful." +msgid "The Page property of a control defines the page of the dialog on which the control is visible." msgstr "" -#. D29nu +#. Cj3Kq #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id941598619892915\n" +"par_id161598458580581\n" "help.text" -msgid "An error is raised if the actual control is not of the type TextField or is not multiline." +msgid "Yes" msgstr "" -#. jmBh7 +#. 6EFh7 #: sf_dialogcontrol.xhp msgctxt "" "sf_dialogcontrol.xhp\n" -"par_id1001584541257789\n" +"par_id921598458580608\n" "help.text" -msgid "Line: The string to insert. Default is an empty line." +msgid "Dialog
service" msgstr "" -#. opNus -#: sf_dictionary.xhp +#. SDCx4 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"tit\n" +"sf_dialogcontrol.xhp\n" +"par_id181598539807426\n" "help.text" -msgid "ScriptForge.Dictionary service" +msgid "All" msgstr "" -#. RJbvj -#: sf_dictionary.xhp +#. sqEuV +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"hd_id731582733781114\n" +"sf_dialogcontrol.xhp\n" +"par_id801598458580456\n" "help.text" -msgid "ScriptForge.Dictionary service" +msgid "The parent SFDialogs.Dialog class object instance." msgstr "" -#. LJG3Z -#: sf_dictionary.xhp +#. GTGu9 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id891582884466217\n" +"sf_dialogcontrol.xhp\n" +"par_id971598458773352\n" "help.text" -msgid "A dictionary is a collection of key-item pairs" +msgid "No" msgstr "" -#. fZDre -#: sf_dictionary.xhp +#. LP96H +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id861582884516571\n" +"sf_dialogcontrol.xhp\n" +"par_id451598458773588\n" "help.text" -msgid "The key is a case-insensitive string" +msgid "Specifies the file name containing a bitmap or other type of graphic to be displayed on the specified control. The filename must comply with the FileNaming attribute of the ScriptForge.FileSystem service." msgstr "" -#. 2AdDG -#: sf_dictionary.xhp +#. LZLsc +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id531582884549542\n" +"sf_dialogcontrol.xhp\n" +"par_id831612700624650\n" "help.text" -msgid "Items may be of any type" +msgid "Yes" msgstr "" -#. Bqyf3 -#: sf_dictionary.xhp +#. QxAW9 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id891582884593057\n" +"sf_dialogcontrol.xhp\n" +"par_id711612700624483\n" "help.text" -msgid "Keys and items can be retrieved, counted, updated, and much more." +msgid "UNO
object" msgstr "" -#. LtaTT -#: sf_dictionary.xhp +#. m4uz7 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id971582884636922\n" +"sf_dialogcontrol.xhp\n" +"par_id11612700624514\n" "help.text" -msgid "The Dictionary service is similar to the built-in %PRODUCTNAME Basic Collection object, however with more features. For example, Collection objects do not support the retrieval of keys. Moreover, Dictionaries provide additional capabilities as replacing keys, testing if a specific key already exists and converting the Dictionary into an Array object or JSON string." +msgid "An object representing the lowest root node (usually there is only one such root node). Refer to XmutableTreeNode in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. RkMHR -#: sf_dictionary.xhp +#. PqsSY +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"hd_id581582885621841\n" +"sf_dialogcontrol.xhp\n" +"par_id401598516577225\n" "help.text" -msgid "Service invocation" +msgid "No" msgstr "" -#. Qp3A4 -#: sf_dictionary.xhp +#. AciNr +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id821610388789467\n" +"sf_dialogcontrol.xhp\n" +"par_id311598516577712\n" "help.text" -msgid "The following example creates myDict as an empty dictionary." +msgid "Specifies the data contained in a combobox or a listbox." msgstr "" -#. BghTS -#: sf_dictionary.xhp +#. PmMEu +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id71158288562139\n" +"sf_dialogcontrol.xhp\n" +"par_id781598516674550\n" "help.text" -msgid "It is recommended to free resources after use:" +msgid "Yes" msgstr "" -#. gpGvc -#: sf_dictionary.xhp +#. PEFC6 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id551626869252987\n" +"sf_dialogcontrol.xhp\n" +"par_id11159815676440\n" "help.text" -msgid "The example below creates an empty instance of the Dictionary service and uses the Python native update method to populate it with the contents of a Python dict object." +msgid "The TabIndex property specifies a control's place in the tab order in the dialog." msgstr "" -#. bnDdK -#: sf_dictionary.xhp +#. q532w +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"pyc_id61626869417128\n" +"sf_dialogcontrol.xhp\n" +"par_id781598516764550\n" "help.text" -msgid "# Initialize myDict as an empty dict object" +msgid "Yes" msgstr "" -#. Zijqj -#: sf_dictionary.xhp +#. 4h8VF +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"pyc_id921626869402748\n" +"sf_dialogcontrol.xhp\n" +"par_id11159851676440\n" "help.text" -msgid "# Load the values of dico into myDict" +msgid "Gives access to the text being displayed by the control." msgstr "" -#. G4WCE -#: sf_dictionary.xhp +#. We5gv +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id981626869718081\n" +"sf_dialogcontrol.xhp\n" +"par_id411598517275112\n" "help.text" -msgid "It is possible to create an instance of the Dictionary service using a Python dict object as argument as shown in the following example." +msgid "No" msgstr "" -#. ymvAC -#: sf_dictionary.xhp +#. EijF2 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"pyc_id201626869185236\n" +"sf_dialogcontrol.xhp\n" +"par_id171598539985022\n" "help.text" -msgid "# Initialize myDict with the content of dico" +msgid "All" msgstr "" -#. UHQFC -#: sf_dictionary.xhp +#. CbBZJ +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id211626699007613\n" +"sf_dialogcontrol.xhp\n" +"par_id651598517275384\n" "help.text" -msgid "Because Python has built-in dictionary support, most of the methods in the Dictionary service are available for Basic scripts only. Exceptions are ConvertToPropertyValues and ImportFromPropertyValues that are supported in both Basic and Python." +msgid "Specifies the text that appears as a tooltip when you hold the mouse pointer over the control." msgstr "" -#. Dd4Pp -#: sf_dictionary.xhp +#. kVtki +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"hd_id351582885195476\n" +"sf_dialogcontrol.xhp\n" +"par_id821598517418463\n" "help.text" -msgid "Properties" +msgid "No" msgstr "" -#. hYF2s -#: sf_dictionary.xhp +#. ZemBe +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id41582885195836\n" +"sf_dialogcontrol.xhp\n" +"par_id141598517418822\n" "help.text" -msgid "Name" +msgid "Specifies if the checkbox control may appear dimmed (grayed) or not." msgstr "" -#. EgAoj -#: sf_dictionary.xhp +#. rZGBG +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id31582885195372\n" +"sf_dialogcontrol.xhp\n" +"par_id701598517671337\n" "help.text" -msgid "Read-only" +msgid "No" msgstr "" -#. pHem5 -#: sf_dictionary.xhp +#. MmMXv +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id31582885195238\n" +"sf_dialogcontrol.xhp\n" +"par_id1001598540024252\n" "help.text" -msgid "Type" +msgid "The URL to open when the control is clicked." msgstr "" -#. NnCGT -#: sf_dictionary.xhp +#. BDWA7 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id931582885195131\n" +"sf_dialogcontrol.xhp\n" +"par_id701598517671373\n" "help.text" -msgid "Description" +msgid "No" msgstr "" -#. B8ZfD -#: sf_dictionary.xhp +#. GYx9T +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id221582885195686\n" +"sf_dialogcontrol.xhp\n" +"par_id1001598540024225\n" "help.text" -msgid "Yes" +msgid "Refer to Value property" msgstr "" -#. JnMbF -#: sf_dictionary.xhp +#. PqKgo +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id881582885195976\n" +"sf_dialogcontrol.xhp\n" +"par_id661598517730941\n" "help.text" -msgid "The number of entries in the dictionary" +msgid "No" msgstr "" -#. TZ37p -#: sf_dictionary.xhp +#. 8r3sG +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id441582886030118\n" +"sf_dialogcontrol.xhp\n" +"par_id761598540042290\n" "help.text" -msgid "Yes" +msgid "All" msgstr "" -#. G6fcd -#: sf_dictionary.xhp +#. xLL83 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id131582886030297\n" +"sf_dialogcontrol.xhp\n" +"par_id881598517730836\n" "help.text" -msgid "Array of Variants" +msgid "Specifies if the control is hidden or visible." msgstr "" -#. EykBP -#: sf_dictionary.xhp +#. Xw6X9 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id471582886030489\n" +"sf_dialogcontrol.xhp\n" +"par_id451598177924437\n" "help.text" -msgid "The list of items as a one dimensional array" +msgid "Yes" msgstr "" -#. HTnKu -#: sf_dictionary.xhp +#. dBNCA +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id971582886791838\n" +"sf_dialogcontrol.xhp\n" +"par_id94159817792441\n" "help.text" -msgid "Yes" +msgid "UNO
object" msgstr "" -#. mXmC9 -#: sf_dictionary.xhp +#. gbjHB +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id271582886791111\n" +"sf_dialogcontrol.xhp\n" +"par_id311598540066789\n" "help.text" -msgid "Array of Strings" +msgid "All" msgstr "" -#. MxjyM -#: sf_dictionary.xhp +#. Erxx8 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id16158288679167\n" +"sf_dialogcontrol.xhp\n" +"par_id191598177924897\n" "help.text" -msgid "The list of keys as a one dimensional array" +msgid "The UNO object representing the control model. Refer to XControlModel and UnoControlDialogModel in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. EvjDj -#: sf_dictionary.xhp +#. xfhaP +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id461582886731495\n" +"sf_dialogcontrol.xhp\n" +"par_id811598178083501\n" "help.text" -msgid "The Keys and Items properties return their respective contents, using an identical ordering. The order is unrelated to the creation sequence." +msgid "Yes" msgstr "" -#. suQ9E -#: sf_dictionary.xhp +#. o2H9W +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id931610389113917\n" +"sf_dialogcontrol.xhp\n" +"par_id981598178083938\n" "help.text" -msgid "The following example uses the Keys property to iterate over all keys in the dictionary myDict." +msgid "UNO
object" msgstr "" -#. SrKFe -#: sf_dictionary.xhp +#. rrwm6 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id891611613601554\n" +"sf_dialogcontrol.xhp\n" +"par_id551598540079329\n" "help.text" -msgid "List of Methods in the Dictionary Service" +msgid "All" msgstr "" -#. PqSBg -#: sf_dictionary.xhp +#. TCTcr +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id831582887670029\n" +"sf_dialogcontrol.xhp\n" +"par_id731598178083442\n" "help.text" -msgid "Adds a new key-item pair into the dictionary. Returns True if successful." +msgid "The UNO object representing the control view. Refer to XControl and UnoControlDialog in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. 4zw8b -#: sf_dictionary.xhp +#. SAkJX +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id341582887670030\n" +"sf_dialogcontrol.xhp\n" +"par_id741612699446459\n" "help.text" -msgid "key: String value used to identify the Item. The key is not case-sensitive." +msgid "Yes" msgstr "" -#. UFFFG -#: sf_dictionary.xhp +#. yuAdF +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id401582887670030\n" +"sf_dialogcontrol.xhp\n" +"par_id311612699446893\n" "help.text" -msgid "item: Any value, including an array, a Basic object, a UNO object, a dictionary, etc." +msgid "UNO
object" msgstr "" -#. aNDWv -#: sf_dictionary.xhp +#. s7nM8 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id1001610391308765\n" +"sf_dialogcontrol.xhp\n" +"par_id691612699446892\n" "help.text" -msgid "Every key must be unique in the same dictionary. If the key already exists in the dictionary, a DUPLICATEKEYERROR will be raised. Keys that are made of space characters will raise a INVALIDKEYERROR error." +msgid "The UNO object representing the tree control data model. Refer to XMutableTreeDataModel in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. FDWkm -#: sf_dictionary.xhp +#. VLPsS +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id81582888424104\n" +"sf_dialogcontrol.xhp\n" +"hd_ValueProperty\n" "help.text" -msgid "Stores the contents of the dictionary in a two-columns zero-based array. The keys are stored in the first column and the items are stored in the second column." +msgid "The Value property" msgstr "" -#. FdwcF -#: sf_dictionary.xhp +#. JHK7w +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id341610391565678\n" +"sf_dialogcontrol.xhp\n" +"par_id10159854325492\n" "help.text" -msgid "If the dictionary is empty, this method will return an empty Array." +msgid "Control type" msgstr "" -#. rAA3u -#: sf_dictionary.xhp +#. 33wWa +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id831601296836981\n" +"sf_dialogcontrol.xhp\n" +"par_id741598543254158\n" "help.text" -msgid "Converts the contents of a dictionary to JSON (JavaScript Object Notation) text." +msgid "Type" msgstr "" -#. nAZ9s -#: sf_dictionary.xhp +#. QLVMB +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"hd_id261601297024828\n" +"sf_dialogcontrol.xhp\n" +"par_id961598543254444\n" "help.text" -msgid "Limitations" +msgid "Description" msgstr "" -#. DDmVt -#: sf_dictionary.xhp +#. jEyx9 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id401601297178073\n" +"sf_dialogcontrol.xhp\n" +"par_id741598543254108\n" "help.text" -msgid "This method supports the following data types: String, Boolean, numbers, Null and Empty. Arrays containing items of those types are also allowed, whatever their dimensions. Dates are converted into strings, however they cannot be used inside Arrays. Other data types are converted to their string representation using the SF_String.Represent service." +msgid "For toggle buttons only" msgstr "" -#. stuTQ -#: sf_dictionary.xhp +#. gCWiY +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id8816012968362\n" +"sf_dialogcontrol.xhp\n" +"par_id741598543254376\n" "help.text" -msgid "indent: When indent is a positive number or a text, JSON array elements and object members are pretty-printed with that indentation level. A negative indent value will add new lines with no indentation. The default value is an empty string \"\" which selects the most compact representation. Using a positive integer for indent indents that many spaces per level. When indent is a string, such as Chr(9) or Tab(1), the Tab character is used to indent each level." +msgid "Boolean or Integer" msgstr "" -#. sQuKi -#: sf_dictionary.xhp +#. 7GZGS +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id151582889470596\n" +"sf_dialogcontrol.xhp\n" +"par_id521598543254630\n" "help.text" -msgid "Stores the contents of the dictionary into an array of PropertyValues." +msgid "0, False: not checked
1, True: checked
2: grayed, don't know" msgstr "" -#. rTa2V -#: sf_dictionary.xhp +#. nZVA5 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id231610392665049\n" +"sf_dialogcontrol.xhp\n" +"par_id331598543254947\n" "help.text" -msgid "Each entry in the array is a com.sun.star.beans.PropertyValue. The key is stored in Name, the item is stored in Value." +msgid "The selected value. The ListIndex property is an alternate option." msgstr "" -#. 5MnFS -#: sf_dictionary.xhp +#. MWkEW +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id341610392705367\n" +"sf_dialogcontrol.xhp\n" +"par_id5159854325443\n" "help.text" -msgid "If one of the items has a type Date, it is converted to a com.sun.star.util.DateTime structure. If one of the items is an empty array, it is converted to Null. The resulting array is empty when the dictionary is empty." +msgid "Numeric" msgstr "" -#. EU4BC -#: sf_dictionary.xhp +#. kgfXR +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"bas_id531610393130289\n" +"sf_dialogcontrol.xhp\n" +"par_id971598543254757\n" "help.text" -msgid "'Adds some properties to the dictionary" +msgid "A file name formatted in accordance with the FileNaming property of the ScriptForge.FileSystem service" msgstr "" -#. dEAPF -#: sf_dictionary.xhp +#. 9NVHN +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"bas_id571610393137959\n" +"sf_dialogcontrol.xhp\n" +"par_id221598543254760\n" "help.text" -msgid "'Converts to an Array of PropertyValue objects" +msgid "String or Numeric" msgstr "" -#. XCGFp -#: sf_dictionary.xhp +#. 53Ztp +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id771626700938786\n" +"sf_dialogcontrol.xhp\n" +"par_id42159854325422\n" "help.text" -msgid "Note in the example below that a Python dictionary needs to be passed as the second argument of the CreateScriptService method." +msgid "String or array of strings" msgstr "" -#. oZEpN -#: sf_dictionary.xhp +#. 9NwJs +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id421610393306916\n" +"sf_dialogcontrol.xhp\n" +"par_id601598543254780\n" "help.text" -msgid "Many services and methods in the UNO library take in parameters represented using the PropertyValue struct, which is part of the %PRODUCTNAME API." +msgid "The selected row(s) as a scalar or as an array depending on the MultiSelect attribute" msgstr "" -#. 3afLF -#: sf_dictionary.xhp +#. tFGhf +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id841582889812916\n" +"sf_dialogcontrol.xhp\n" +"par_id461598543254909\n" "help.text" -msgid "Determines if a key exists in the dictionary." +msgid "Numeric" msgstr "" -#. RgUSD -#: sf_dictionary.xhp +#. YvPAp +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id971582889812917\n" +"sf_dialogcontrol.xhp\n" +"par_id631598543254771\n" "help.text" -msgid "key: The key to be looked up in the dictionary." +msgid "Numeric" msgstr "" -#. UAkEx -#: sf_dictionary.xhp +#. fBArb +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"bas_id811606485130666\n" +"sf_dialogcontrol.xhp\n" +"par_id91598543254766\n" "help.text" -msgid "'Adds some properties to the dictionary" +msgid "Must be within the predefined bounds" msgstr "" -#. 84fn2 -#: sf_dictionary.xhp +#. ZragT +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id791601391980978\n" +"sf_dialogcontrol.xhp\n" +"par_id851598543254624\n" "help.text" -msgid "Adds the content of a JSON (JavaScript Object Notation) string into the current dictionary. Returns True if successful." +msgid "Each button has its own name. They are linked together if their TAB positions are contiguous. If a radiobutton is set to True, the other related buttons are automatically set to False" msgstr "" -#. NtQCD -#: sf_dictionary.xhp +#. m6Uyb +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"hd_id961601392113644\n" +"sf_dialogcontrol.xhp\n" +"par_id531598543254869\n" "help.text" -msgid "Limitations" +msgid "Numeric" msgstr "" -#. dGRph -#: sf_dictionary.xhp +#. MWdGb +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id481601392181131\n" +"sf_dialogcontrol.xhp\n" +"par_id21598543254994\n" "help.text" -msgid "The JSON string may contain numbers, text, booleans, null values and arrays containing those types. It must not contain JSON objects namely sub-dictionaries." +msgid "Must be within the predefined bounds" msgstr "" -#. LyxQD -#: sf_dictionary.xhp +#. CVTcE +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id511601392205908\n" +"sf_dialogcontrol.xhp\n" +"par_id441598543254951\n" "help.text" -msgid "An attempt is made to convert text to date if the item matches one of these patterns: YYYY-MM-DD, HH:MM:SS or YYYY-MM-DD HH:MM:SS." +msgid "One-dimensional array with the data of the currently selected row." msgstr "" -#. 5cknM -#: sf_dictionary.xhp +#. a9AMF +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id69160139198061\n" +"sf_dialogcontrol.xhp\n" +"par_id441598543254738\n" "help.text" -msgid "inputstr: The string to import." +msgid "The text appearing in the field" msgstr "" -#. eCfBF -#: sf_dictionary.xhp +#. DRtmo +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id201601391980268\n" +"sf_dialogcontrol.xhp\n" +"par_id61687963745108\n" "help.text" -msgid "overwrite: When True, entries with same name may exist in the dictionary and their values are overwritten. When False (default), repeated keys will raise an error. Be aware that dictionary keys are not case-sensitive while names are case-sensitive in JSON strings." +msgid "There's no Value property for GroupBox, Hyperlink, ImageControl and TreeControl dialog controls." msgstr "" -#. aBFC5 -#: sf_dictionary.xhp +#. CABLr +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"bas_id521601393254694\n" +"sf_dialogcontrol.xhp\n" +"hd_id421612628828054\n" "help.text" -msgid "'The (sub)-dictionaries \"address\" and \"phoneNumbers\" (0) and (1) are imported as Empty values." +msgid "Event properties" msgstr "" -#. 9j5u2 -#: sf_dictionary.xhp +#. fkFAt +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id651588941968228\n" +"sf_dialogcontrol.xhp\n" +"par_id961612628879819\n" "help.text" -msgid "Inserts the contents of an array of PropertyValue objects into the current dictionary. PropertyValue Names are used as Keys in the dictionary, whereas Values contain the corresponding values. Returns True if successful." +msgid "Name" msgstr "" -#. BQybf -#: sf_dictionary.xhp +#. 2sB8F +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id751588941968522\n" -"help.text" -msgid "propertyvalues: A zero-based 1-dimensional array containing com.sun.star.beans.PropertyValue objects. This parameter may also be a single PropertyValue object not contained in an Array." +"sf_dialogcontrol.xhp\n" +"par_id401612628879819\n" +"help.text" +msgid "ReadOnly" msgstr "" -#. g5bHm -#: sf_dictionary.xhp +#. 2A2Ex +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id21588941968131\n" +"sf_dialogcontrol.xhp\n" +"par_id281612628879819\n" "help.text" -msgid "overwrite: When True, entries with same name may exist in the dictionary and their values are overwritten. When False (default), repeated keys will raise an error. Note that dictionary keys are not case-sensitive in Basic, whereas names are case-sensitive in sets of property values and in Python dictionaries." +msgid "Description as labeled in the Basic IDE" msgstr "" -#. GKtsH -#: sf_dictionary.xhp +#. rSRBQ +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id641626703615898\n" +"sf_dialogcontrol.xhp\n" +"par_id91612707166532\n" "help.text" -msgid "The examples below first create an array with two PropertyValue objects and then convert it to a dictionary." +msgid "Yes" msgstr "" -#. 3rJRP -#: sf_dictionary.xhp +#. aABgD +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id891582890366737\n" +"sf_dialogcontrol.xhp\n" +"par_id291612707166258\n" "help.text" -msgid "Retrieves an existing dictionary entry based on its key. Returns the value of the item if successful, otherwise returns Empty." +msgid "Execute action" msgstr "" -#. MV7Wq -#: sf_dictionary.xhp +#. KnFdW +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id551582890399669\n" +"sf_dialogcontrol.xhp\n" +"par_id79161270716675\n" "help.text" -msgid "key: Not case-sensitive. If it does not exist, Empty value is returned." +msgid "Yes" msgstr "" -#. rGqyT -#: sf_dictionary.xhp +#. JrRob +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id181610395933967\n" +"sf_dialogcontrol.xhp\n" +"par_id831612707166731\n" "help.text" -msgid "The following example iterates over all keys in the dictionary and uses the Item method to access their values." +msgid "While adjusting" msgstr "" -#. QJTte -#: sf_dictionary.xhp +#. mpuj3 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id891582890388737\n" +"sf_dialogcontrol.xhp\n" +"par_id111612629836630\n" "help.text" -msgid "Removes an existing dictionary entry based on its key. Returns True if successful." +msgid "Yes" msgstr "" -#. EhVL2 -#: sf_dictionary.xhp +#. 7Swj5 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id551582890366999\n" +"sf_dialogcontrol.xhp\n" +"par_id1001612629836902\n" "help.text" -msgid "key: Not case-sensitive. Must exist in the dictionary, otherwise an UNKNOWNKEYERROR error is raised." +msgid "When receiving focus" msgstr "" -#. GyK3j -#: sf_dictionary.xhp +#. Mp4i7 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id921582896275624\n" +"sf_dialogcontrol.xhp\n" +"par_id291612629836294\n" "help.text" -msgid "Removes all the entries from the dictionary. Returns True if successful." +msgid "Yes" msgstr "" -#. GSzP5 -#: sf_dictionary.xhp +#. ozGia +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id281582895615444\n" +"sf_dialogcontrol.xhp\n" +"par_id62161262983683\n" "help.text" -msgid "Replaces an existing item value based on its key. Returns True if successful." +msgid "When losing focus" msgstr "" -#. w4w9A -#: sf_dictionary.xhp +#. TR5uW +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id991582895615535\n" +"sf_dialogcontrol.xhp\n" +"par_id51612707354544\n" "help.text" -msgid "key: String value representing the key whose value will be replaced. Not case-sensitive. If the key does not exist in the dictionary, an UNKNOWNKEYERROR error is raised." +msgid "Yes" msgstr "" -#. FA4hz -#: sf_dictionary.xhp +#. HREcr +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id721582895615186\n" +"sf_dialogcontrol.xhp\n" +"par_id211612707354899\n" "help.text" -msgid "value: The new value of the item referred to with the key parameter." +msgid "Item status changed" msgstr "" -#. Y46D4 -#: sf_dictionary.xhp +#. L6e2x +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id571582896597766\n" +"sf_dialogcontrol.xhp\n" +"par_id81612629836634\n" "help.text" -msgid "Replaces an existing key in the dictionary by a new key. The item value is left unchanged. Returns True if successful." +msgid "Yes" msgstr "" -#. jKp7C -#: sf_dictionary.xhp +#. sVo6A +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id911582896597619\n" +"sf_dialogcontrol.xhp\n" +"par_id881612629836744\n" "help.text" -msgid "key: String value representing the key to be replaced. Not case-sensitive. If the key does not exist in the dictionary, a UNKNOWNKEYERROR error is raised." +msgid "Key pressed" msgstr "" -#. Dku2D -#: sf_dictionary.xhp +#. pPBHX +#: sf_dialogcontrol.xhp msgctxt "" -"sf_dictionary.xhp\n" -"par_id531582896597989\n" +"sf_dialogcontrol.xhp\n" +"par_id591612629836830\n" "help.text" -msgid "value: String value for the new key. Not case-sensitive. If the new key already exists in the dictionary, an DUPLICATEKEYERROR error is raised." +msgid "Yes" msgstr "" -#. jasej -#: sf_document.xhp +#. P6NX8 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"tit\n" +"sf_dialogcontrol.xhp\n" +"par_id161612629836775\n" "help.text" -msgid "SFDocuments.Document service" +msgid "Key released" msgstr "" -#. ypVGE -#: sf_document.xhp +#. XJGHA +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"hd_id731582733781114\n" +"sf_dialogcontrol.xhp\n" +"par_id891612629836630\n" "help.text" -msgid "SFDocuments.Document service" +msgid "Yes" msgstr "" -#. VTWbF -#: sf_document.xhp +#. oCDXm +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id381589189355849\n" +"sf_dialogcontrol.xhp\n" +"par_id461612629836679\n" "help.text" -msgid "The SFDocuments library provides methods and properties to facilitate the management and manipulation of %PRODUCTNAME documents." +msgid "Mouse moved while key presses" msgstr "" -#. urZhL -#: sf_document.xhp +#. nLbMG +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id591589189364267\n" +"sf_dialogcontrol.xhp\n" +"par_id131612629836291\n" "help.text" -msgid "Methods that are applicable for all types of documents (Text Documents, Sheets, Presentations, etc) are provided by the SFDocuments.Document service. Some examples are:" +msgid "Yes" msgstr "" -#. VgG69 -#: sf_document.xhp +#. 9XdcG +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id891589189452545\n" +"sf_dialogcontrol.xhp\n" +"par_id151612629836151\n" "help.text" -msgid "Opening, closing and saving documents" +msgid "Mouse inside" msgstr "" -#. XfHGF -#: sf_document.xhp +#. BZ7sC +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id811589189463041\n" +"sf_dialogcontrol.xhp\n" +"par_id211612629836725\n" "help.text" -msgid "Accessing standard or custom properties of documents" +msgid "Yes" msgstr "" -#. C6JgF -#: sf_document.xhp +#. mzbBD +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id301611085807704\n" +"sf_dialogcontrol.xhp\n" +"par_id361612629836624\n" "help.text" -msgid "The properties, methods or arguments marked with (*) are NOT applicable to Base documents." +msgid "Mouse outside" msgstr "" -#. rh5iz -#: sf_document.xhp +#. fAD8Y +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id241589189701274\n" +"sf_dialogcontrol.xhp\n" +"par_id311612629836481\n" "help.text" -msgid "Methods and properties that are specific to certain %PRODUCTNAME components are stored in separate services, such as SFDocuments.SF_Calc and SFDocuments.SF_Base." +msgid "Yes" msgstr "" -#. Fdi8i -#: sf_document.xhp +#. FCBxu +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id641611090052376\n" +"sf_dialogcontrol.xhp\n" +"par_id721612629836752\n" "help.text" -msgid "Although the Basic language does not offer inheritance between object classes, the latter services may be considered as subclasses of the SFDocuments.Document service. Such subclasses can invoke the properties and methods described below." +msgid "Mouse moved" msgstr "" -#. YMWaA -#: sf_document.xhp +#. 4DCtC +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"hd_id581582885621841\n" +"sf_dialogcontrol.xhp\n" +"par_id981612629836116\n" "help.text" -msgid "Service invocation" +msgid "Yes" msgstr "" -#. XVADJ -#: sf_document.xhp +#. 8B9ct +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141609955500101\n" +"sf_dialogcontrol.xhp\n" +"par_id381612629836635\n" "help.text" -msgid "Before using the Document service the ScriptForge library needs to be loaded or imported:" +msgid "Mouse button pressed" msgstr "" -#. X6BV3 -#: sf_document.xhp +#. krueU +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id581611090387382\n" +"sf_dialogcontrol.xhp\n" +"par_id711612629836704\n" "help.text" -msgid "Below are three variants of how the Document service can be invoked." +msgid "Yes" msgstr "" -#. o39cT -#: sf_document.xhp +#. 4c5qE +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id181622816732197\n" +"sf_dialogcontrol.xhp\n" +"par_id35161262983642\n" "help.text" -msgid "Using the getDocument method from the ScriptForge.UI service:" +msgid "Mouse button released" msgstr "" -#. 6AZF9 -#: sf_document.xhp +#. FkyLb +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id181622818236233\n" +"sf_dialogcontrol.xhp\n" +"par_id851612707606863\n" "help.text" -msgid "Alternatively you can use the methods CreateDocument and OpenDocument from the UI service." +msgid "No" msgstr "" -#. uwA2W -#: sf_document.xhp +#. VudpK +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id691622816765571\n" +"sf_dialogcontrol.xhp\n" +"par_id351612707606197\n" "help.text" -msgid "Using a window name if the document is already open." +msgid "(Not in Basic IDE) when the expansion button is pressed on a node in a tree control" msgstr "" -#. yRfyT -#: sf_document.xhp +#. TkEgQ +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id551658777771853\n" +"sf_dialogcontrol.xhp\n" +"par_id121612707606251\n" "help.text" -msgid "Using the document referenced by ThisComponent. This is specially useful when running a macro from within the Basic IDE." +msgid "No" msgstr "" -#. yFDEW -#: sf_document.xhp +#. quWBQ +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id821622816825012\n" +"sf_dialogcontrol.xhp\n" +"par_id881612707606121\n" "help.text" -msgid "From a macro triggered by a document event." +msgid "(Not in Basic IDE) when a node in a tree control is selected" msgstr "" -#. FxfW2 -#: sf_document.xhp +#. qyb3B +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id831622816562430\n" +"sf_dialogcontrol.xhp\n" +"par_id811612707606330\n" "help.text" -msgid "The Document service is closely related to the UI and FileSystem services." +msgid "Yes" msgstr "" -#. QF9FG -#: sf_document.xhp +#. th6Kr +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id891582733781994\n" +"sf_dialogcontrol.xhp\n" +"par_id621612707606219\n" "help.text" -msgid "Except when the document was closed by program with the CloseDocument method (it is then superfluous), it is recommended to free resources after use:" +msgid "Text modified" msgstr "" -#. LyvNw -#: sf_document.xhp +#. YFbGT +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id71611090922315\n" +"sf_dialogcontrol.xhp\n" +"hd_id421583670049913\n" "help.text" -msgid "The use of the prefix \"SFDocuments.\" while calling the service is optional." +msgid "Methods" msgstr "" -#. z3oxC -#: sf_document.xhp +#. xNrc5 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"hd_id351582885195476\n" +"sf_dialogcontrol.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "Properties" +msgid "List of Methods in the DialogControl Service" msgstr "" -#. 6NTY6 -#: sf_document.xhp +#. uHbTG +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id41582885195836\n" +"sf_dialogcontrol.xhp\n" +"par_id831612711823126\n" "help.text" -msgid "Name" +msgid "Create and return a new node of the tree control as a UNO object subordinate to a parent node. Refer to XMutableTreeNode in Application Programming Interface (API) documentation for detailed information." msgstr "" -#. wUbi9 -#: sf_document.xhp +#. MrQnS +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id31582885195372\n" +"sf_dialogcontrol.xhp\n" +"par_id741612711823706\n" "help.text" -msgid "Readonly" +msgid "This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event - using the OnNodeExpanded event - to complete the tree dynamically." msgstr "" -#. NfJEr -#: sf_document.xhp +#. T8xdA +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id31582885195238\n" +"sf_dialogcontrol.xhp\n" +"par_id761612711823834\n" "help.text" -msgid "Type" +msgid "parentnode: A node UNO object, of type com.sun.star.awt.tree.XMutableTreeNode." msgstr "" -#. QZzvi -#: sf_document.xhp +#. qJ9ej +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id931582885195131\n" +"sf_dialogcontrol.xhp\n" +"par_id791612711823819\n" "help.text" -msgid "Description" +msgid "displayvalue: The text appearing in the tree control box." msgstr "" -#. wBpru -#: sf_document.xhp +#. Pzz72 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id861582885655779\n" +"sf_dialogcontrol.xhp\n" +"par_id911612711823382\n" "help.text" -msgid "No" +msgid "datavalue: Any value associated with the new node. datavalue may be a string, a number or a date. Omit the argument when not applicable." msgstr "" -#. ENrbA -#: sf_document.xhp +#. 2pLPL +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id581582885655885\n" +"sf_dialogcontrol.xhp\n" +"par_id901620317110685\n" "help.text" -msgid "Returns a ScriptForge.Dictionary object instance. After update, can be passed again to the property for updating the document.
Individual items of the dictionary may be either strings, numbers, (Basic) dates or com.sun.star.util.Duration items." +msgid "%PRODUCTNAME Basic and Python examples pick up current document's myDialog dialog from Standard library." msgstr "" -#. DktDb -#: sf_document.xhp +#. 8B3qP +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id441582886030118\n" +"sf_dialogcontrol.xhp\n" +"par_id221612713087885\n" "help.text" -msgid "No" +msgid "Return True when a subtree, subordinate to a parent node, could be inserted successfully in a tree control. If the parent node had already child nodes before calling this method, the child nodes are erased." msgstr "" -#. DNFGz -#: sf_document.xhp +#. beond +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id471582886030489\n" +"sf_dialogcontrol.xhp\n" +"par_id781612713087722\n" "help.text" -msgid "Gives access to the Description property of the document (also known as \"Comments\")" +msgid "parentnode: A node UNO object, of type com.sun.star.awt.tree.XMutableTreeNode." msgstr "" -#. wMzx8 -#: sf_document.xhp +#. QJ73V +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id971582886791838\n" +"sf_dialogcontrol.xhp\n" +"par_id36161271308759\n" "help.text" -msgid "Yes" +msgid "flattree: a two dimension array sorted on the columns containing the display values. Such an array can be issued by the GetRows method applied on the SFDatabases.Database service. When an array item containing the text to be displayed is Empty or Null, no new subnode is created and the remainder of the row is skipped." msgstr "" -#. Mm6E5 -#: sf_document.xhp +#. r5QNj +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id16158288679167\n" +"sf_dialogcontrol.xhp\n" +"bas_id61612716027443\n" "help.text" -msgid "Returns a ScriptForge.Dictionary object containing all the entries. Document statistics are included. Note that they are specific to the type of document. As an example, a Calc document includes a \"CellCount\" entry. Other documents do not." +msgid "Flat tree >>>> Resulting subtree" msgstr "" -#. Ew7vi -#: sf_document.xhp +#. MUi8U +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id201589194571955\n" +"sf_dialogcontrol.xhp\n" +"par_id51612713087915\n" "help.text" -msgid "Yes" +msgid "withdatavalue: When False default value is used, every column of flattree contains the text to be displayed in the tree control. When True, the texts to be displayed (displayvalue) are in columns 0, 2, 4, ... while the data values (datavalue) are in columns 1, 3, 5, ..." msgstr "" -#. Aw2Tv -#: sf_document.xhp +#. fWnhZ +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id941589194571801\n" +"sf_dialogcontrol.xhp\n" +"par_id151612780723320\n" "help.text" -msgid "String value with the document type (\"Base\", \"Calc\", \"Writer\", etc)" +msgid "Returns a new root node of the tree control, as a node UNO object of type com.sun.star.awt.tree.XMutableTreeNode. The new tree root is inserted below pre-existing root nodes. " msgstr "" -#. UcEJi -#: sf_document.xhp +#. YT845 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id201589194571699\n" +"sf_dialogcontrol.xhp\n" +"par_id821612780723965\n" "help.text" -msgid "Yes" +msgid "This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event to complete the tree dynamically." msgstr "" -#. EZzPF -#: sf_document.xhp +#. JXyjD +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id941589194571327\n" +"sf_dialogcontrol.xhp\n" +"par_id791612117823819\n" "help.text" -msgid "Returns a list with the export filter names applicable to the current document as a zero-based array of strings. Filters used for both import/export are also returned." +msgid "displayvalue: The text appearing in the tree control box." msgstr "" -#. jndk4 -#: sf_document.xhp +#. XxGFd +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id201589194571306\n" +"sf_dialogcontrol.xhp\n" +"par_id171612781589503\n" "help.text" -msgid "Yes" +msgid "Traverses the tree and finds recursively, starting from the root, a node meeting some criteria. Either - 1 match is enough - having its display value matching displayvalue pattern or having its data value equal to datavalue. The comparisons may be or not case-sensitive. The first matching occurrence is returned as a node UNO object of type com.sun.star.awt.tree.XMutableTreeNode. " msgstr "" -#. KsJ8e -#: sf_document.xhp +#. 5Jxkj +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id941589194571044\n" -"help.text" -msgid "Returns a string with the URL path to the root of the virtual file system of the document. Use the FileSystem service to view its contents, as well as to create, open and read files stored in it." +"sf_dialogcontrol.xhp\n" +"par_id741612782475457\n" +"help.text" +msgid "When not found, the method returns Nothing, to be tested with the IsNull() builtin function." msgstr "" -#. kmW9L -#: sf_document.xhp +#. n7pE8 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id941589194576584\n" +"sf_dialogcontrol.xhp\n" +"par_id41612781589363\n" "help.text" -msgid "Refer to this help page to learn more on how to access and manipulate folders and files in the virtual file system of a %PRODUCTNAME file." +msgid "This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event." msgstr "" -#. 7vqDq -#: sf_document.xhp +#. Dd4Ti +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id201589194571067\n" +"sf_dialogcontrol.xhp\n" +"par_id541613670199211\n" "help.text" -msgid "Yes" +msgid "One argument out of displayvalue or datavalue must be specified. If both present, one match is sufficient to select the node." msgstr "" -#. UmCHS -#: sf_document.xhp +#. 4xxwd +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id941589194571922\n" +"sf_dialogcontrol.xhp\n" +"par_id591612781589560\n" "help.text" -msgid "Returns a list with the import filter names applicable to the current document as a zero-based array of strings. Filters used for both import/export are also returned." +msgid "displayvalue: The pattern to be matched. Refer to SF_String.IsLike() method for the list of possible wildcards. When equal to the zero-length string (default), this display value is not searched for." msgstr "" -#. Yo8T4 -#: sf_document.xhp +#. BE58W +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id761589194633950\n" +"sf_dialogcontrol.xhp\n" +"par_id141582384726168\n" "help.text" -msgid "Yes" +msgid "casesensitive: Default value is False" msgstr "" -#. pSbRu -#: sf_document.xhp +#. tCfF4 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id611589194633853\n" +"sf_dialogcontrol.xhp\n" +"par_id871583933076484\n" "help.text" -msgid "Exactly one of these properties is True for a given document." +msgid "Move the top-left corner of a dialog control to new coordinates and/or modify its dimensions. Return True if resizing was successful." msgstr "" -#. oKQWB -#: sf_document.xhp +#. pzYAg +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id231589194910179\n" +"sf_dialogcontrol.xhp\n" +"par_id351687783159237\n" "help.text" -msgid "No" +msgid "All distances are expressed in Map AppFont units and are measured from the top-left corner of the parent dialog. Without arguments the method resizes the control to its \"preferred size\", a size adjusted depending on its actual content. Missing arguments are left unchanged." msgstr "" -#. CDTBC -#: sf_document.xhp +#. 7RcPA +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id311589194910190\n" +"sf_dialogcontrol.xhp\n" +"par_id911687783094143\n" "help.text" -msgid "Gives access to the Keywords property of the document. Represented as a comma-separated list of keywords" +msgid "Left: The horizontal distance from the top-left corner" msgstr "" -#. EHM84 -#: sf_document.xhp +#. n6cEo +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id921589638614972\n" +"sf_dialogcontrol.xhp\n" +"par_id251687783287236\n" "help.text" -msgid "Yes" +msgid "Top: The vertical distance from the top-left corner" msgstr "" -#. JGTQz -#: sf_document.xhp +#. EpNL7 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id801589638614518\n" +"sf_dialogcontrol.xhp\n" +"par_id291687783328508\n" "help.text" -msgid "True if the document is actually in read-only mode" +msgid "Width: the horizontal width of the rectangle containing the control" msgstr "" -#. zK55N -#: sf_document.xhp +#. RMsh8 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id201589195028733\n" +"sf_dialogcontrol.xhp\n" +"par_id901687783339292\n" "help.text" -msgid "No" +msgid "Height: the vertical height of the rectangle containing the control" msgstr "" -#. 99ZxC -#: sf_document.xhp +#. k6MEJ +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id371589195028843\n" +"sf_dialogcontrol.xhp\n" +"bas_id361598179153096\n" "help.text" -msgid "Gives access to the Subject property of the document." +msgid "oControl.Resize(100, 200, Height:=6000) ' Width is unchanged" msgstr "" -#. dH6ct -#: sf_document.xhp +#. Cay6f +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id451589195028910\n" +"sf_dialogcontrol.xhp\n" +"pyc_id821620319176082\n" "help.text" -msgid "No" +msgid "ctrl.Resize(300, 200, 1500) # Height is unchanged" msgstr "" -#. TCiBh -#: sf_document.xhp +#. 3oU3L +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id771589195028748\n" +"sf_dialogcontrol.xhp\n" +"par_id871583933076448\n" "help.text" -msgid "Gives access to the Title property of the document." +msgid "Set the focus on the control. Return True if focusing was successful." msgstr "" -#. SwDBh -#: sf_document.xhp +#. 6YvuU +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id221582885195686\n" +"sf_dialogcontrol.xhp\n" +"par_id151598178880227\n" "help.text" -msgid "Yes" +msgid "This method is often called from a dialog or control event." msgstr "" -#. PRmJE -#: sf_document.xhp +#. it2QN +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id371582885195525\n" +"sf_dialogcontrol.xhp\n" +"par_id541638553960464\n" "help.text" -msgid "UNO Object" +msgid "Fills a TableControl with the given data. All preexisting data is cleared before inserting the new data passed as argument." msgstr "" -#. BprB8 -#: sf_document.xhp +#. Vmmag +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id881582885195976\n" +"sf_dialogcontrol.xhp\n" +"par_id551638554058131\n" "help.text" -msgid "The UNO object com.sun.star.lang.XComponent or com.sun.star.comp.dba.ODatabaseDocument representing the document" +msgid "When the TableControl is added to the dialog, it is possible to use the Basic IDE to define whether column and row headers will be shown in the table. If the TableControl has column and/or row headers, the first column and/or row in the provided data array are used as labels for the table headers." msgstr "" -#. coFyk -#: sf_document.xhp +#. qn4UN +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id861611146581334\n" +"sf_dialogcontrol.xhp\n" +"par_id411638569396108\n" "help.text" -msgid "The example below prints all the properties of a document. Note that the oDoc object returned by the UI.OpenDocument method is a SFDocuments.Document object." +msgid "This method returns True when successful." msgstr "" -#. eqL5J -#: sf_document.xhp +#. LESVB +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id571622826920742\n" +"sf_dialogcontrol.xhp\n" +"par_id1001584541257133\n" "help.text" -msgid "To access document properties in a Python script the user needs to directly access them using their names, as shown below:" +msgid "dataarray: Data to be entered into the table represented as an Array of Arrays in Basic or a tuple of tuples in Python. The data must include column and row headers if they are to be displayed by the TableControl." msgstr "" -#. wmiy9 -#: sf_document.xhp +#. zGc73 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id651606319520519\n" +"sf_dialogcontrol.xhp\n" +"par_id1001584541257025\n" "help.text" -msgid "List of Methods in the Document Service" +msgid "widths: Array containing the relative widths of each column. In other words, widths = (1, 2) means that the second column is twice as wide as the first one. If the number of values in the array is smaller than the number of columns in the table, then the last value in the array is used to define the width of the remaining columns." msgstr "" -#. UVWQb -#: sf_document.xhp +#. AEGq3 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id93158919969864\n" +"sf_dialogcontrol.xhp\n" +"par_id1001584541257007\n" "help.text" -msgid "Returns True if the document could be activated. Otherwise, there is no change in the actual user interface. It is equivalent to the Activate method of the UI service." +msgid "alignments: Defines the alignment in each column as a string in which each character can be \"L\" (Left), \"C\" (Center), \"R\" (Right) or \" \" (whitespace, default, meaning left for strings and right for numeric values). If the length of the string is shorter than the number of columns in the table, then the last character in the string is used to define the alignment of the remaining columns." msgstr "" -#. qcuXA -#: sf_document.xhp +#. i3UBY +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id421611148353046\n" +"sf_dialogcontrol.xhp\n" +"par_id551688397846388\n" "help.text" -msgid "This method is useful when one needs to give focus for a document that is minimized or hidden." +msgid "RowHeaderWidth: width of the row header column expressed in Map AppFont units. Default = 10. The argument is ignored when the TableControl has no row header." msgstr "" -#. vFzrg -#: sf_document.xhp +#. CK6RC +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id601611148017930\n" +"sf_dialogcontrol.xhp\n" +"par_id381638569172413\n" "help.text" -msgid "The example below considers that the file \"My_File.ods\" is already open but not active." +msgid "The following example assumes that the dialog myDialog has a TableControl named Grid1 with \"Show row header\" and \"Show column header\" properties set to \"Yes\"." msgstr "" -#. zGRcs -#: sf_document.xhp +#. N9Byz +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id601611148080503\n" +"sf_dialogcontrol.xhp\n" +"par_id171638650502346\n" "help.text" -msgid "Keep in mind that you can invoke the Document service by passing to CreateScriptService either \"Document\" or \"SFDocuments.Document\"" +msgid "The Value property returns the selected row in the table. If no row is selected, an empty Array object is returned. The following code snippet shows how to test if any row is selected in the table." msgstr "" -#. rB7Ab -#: sf_document.xhp +#. C3f3k +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id651589200121138\n" +"sf_dialogcontrol.xhp\n" +"bas_id361638651540588\n" "help.text" -msgid "Closes the document. If the document is already closed, regardless of how the document was closed, this method has no effect and returns False." +msgid "MsgBox \"No row selected.\"" msgstr "" -#. 64F7E -#: sf_document.xhp +#. iQ94A +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id341611149562894\n" +"sf_dialogcontrol.xhp\n" +"bas_id781638651541028\n" "help.text" -msgid "The method will also return False if the user declines to close it." +msgid "MsgBox \"Row \" & oTable.ListIndex & \" is selected.\"" msgstr "" -#. AGBjg -#: sf_document.xhp +#. HNmmm +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id981611149616934\n" +"sf_dialogcontrol.xhp\n" +"par_id671598619892378\n" "help.text" -msgid "Returns True if the document was successfully closed." +msgid "Add a new line at the end of a multiline text field. A newline character will be inserted when appropriate. The method returns True when successful." msgstr "" -#. Wt7L9 -#: sf_document.xhp +#. D29nu +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id361589200121646\n" +"sf_dialogcontrol.xhp\n" +"par_id941598619892915\n" "help.text" -msgid "saveask : If True (default), the user is invited to confirm if the changes should be written on disk. This argument is ignored if the document was not modified." +msgid "An error is raised if the actual control is not of the type TextField or is not multiline." msgstr "" -#. RhAbC -#: sf_document.xhp +#. jmBh7 +#: sf_dialogcontrol.xhp msgctxt "" -"sf_document.xhp\n" -"par_id651589200121080\n" +"sf_dialogcontrol.xhp\n" +"par_id1001584541257789\n" "help.text" -msgid "Creates a new menu entry in the menubar of a given document window." +msgid "Line: The string to insert. Default is an empty line." msgstr "" -#. Cfyw4 -#: sf_document.xhp +#. opNus +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id981611149616155\n" +"sf_dictionary.xhp\n" +"tit\n" "help.text" -msgid "This method returns an instance of the SFWidgets.Menu service." +msgid "ScriptForge.Dictionary service" msgstr "" -#. GKeq5 -#: sf_document.xhp +#. RJbvj +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id721643121487974\n" +"sf_dictionary.xhp\n" +"hd_id731582733781114\n" "help.text" -msgid "The menu created is only available during the current %PRODUCTNAME session and is not saved neither in the document nor in the global application settings. Hence closing the document window will make the menu disappear. It will only reappear when the macro that creates the menu is executed again." +msgid "ScriptForge.Dictionary service" msgstr "" -#. szVYB -#: sf_document.xhp +#. LJG3Z +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id361589200120316\n" +"sf_dictionary.xhp\n" +"par_id891582884466217\n" "help.text" -msgid "menuheader: The toplevel name of the new menu." +msgid "A dictionary is a collection of key-item pairs" msgstr "" -#. iCSZE -#: sf_document.xhp +#. fZDre +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id361589200129686\n" +"sf_dictionary.xhp\n" +"par_id861582884516571\n" "help.text" -msgid "before: The name (as a string) or position (as an integer starting at 1) of an existing menu before which the new menu will be placed. If no value is defined for this argument, the menu will be created at the last position in the menubar." +msgid "The key is a case-insensitive string" msgstr "" -#. LX4b9 -#: sf_document.xhp +#. 2AdDG +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id361589200122507\n" +"sf_dictionary.xhp\n" +"par_id531582884549542\n" "help.text" -msgid "submenuchar: The delimiter used to create menu trees when calling methods as AddItem from the Menu service. The default value is \">\"." +msgid "Items may be of any type" msgstr "" -#. FhwFZ -#: sf_document.xhp +#. Bqyf3 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id751622827903865\n" +"sf_dictionary.xhp\n" +"par_id891582884593057\n" "help.text" -msgid "Set oMenu = oDoc.CreateMenu(\"My Menu\")" +msgid "Keys and items can be retrieved, counted, updated, and much more." msgstr "" -#. iDefE -#: sf_document.xhp +#. LtaTT +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id391643120224507\n" +"sf_dictionary.xhp\n" +"par_id971582884636922\n" "help.text" -msgid "' Add items to the menu" +msgid "The Dictionary service is similar to the built-in %PRODUCTNAME Basic Collection object, however with more features. For example, Collection objects do not support the retrieval of keys. Moreover, Dictionaries provide additional capabilities as replacing keys, testing if a specific key already exists and converting the Dictionary into an Array object or JSON string." msgstr "" -#. t4cXb -#: sf_document.xhp +#. RkMHR +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id100164312025160\n" +"sf_dictionary.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "' After creating the menu, the service instance can be disposed of" +msgid "Service invocation" msgstr "" -#. WuNHU -#: sf_document.xhp +#. Qp3A4 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"pyc_id221622827943208\n" +"sf_dictionary.xhp\n" +"par_id821610388789467\n" "help.text" -msgid "menu = doc.CreateMenu(\"My Menu\")" +msgid "The following example creates myDict as an empty dictionary." msgstr "" -#. 5D4rC -#: sf_document.xhp +#. BghTS +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id271643139068194\n" +"sf_dictionary.xhp\n" +"par_id71158288562139\n" "help.text" -msgid "Refer to the SFWidgets.Menu help page to learn more about how to create/remove menus in %PRODUCTNAME document windows." +msgid "It is recommended to free resources after use:" msgstr "" -#. v8axk -#: sf_document.xhp +#. gpGvc +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id156589200192258\n" +"sf_dictionary.xhp\n" +"par_id551626869252987\n" "help.text" -msgid "Suspends user interface (UI) updates during the execution of a macro. Optionally, the mouse pointer can be changed into an hourglass while UI updates are suspended." +msgid "The example below creates an empty instance of the Dictionary service and uses the Python native update method to populate it with the contents of a Python dict object." msgstr "" -#. gAwTA -#: sf_document.xhp +#. bnDdK +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id851688837646904\n" +"sf_dictionary.xhp\n" +"pyc_id61626869417128\n" "help.text" -msgid "This method may provide some performance benefits for macros that perform numerous operations that require UI updates." +msgid "# Initialize myDict as an empty dict object" msgstr "" -#. MRdkT -#: sf_document.xhp +#. Zijqj +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id211635436910325\n" +"sf_dictionary.xhp\n" +"pyc_id921626869402748\n" "help.text" -msgid "echoon: Specify False to suspend UI updates. The default value is True, which enables real time UI updates." +msgid "# Load the values of dico into myDict" msgstr "" -#. eLkJM -#: sf_document.xhp +#. G4WCE +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141635436912288\n" +"sf_dictionary.xhp\n" +"par_id981626869718081\n" "help.text" -msgid "hourglass: Specify True to change the mouse pointer to an hourglass (Default = False)." +msgid "It is possible to create an instance of the Dictionary service using a Python dict object as argument as shown in the following example." msgstr "" -#. i8X6R -#: sf_document.xhp +#. ymvAC +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id741689124521451\n" +"sf_dictionary.xhp\n" +"pyc_id201626869185236\n" "help.text" -msgid "Moving the mouse pointer after it changed to an hourglass may cause it to switch to a different pointer depending on its new background." +msgid "# Initialize myDict with the content of dico" msgstr "" -#. PVXfC -#: sf_document.xhp +#. UHQFC +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id941688837091778\n" +"sf_dictionary.xhp\n" +"par_id211626699007613\n" "help.text" -msgid "' Suspends UI updates and change mouse pointer to an hourglass" +msgid "Because Python has built-in dictionary support, most of the methods in the Dictionary service are available for Basic scripts only. Exceptions are ConvertToPropertyValues and ImportFromPropertyValues that are supported in both Basic and Python." msgstr "" -#. i5pkB -#: sf_document.xhp +#. Dd4Pp +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id561688837092732\n" +"sf_dictionary.xhp\n" +"hd_id351582885195476\n" "help.text" -msgid "' Other macro commands" +msgid "Properties" msgstr "" -#. hxDXE -#: sf_document.xhp +#. hYF2s +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id251688837093108\n" +"sf_dictionary.xhp\n" +"par_id41582885195836\n" "help.text" -msgid "' Restores UI updates and mouse pointer" +msgid "Name" msgstr "" -#. 6snES -#: sf_document.xhp +#. EgAoj +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"pyc_id691688837494400\n" +"sf_dictionary.xhp\n" +"par_id31582885195372\n" "help.text" -msgid "..." +msgid "Read-only" msgstr "" -#. CGKZA -#: sf_document.xhp +#. pHem5 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id156589200123048\n" +"sf_dictionary.xhp\n" +"par_id31582885195238\n" "help.text" -msgid "Exports the document directly as a PDF file to the specified location. Returns True if the PDF file was successfully created." +msgid "Type" msgstr "" -#. FZYmR -#: sf_document.xhp +#. NnCGT +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id811638276067119\n" +"sf_dictionary.xhp\n" +"par_id931582885195131\n" "help.text" -msgid "The export options can be set either manually using the File - Export As - Export as PDF dialog or by calling the methods GetPDFExportOptions and SetPDFExportOptions from the Session service." +msgid "Description" msgstr "" -#. SFwEd -#: sf_document.xhp +#. B8ZfD +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id211635436910641\n" +"sf_dictionary.xhp\n" +"par_id221582885195686\n" "help.text" -msgid "filename: The full path and file name of the PDF to be created. It must follow the SF_FileSystem.FileNaming notation." +msgid "Yes" msgstr "" -#. E6KyY -#: sf_document.xhp +#. JnMbF +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141635436912005\n" -"help.text" -msgid "overwrite: Specifies if the destination file can be overwritten (Default = False). An error will occur if overwrite is set to False and the destination file already exists." +"sf_dictionary.xhp\n" +"par_id881582885195976\n" +"help.text" +msgid "The number of entries in the dictionary" msgstr "" -#. d9RRn -#: sf_document.xhp +#. TZ37p +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141635436913587\n" +"sf_dictionary.xhp\n" +"par_id441582886030118\n" "help.text" -msgid "pages: String specifying which pages will be exported. This argument uses the same notation as in the dialog File - Export As - Export as PDF." +msgid "Yes" msgstr "" -#. kBDPk -#: sf_document.xhp +#. G6fcd +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141635436919655\n" +"sf_dictionary.xhp\n" +"par_id131582886030297\n" "help.text" -msgid "password: Specifies a password to open the PDF file." +msgid "Array of Variants" msgstr "" -#. joeXi -#: sf_document.xhp +#. EykBP +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141635436913365\n" +"sf_dictionary.xhp\n" +"par_id471582886030489\n" "help.text" -msgid "watermark: Text to be used as watermark in the PDF file, which will be drawn in every page of the resulting PDF." +msgid "The list of items as a one dimensional array" msgstr "" -#. NmChF -#: sf_document.xhp +#. HTnKu +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id301638234284727\n" +"sf_dictionary.xhp\n" +"par_id971582886791838\n" "help.text" -msgid "The following example exports the current document as a PDF file, defines a password and overwrites the destination file if it already exists." +msgid "Yes" msgstr "" -#. wEW7B -#: sf_document.xhp +#. mXmC9 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id311638276257020\n" +"sf_dictionary.xhp\n" +"par_id271582886791111\n" "help.text" -msgid "The code snippet below gets the current PDF export options and uses them to create the PDF file." +msgid "Array of Strings" msgstr "" -#. 7uUWr -#: sf_document.xhp +#. MxjyM +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id851638277174798\n" +"sf_dictionary.xhp\n" +"par_id16158288679167\n" "help.text" -msgid "' Sets to True the option to export comments as PDF notes" +msgid "The list of keys as a one dimensional array" msgstr "" -#. HNC9m -#: sf_document.xhp +#. EvjDj +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id156589200121138\n" +"sf_dictionary.xhp\n" +"par_id461582886731495\n" "help.text" -msgid "This method sends the contents of the document to the default printer or to the printer defined by the SetPrinter method." +msgid "The Keys and Items properties return their respective contents, using an identical ordering. The order is unrelated to the creation sequence." msgstr "" -#. CJxTR -#: sf_document.xhp +#. suQ9E +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id981611169416934\n" +"sf_dictionary.xhp\n" +"par_id931610389113917\n" "help.text" -msgid "Returns True if the document was successfully printed." +msgid "The following example uses the Keys property to iterate over all keys in the dictionary myDict." msgstr "" -#. uQMeV -#: sf_document.xhp +#. SrKFe +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id211635436910093\n" +"sf_dictionary.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "pages: The pages to print as a string, like in the user interface. Example: \"1-4;10;15-18\". Default is all pages." +msgid "List of Methods in the Dictionary Service" msgstr "" -#. EHtFi -#: sf_document.xhp +#. PqSBg +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id141635436912146\n" +"sf_dictionary.xhp\n" +"par_id831582887670029\n" "help.text" -msgid "copies: The number of copies. Default is 1." +msgid "Adds a new key-item pair into the dictionary. Returns True if successful." msgstr "" -#. VDMiZ -#: sf_document.xhp +#. 4zw8b +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id651589200165470\n" +"sf_dictionary.xhp\n" +"par_id341582887670030\n" "help.text" -msgid "Removes a toplevel menu from the menubar of a given document window." +msgid "key: String value used to identify the Item. The key is not case-sensitive." msgstr "" -#. wfDbr -#: sf_document.xhp +#. UFFFG +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id981611149610695\n" +"sf_dictionary.xhp\n" +"par_id401582887670030\n" "help.text" -msgid "Returns True if the specified menu could be removed. If the specified menu does not exist, the method returns False." +msgid "item: Any value, including an array, a Basic object, a UNO object, a dictionary, etc." msgstr "" -#. eNVDJ -#: sf_document.xhp +#. aNDWv +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id571643121106014\n" +"sf_dictionary.xhp\n" +"par_id1001610391308765\n" "help.text" -msgid "This method can be used to remove any menu entry from the document window, including default menus. However, none of these changes in the menubar are saved to the document or to the application settings. To restore the menubar to the default settings, simply close and reopen the document window." +msgid "Every key must be unique in the same dictionary. If the key already exists in the dictionary, a DUPLICATEKEYERROR will be raised. Keys that are made of space characters will raise a INVALIDKEYERROR error." msgstr "" -#. E6ahL -#: sf_document.xhp +#. FDWkm +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id361589200121156\n" +"sf_dictionary.xhp\n" +"par_id81582888424104\n" "help.text" -msgid "menuheader: The toplevel name of the menu to be removed." +msgid "Stores the contents of the dictionary in a two-columns zero-based array. The keys are stored in the first column and the items are stored in the second column." msgstr "" -#. yRoDW -#: sf_document.xhp +#. FdwcF +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id391643120223147\n" +"sf_dictionary.xhp\n" +"par_id341610391565678\n" "help.text" -msgid "oDoc.RemoveMenu(\"My Menu\")" +msgid "If the dictionary is empty, this method will return an empty Array." msgstr "" -#. BnmiF -#: sf_document.xhp +#. rAA3u +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"pyc_id221622827946338\n" +"sf_dictionary.xhp\n" +"par_id831601296836981\n" "help.text" -msgid "doc.RemoveMenu(\"My Menu\")" +msgid "Converts the contents of a dictionary to JSON (JavaScript Object Notation) text." msgstr "" -#. Ab7PE -#: sf_document.xhp +#. nAZ9s +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id991589202413257\n" +"sf_dictionary.xhp\n" +"hd_id261601297024828\n" "help.text" -msgid "Runs a UNO command on the document window associated with the service instance. A few typical commands are: Save, SaveAs, ExportToPDF, Undo, Copy, Paste, etc." +msgid "Limitations" msgstr "" -#. qBhYc -#: sf_document.xhp +#. DDmVt +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id261589202778896\n" +"sf_dictionary.xhp\n" +"par_id401601297178073\n" "help.text" -msgid "The document itself does not need to be active to be able to run commands." +msgid "This method supports the following data types: String, Boolean, numbers, Null and Empty. Arrays containing items of those types are also allowed, whatever their dimensions. Dates are converted into strings, however they cannot be used inside Arrays. Other data types are converted to their string representation using the SF_String.Represent service." msgstr "" -#. 9FuBU -#: sf_document.xhp +#. stuTQ +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id921611152932311\n" +"sf_dictionary.xhp\n" +"par_id8816012968362\n" "help.text" -msgid "Commands can be run with or without arguments. Arguments are not validated before running the command. If the command or its arguments are invalid, then nothing will happen." +msgid "indent: When indent is a positive number or a text, JSON array elements and object members are pretty-printed with that indentation level. A negative indent value will add new lines with no indentation. The default value is an empty string \"\" which selects the most compact representation. Using a positive integer for indent indents that many spaces per level. When indent is a string, such as Chr(9) or Tab(1), the Tab character is used to indent each level." msgstr "" -#. xgByz -#: sf_document.xhp +#. sQuKi +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id31644182402479\n" +"sf_dictionary.xhp\n" +"par_id151582889470596\n" "help.text" -msgid "For a complete list of UNO commands that can be run in %PRODUCTNAME, refer to the Wiki page Development/DispatchCommands." +msgid "Stores the contents of the dictionary into an array of PropertyValues." msgstr "" -#. HBVsV -#: sf_document.xhp +#. rTa2V +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id401589202413575\n" +"sf_dictionary.xhp\n" +"par_id231610392665049\n" "help.text" -msgid "command: Case-sensitive string containing the UNO command name. The inclusion of the prefix \".uno:\" in the command is optional. The command itself is not checked for correctness. If nothing happens after the command call, then the command is probably wrong." +msgid "Each entry in the array is a com.sun.star.beans.PropertyValue. The key is stored in Name, the item is stored in Value." msgstr "" -#. xi32t -#: sf_document.xhp +#. 5MnFS +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id521644182774710\n" +"sf_dictionary.xhp\n" +"par_id341610392705367\n" "help.text" -msgid "args: For each argument to be passed to the command, specify a pair containing the argument name and value." +msgid "If one of the items has a type Date, it is converted to a com.sun.star.util.DateTime structure. If one of the items is an empty array, it is converted to Null. The resulting array is empty when the dictionary is empty." msgstr "" -#. MqEx7 -#: sf_document.xhp +#. EU4BC +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id721611153068137\n" +"sf_dictionary.xhp\n" +"bas_id531610393130289\n" "help.text" -msgid "The following example runs the SelectData command in a Calc file named \"MyFile.ods\", which will result in the selection of the data area based on the currently selected cell. Note that this command does not require any arguments." +msgid "'Adds some properties to the dictionary" msgstr "" -#. GGDgF -#: sf_document.xhp +#. dEAPF +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id371644184276886\n" +"sf_dictionary.xhp\n" +"bas_id571610393137959\n" "help.text" -msgid "Below is an example that runs the UNO command ReplaceAll and passes values for its arguments SearchString and ReplaceString. Running this command will replace all occurrence of the string \"abc\" by \"ABC\" in the current sheet." +msgid "'Converts to an Array of PropertyValue objects" msgstr "" -#. Z4Egf -#: sf_document.xhp +#. XCGFp +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"bas_id631644184414955\n" +"sf_dictionary.xhp\n" +"par_id771626700938786\n" "help.text" -msgid "' Arguments passed to the command:" +msgid "Note in the example below that a Python dictionary needs to be passed as the second argument of the CreateScriptService method." msgstr "" -#. H5eQ9 -#: sf_document.xhp +#. oZEpN +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id41644184549167\n" +"sf_dictionary.xhp\n" +"par_id421610393306916\n" "help.text" -msgid "Note that calling the command ReplaceAll without arguments will open the Find and Replace dialog." +msgid "Many services and methods in the UNO library take in parameters represented using the PropertyValue struct, which is part of the %PRODUCTNAME API." msgstr "" -#. Cp7Wk -#: sf_document.xhp +#. 3afLF +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id811644243228448\n" +"sf_dictionary.xhp\n" +"par_id841582889812916\n" "help.text" -msgid "In Python it is also possible to call RunCommand using keyword arguments:" +msgid "Determines if a key exists in the dictionary." msgstr "" -#. m9AyA -#: sf_document.xhp +#. RgUSD +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id191611153511038\n" +"sf_dictionary.xhp\n" +"par_id971582889812917\n" "help.text" -msgid "Each %PRODUCTNAME component has its own set of commands available. One easy way to learn commands is going to Tools - Customize - Keyboard. When you position your mouse over a function in the Function list, a tooltip will appear with the corresponding UNO command." +msgid "key: The key to be looked up in the dictionary." msgstr "" -#. enSv9 -#: sf_document.xhp +#. UAkEx +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id81589202925519\n" +"sf_dictionary.xhp\n" +"bas_id811606485130666\n" "help.text" -msgid "Stores the document to the file location from which it was loaded. The method is ignored if the document was not modified." +msgid "'Adds some properties to the dictionary" msgstr "" -#. sFUcr -#: sf_document.xhp +#. 84fn2 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id731611153918907\n" +"sf_dictionary.xhp\n" +"par_id791601391980978\n" "help.text" -msgid "Returns False if the document could not be saved. An error is raised if the file is open as read-only, or if it is a new file that has not been saved yet." +msgid "Adds the content of a JSON (JavaScript Object Notation) string into the current dictionary. Returns True if successful." msgstr "" -#. Ys5oF -#: sf_document.xhp +#. NtQCD +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id211589203690937\n" +"sf_dictionary.xhp\n" +"hd_id961601392113644\n" "help.text" -msgid "The document itself does not need to be active to run this method." +msgid "Limitations" msgstr "" -#. 75K92 -#: sf_document.xhp +#. dGRph +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id121589203370778\n" +"sf_dictionary.xhp\n" +"par_id481601392181131\n" "help.text" -msgid "Stores the document to the given file location. The new location becomes the new file name on which simple Save method calls will be applied." +msgid "The JSON string may contain numbers, text, booleans, null values and arrays containing those types. It must not contain JSON objects namely sub-dictionaries." msgstr "" -#. R8D2A -#: sf_document.xhp +#. LyxQD +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id31611154475602\n" +"sf_dictionary.xhp\n" +"par_id511601392205908\n" "help.text" -msgid "Returns False if the document could not be saved. An error is raised when overwriting the destination is rejected or when the destination has its read-only attribute set." +msgid "An attempt is made to convert text to date if the item matches one of these patterns: YYYY-MM-DD, HH:MM:SS or YYYY-MM-DD HH:MM:SS." msgstr "" -#. GAAfy -#: sf_document.xhp +#. 5cknM +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id391589203370902\n" +"sf_dictionary.xhp\n" +"par_id69160139198061\n" "help.text" -msgid "The document itself does not need to be active to run this method." +msgid "inputstr: The string to import." msgstr "" -#. 7tX6c -#: sf_document.xhp +#. eCfBF +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id331589203370950\n" +"sf_dictionary.xhp\n" +"par_id201601391980268\n" "help.text" -msgid "filename: A string containing the file name to be used. It must follow the SF_FileSystem.FileNaming notation." +msgid "overwrite: When True, entries with same name may exist in the dictionary and their values are overwritten. When False (default), repeated keys will raise an error. Be aware that dictionary keys are not case-sensitive while names are case-sensitive in JSON strings." msgstr "" -#. niFkh -#: sf_document.xhp +#. aBFC5 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id631589204010142\n" +"sf_dictionary.xhp\n" +"bas_id521601393254694\n" "help.text" -msgid "overwrite: If True, the destination file may be overwritten (default = False)." +msgid "'The (sub)-dictionaries \"address\" and \"phoneNumbers\" (0) and (1) are imported as Empty values." msgstr "" -#. snX8q -#: sf_document.xhp +#. 9j5u2 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id811589204084107\n" +"sf_dictionary.xhp\n" +"par_id651588941968228\n" "help.text" -msgid "password (*): A non-space string to protect the document." +msgid "Inserts the contents of an array of PropertyValue objects into the current dictionary. PropertyValue Names are used as Keys in the dictionary, whereas Values contain the corresponding values. Returns True if successful." msgstr "" -#. g3wDy -#: sf_document.xhp +#. BQybf +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id451589204163772\n" +"sf_dictionary.xhp\n" +"par_id751588941968522\n" "help.text" -msgid "filtername (*): The name of a filter that should be used for saving the document. If this argument is passed, then the filter must exist." +msgid "propertyvalues: A zero-based 1-dimensional array containing com.sun.star.beans.PropertyValue objects. This parameter may also be a single PropertyValue object not contained in an Array." msgstr "" -#. qZaAJ -#: sf_document.xhp +#. g5bHm +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id981589204207800\n" +"sf_dictionary.xhp\n" +"par_id21588941968131\n" "help.text" -msgid "filteroptions (*): An optional string of options associated with the filter." +msgid "overwrite: When True, entries with same name may exist in the dictionary and their values are overwritten. When False (default), repeated keys will raise an error. Note that dictionary keys are not case-sensitive in Basic, whereas names are case-sensitive in sets of property values and in Python dictionaries." msgstr "" -#. FJywB -#: sf_document.xhp +#. GKtsH +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id911589205147502\n" +"sf_dictionary.xhp\n" +"par_id641626703615898\n" "help.text" -msgid "Stores a copy of or export the document to the given file location. The actual location is unchanged." +msgid "The examples below first create an array with two PropertyValue objects and then convert it to a dictionary." msgstr "" -#. ovvew -#: sf_document.xhp +#. 3rJRP +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id381611154800685\n" +"sf_dictionary.xhp\n" +"par_id891582890366737\n" "help.text" -msgid "Returns False if the document could not be saved. An error is raised when overwriting the destination is rejected or when the destination has its read-only attribute set." +msgid "Retrieves an existing dictionary entry based on its key. Returns the value of the item if successful, otherwise returns Empty." msgstr "" -#. BFKFn -#: sf_document.xhp +#. MV7Wq +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id11589205147643\n" +"sf_dictionary.xhp\n" +"par_id551582890399669\n" "help.text" -msgid "The document itself does not need to be active to run this method." +msgid "key: Not case-sensitive. If it does not exist, Empty value is returned." msgstr "" -#. FAjhF -#: sf_document.xhp +#. rGqyT +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id301589205147697\n" +"sf_dictionary.xhp\n" +"par_id181610395933967\n" "help.text" -msgid "filename: A string containing the file name to be used. It must follow the SF_FileSystem.FileNaming notation." +msgid "The following example iterates over all keys in the dictionary and uses the Item method to access their values." msgstr "" -#. zr6Rx -#: sf_document.xhp +#. QJTte +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id851589205147348\n" +"sf_dictionary.xhp\n" +"par_id891582890388737\n" "help.text" -msgid "overwrite: If True, the destination file may be overwritten (default = False)." +msgid "Removes an existing dictionary entry based on its key. Returns True if successful." msgstr "" -#. k2uRD -#: sf_document.xhp +#. EhVL2 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id821589205147330\n" +"sf_dictionary.xhp\n" +"par_id551582890366999\n" "help.text" -msgid "password (*): A non-space string to protect the document." +msgid "key: Not case-sensitive. Must exist in the dictionary, otherwise an UNKNOWNKEYERROR error is raised." msgstr "" -#. eyrsV -#: sf_document.xhp +#. GyK3j +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id67158920514729\n" +"sf_dictionary.xhp\n" +"par_id921582896275624\n" "help.text" -msgid "filtername (*): The name of a filter that should be used for saving the document. If this argument is passed, then the filter must exist." +msgid "Removes all the entries from the dictionary. Returns True if successful." msgstr "" -#. vA4NU -#: sf_document.xhp +#. GSzP5 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id881589205147911\n" +"sf_dictionary.xhp\n" +"par_id281582895615444\n" "help.text" -msgid "filteroptions (*): An optional string of options associated with the filter." +msgid "Replaces an existing item value based on its key. Returns True if successful." msgstr "" -#. 96EBt -#: sf_document.xhp +#. w4w9A +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id911298505147502\n" +"sf_dictionary.xhp\n" +"par_id991582895615535\n" "help.text" -msgid "Defines the printer options for the document." +msgid "key: String value representing the key whose value will be replaced. Not case-sensitive. If the key does not exist in the dictionary, an UNKNOWNKEYERROR error is raised." msgstr "" -#. zoaQX -#: sf_document.xhp +#. FA4hz +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id381651114800685\n" +"sf_dictionary.xhp\n" +"par_id721582895615186\n" "help.text" -msgid "Returns True when successful." +msgid "value: The new value of the item referred to with the key parameter." msgstr "" -#. hGfVh -#: sf_document.xhp +#. Y46D4 +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id301589205741697\n" +"sf_dictionary.xhp\n" +"par_id571582896597766\n" "help.text" -msgid "printer: The name of the printer queue where to print to. When absent, the default printer is set." +msgid "Replaces an existing key in the dictionary by a new key. The item value is left unchanged. Returns True if successful." msgstr "" -#. mRrfG -#: sf_document.xhp +#. jKp7C +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id851985205147348\n" -"help.text" -msgid "orientation: Either PORTRAIT or LANDSCAPE. When absent, left unchanged with respect to the printer settings." +"sf_dictionary.xhp\n" +"par_id911582896597619\n" +"help.text" +msgid "key: String value representing the key to be replaced. Not case-sensitive. If the key does not exist in the dictionary, a UNKNOWNKEYERROR error is raised." msgstr "" -#. ENyZH -#: sf_document.xhp +#. Dku2D +#: sf_dictionary.xhp msgctxt "" -"sf_document.xhp\n" -"par_id821985205147330\n" +"sf_dictionary.xhp\n" +"par_id531582896597989\n" "help.text" -msgid "paperformat: Specifies the paper format as a string value that can be either A3, A4, A5, LETTER, LEGAL or TABLOID. Left unchanged when absent." +msgid "value: String value for the new key. Not case-sensitive. If the new key already exists in the dictionary, an DUPLICATEKEYERROR error is raised." msgstr "" -#. WCH7E -#: sf_exception.xhp +#. jasej +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" +"sf_document.xhp\n" "tit\n" "help.text" -msgid "ScriptForge.Exception service (SF_Exception)" +msgid "SFDocuments.Document service" msgstr "" -#. PPqb2 -#: sf_exception.xhp +#. ypVGE +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"hd_id521580038927003\n" +"sf_document.xhp\n" +"hd_id731582733781114\n" "help.text" -msgid "ScriptForge.Exception service" +msgid "SFDocuments.Document service" msgstr "" -#. 4X7Xk -#: sf_exception.xhp +#. VTWbF +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id181587139648008\n" +"sf_document.xhp\n" +"par_id381589189355849\n" "help.text" -msgid "The Exception service is a collection of methods to assist in code debugging in Basic and Python scripts and in error handling in Basic scripts." +msgid "The SFDocuments library provides methods and properties to facilitate the management and manipulation of %PRODUCTNAME documents." msgstr "" -#. XeYa4 -#: sf_exception.xhp +#. urZhL +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id141587140927573\n" +"sf_document.xhp\n" +"par_id591589189364267\n" "help.text" -msgid "In Basic scripts, when a run-time error occurs, the methods and properties of the Exception service help identify the error context and allow to handle it." +msgid "Methods that are applicable for all types of documents (Text Documents, Sheets, Presentations, etc) are provided by the SFDocuments.Document service. Some examples are:" msgstr "" -#. zF4vz -#: sf_exception.xhp +#. VgG69 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id401621450898070\n" +"sf_document.xhp\n" +"par_id891589189452545\n" "help.text" -msgid "The SF_Exception service is similar to the VBA Err object." +msgid "Opening, closing and saving documents" msgstr "" -#. vpB42 -#: sf_exception.xhp +#. XfHGF +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id361621450908874\n" +"sf_document.xhp\n" +"par_id811589189463041\n" "help.text" -msgid "The Number property identifies the error." +msgid "Accessing standard or custom properties of documents" msgstr "" -#. TnWpD -#: sf_exception.xhp +#. C6JgF +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id861621450910254\n" +"sf_document.xhp\n" +"par_id301611085807704\n" "help.text" -msgid "Use the Raise method to interrupt processing. The RaiseWarning method can be used to trap an anomaly without interrupting the macro execution." +msgid "The properties, methods or arguments marked with (*) are NOT applicable to Base documents." msgstr "" -#. CpxKC -#: sf_exception.xhp +#. rh5iz +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id621587225732733\n" +"sf_document.xhp\n" +"par_id241589189701274\n" "help.text" -msgid "Errors and warnings raised with the Exception service are stored in memory and can be retrieved using the Console method." +msgid "Methods and properties that are specific to certain %PRODUCTNAME components are stored in separate services, such as SFDocuments.SF_Calc and SFDocuments.SF_Base." msgstr "" -#. ioDzp -#: sf_exception.xhp +#. Fdi8i +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id411587141146677\n" +"sf_document.xhp\n" +"par_id641611090052376\n" "help.text" -msgid "The Exception service console stores events, variable values and information about errors. Use the console when the Basic IDE is not easily accessible, for example in Calc user defined functions (UDF) or during events processing." +msgid "Although the Basic language does not offer inheritance between object classes, the latter services may be considered as subclasses of the SFDocuments.Document service. Such subclasses can invoke the properties and methods described below." msgstr "" -#. NrY9C -#: sf_exception.xhp +#. YMWaA +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id251621034725811\n" +"sf_document.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "Use the DebugPrint method to add any relevant information to the console. Console entries can be dumped to a text file or visualized in a dialog window." +msgid "Service invocation" msgstr "" -#. 9AW2i -#: sf_exception.xhp +#. XVADJ +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id111587141158495\n" +"sf_document.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "When an error occurs, an application macro may:" +msgid "Before using the Document service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. hxxxr -#: sf_exception.xhp +#. X6BV3 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id451587141202844\n" +"sf_document.xhp\n" +"par_id581611090387382\n" "help.text" -msgid "Report the error in the Exception console" +msgid "Below are three variants of how the Document service can be invoked." msgstr "" -#. N9X2f -#: sf_exception.xhp +#. o39cT +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id751587141235313\n" +"sf_document.xhp\n" +"par_id181622816732197\n" "help.text" -msgid "Inform the user about the error using either a standard message or a custom message" +msgid "Using the getDocument method from the ScriptForge.UI service:" msgstr "" -#. C3NMD -#: sf_exception.xhp +#. 6AZF9 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id931587141260777\n" +"sf_document.xhp\n" +"par_id181622818236233\n" "help.text" -msgid "Optionally stop its execution" +msgid "Alternatively you can use the methods CreateDocument and OpenDocument from the UI service." msgstr "" -#. vFJRL -#: sf_exception.xhp +#. uwA2W +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id771621035263403\n" +"sf_document.xhp\n" +"par_id691622816765571\n" "help.text" -msgid "In Python scripts the Exception service is mostly used for debugging purposes. Methods such as DebugPrint, Console and DebugDisplay are useful to quickly print messages, log data and open the console window from within a Python script." +msgid "Using a window name if the document is already open." msgstr "" -#. VAaLU -#: sf_exception.xhp +#. yRfyT +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id211621035276160\n" +"sf_document.xhp\n" +"par_id551658777771853\n" "help.text" -msgid "Not all methods and properties are available for Python scripts since the Python language already has a comprehensive exception handling system." +msgid "Using the document referenced by ThisComponent. This is specially useful when running a macro from within the Basic IDE." msgstr "" -#. yQzKr -#: sf_exception.xhp +#. yFDEW +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"hd_id201586594659135\n" +"sf_document.xhp\n" +"par_id821622816825012\n" "help.text" -msgid "Service invocation" +msgid "From a macro triggered by a document event." msgstr "" -#. T8o7G -#: sf_exception.xhp +#. FxfW2 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id161610652161795\n" +"sf_document.xhp\n" +"par_id831622816562430\n" "help.text" -msgid "The following examples show three different approaches to call the method Raise. All other methods can be executed in a similar fashion." +msgid "The Document service is closely related to the UI and FileSystem services." msgstr "" -#. tGmaZ -#: sf_exception.xhp +#. QF9FG +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id901621036227048\n" +"sf_document.xhp\n" +"par_id891582733781994\n" "help.text" -msgid "The code snippet below creates an instance of the Exception service, logs a message and displays the Console window." +msgid "Except when the document was closed by program with the CloseDocument method (it is then superfluous), it is recommended to free resources after use:" msgstr "" -#. HABsh -#: sf_exception.xhp +#. LyvNw +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"hd_id651584978211886\n" +"sf_document.xhp\n" +"par_id71611090922315\n" "help.text" -msgid "Properties" +msgid "The use of the prefix \"SFDocuments.\" while calling the service is optional." msgstr "" -#. JDNi6 -#: sf_exception.xhp +#. z3oxC +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id911621036526404\n" +"sf_document.xhp\n" +"hd_id351582885195476\n" "help.text" -msgid "The properties listed below are only available for Basic scripts." +msgid "Properties" msgstr "" -#. s3E9G -#: sf_exception.xhp +#. 6NTY6 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id271584978211792\n" +"sf_document.xhp\n" +"par_id41582885195836\n" "help.text" msgid "Name" msgstr "" -#. b96rE -#: sf_exception.xhp +#. wUbi9 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id241584978211550\n" +"sf_document.xhp\n" +"par_id31582885195372\n" "help.text" msgid "Readonly" msgstr "" -#. TkMLa -#: sf_exception.xhp +#. NfJEr +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id621584978211403\n" +"sf_document.xhp\n" +"par_id31582885195238\n" "help.text" -msgid "Description" +msgid "Type" msgstr "" -#. tJZkJ -#: sf_exception.xhp +#. QZzvi +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id71584978715562\n" -"help.text" -msgid "No" +"sf_document.xhp\n" +"par_id931582885195131\n" +"help.text" +msgid "Description" msgstr "" -#. RyJkE -#: sf_exception.xhp +#. wBpru +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id581584978715701\n" +"sf_document.xhp\n" +"par_id861582885655779\n" "help.text" -msgid "The error message text." +msgid "No" msgstr "" -#. Wcy7s -#: sf_exception.xhp +#. ENrbA +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id241610652688334\n" +"sf_document.xhp\n" +"par_id581582885655885\n" "help.text" -msgid "Default value is \"\" or a string containing the Basic run-time error message." +msgid "Returns a ScriptForge.Dictionary object instance. After update, can be passed again to the property for updating the document.
Individual items of the dictionary may be either strings, numbers, (Basic) dates or com.sun.star.util.Duration items." msgstr "" -#. BT7GF -#: sf_exception.xhp +#. DktDb +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id211584978211383\n" +"sf_document.xhp\n" +"par_id441582886030118\n" "help.text" msgid "No" msgstr "" -#. AnFVG -#: sf_exception.xhp +#. DNFGz +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id691584978211774\n" +"sf_document.xhp\n" +"par_id471582886030489\n" "help.text" -msgid "The code of the error. It can be a numeric value or text." +msgid "Gives access to the Description property of the document (also known as \"Comments\")" msgstr "" -#. dCADC -#: sf_exception.xhp +#. wMzx8 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id151610652632828\n" +"sf_document.xhp\n" +"par_id971582886791838\n" "help.text" -msgid "Default value is 0 or the numeric value corresponding to the Basic run-time error code." +msgid "Yes" msgstr "" -#. uLE2Q -#: sf_exception.xhp +#. Mm6E5 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id671584978666689\n" +"sf_document.xhp\n" +"par_id16158288679167\n" "help.text" -msgid "No" +msgid "Returns a ScriptForge.Dictionary object containing all the entries. Document statistics are included. Note that they are specific to the type of document. As an example, a Calc document includes a \"CellCount\" entry. Other documents do not." msgstr "" -#. G3q2n -#: sf_exception.xhp +#. Ew7vi +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id951584978666296\n" +"sf_document.xhp\n" +"par_id201589194571955\n" "help.text" -msgid "The location in the code where the error occurred. It can be a numeric value or text." +msgid "Yes" msgstr "" -#. kBXGC -#: sf_exception.xhp +#. Aw2Tv +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id681610652723345\n" +"sf_document.xhp\n" +"par_id941589194571801\n" "help.text" -msgid "Default value is 0 or the code line number for a standard Basic run-time error." +msgid "String value with the document type (\"Base\", \"Calc\", \"Writer\", etc)" msgstr "" -#. mnFGS -#: sf_exception.xhp +#. UcEJi +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id461584978880380\n" +"sf_document.xhp\n" +"par_id201589194571699\n" "help.text" -msgid "Raising or clearing an Exception resets its properties." +msgid "Yes" msgstr "" -#. ssXEB -#: sf_exception.xhp +#. EZzPF +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id881608131596153\n" +"sf_document.xhp\n" +"par_id941589194571327\n" "help.text" -msgid "List of Methods in the Exception Service" +msgid "Returns a list with the export filter names applicable to the current document as a zero-based array of strings. Filters used for both import/export are also returned." msgstr "" -#. CDgEM -#: sf_exception.xhp +#. jndk4 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id271579683706571\n" +"sf_document.xhp\n" +"par_id201589194571306\n" "help.text" -msgid "Resets the current error status and clears the SF_Exception properties." +msgid "Yes" msgstr "" -#. 7jFLi -#: sf_exception.xhp +#. KsJ8e +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id701610654263121\n" +"sf_document.xhp\n" +"par_id941589194571044\n" "help.text" -msgid "The following example shows how to catch a division-by-zero exception, whose error code is 11." +msgid "Returns a string with the URL path to the root of the virtual file system of the document. Use the FileSystem service to view its contents, as well as to create, open and read files stored in it." msgstr "" -#. JhADn -#: sf_exception.xhp +#. kmW9L +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"bas_id51587215508130\n" +"sf_document.xhp\n" +"par_id941589194576584\n" "help.text" -msgid "'If division by zero, ignore the error" +msgid "Refer to this help page to learn more on how to access and manipulate folders and files in the virtual file system of a %PRODUCTNAME file." msgstr "" -#. DHZ5A -#: sf_exception.xhp +#. 7vqDq +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id201610654368082\n" +"sf_document.xhp\n" +"par_id201589194571067\n" "help.text" -msgid "For a complete list of Basic run-time error codes, refer to Debugging a Basic Program." +msgid "Yes" msgstr "" -#. efEEX -#: sf_exception.xhp +#. UmCHS +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id651598718179382\n" +"sf_document.xhp\n" +"par_id941589194571922\n" "help.text" -msgid "Displays the console messages in a modal or non-modal dialog. In both modes, all the past messages issued by a DebugPrint() method or resulting from an exception are displayed. In non-modal mode, subsequent entries are added automatically." +msgid "Returns a list with the import filter names applicable to the current document as a zero-based array of strings. Filters used for both import/export are also returned." msgstr "" -#. KKgdp -#: sf_exception.xhp +#. Yo8T4 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id161598718286205\n" +"sf_document.xhp\n" +"par_id761589194633950\n" "help.text" -msgid "If the console is already open, when non-modal, it is brought to the front." +msgid "Yes" msgstr "" -#. ypzYc -#: sf_exception.xhp +#. pSbRu +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id801598718629151\n" +"sf_document.xhp\n" +"par_id611589194633853\n" "help.text" -msgid "A modal console can only be closed by the user. A non-modal console can either be closed by the user or upon macro termination." +msgid "Exactly one of these properties is True for a given document." msgstr "" -#. HUgnb -#: sf_exception.xhp +#. oKQWB +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id511598718179819\n" +"sf_document.xhp\n" +"par_id231589194910179\n" "help.text" -msgid "modal: Determine if the console window is modal (True) or non-modal (False). Default value is True." +msgid "No" msgstr "" -#. xu6FA -#: sf_exception.xhp +#. CDTBC +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id641587215098903\n" +"sf_document.xhp\n" +"par_id311589194910190\n" "help.text" -msgid "Clears the console keeping an optional number of recent messages. If the console is activated in non-modal mode, it is refreshed." +msgid "Gives access to the Keywords property of the document. Represented as a comma-separated list of keywords" msgstr "" -#. SE7ei -#: sf_exception.xhp +#. EHM84 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id351587215098527\n" +"sf_document.xhp\n" +"par_id921589638614972\n" "help.text" -msgid "keep: The number of recent messages to be kept. Default value is 0." +msgid "Yes" msgstr "" -#. GLEVv -#: sf_exception.xhp +#. JGTQz +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id521610655023824\n" +"sf_document.xhp\n" +"par_id801589638614518\n" "help.text" -msgid "The following example clears the console keeping the 10 most recent messages." +msgid "True if the document is actually in read-only mode" msgstr "" -#. 4LD2d -#: sf_exception.xhp +#. zK55N +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id281587218077400\n" +"sf_document.xhp\n" +"par_id201589195028733\n" "help.text" -msgid "Exports the contents of the console to a text file. If the file already exists and the console is not empty, it will be overwritten without warning. Returns True if successful." +msgid "No" msgstr "" -#. cAusu -#: sf_exception.xhp +#. 99ZxC +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id851587218077862\n" +"sf_document.xhp\n" +"par_id371589195028843\n" "help.text" -msgid "filename: The name of the text file the console should be dumped into. The name is expressed according to the current FileNaming property of the SF_FileSystem service. By default, URL notation and the native operating system's format are both admitted." +msgid "Gives access to the Subject property of the document." msgstr "" -#. F3tVM -#: sf_exception.xhp +#. dH6ct +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id701621043185177\n" +"sf_document.xhp\n" +"par_id451589195028910\n" "help.text" -msgid "Concatenates all the arguments into a single human-readable string and displays it in a MsgBox with an Information icon and an OK button." +msgid "No" msgstr "" -#. KaGM6 -#: sf_exception.xhp +#. TCiBh +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id791621097689492\n" +"sf_document.xhp\n" +"par_id771589195028748\n" "help.text" -msgid "The final string is also added to the Console." +msgid "Gives access to the Title property of the document." msgstr "" -#. QhRgF -#: sf_exception.xhp -msgctxt "" -"sf_exception.xhp\n" -"par_id481587218636884\n" -"help.text" -msgid "arg0[, arg1, ...]: Any number of arguments of any type." -msgstr "" - -#. 2qser -#: sf_exception.xhp +#. SwDBh +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id281587218637490\n" +"sf_document.xhp\n" +"par_id221582885195686\n" "help.text" -msgid "Assembles all the given arguments into a single human-readable string and adds it as a new entry in the console." +msgid "Yes" msgstr "" -#. mUSEP -#: sf_exception.xhp +#. PRmJE +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id481587218637988\n" +"sf_document.xhp\n" +"par_id371582885195525\n" "help.text" -msgid "arg0[, arg1, ...]: Any number of arguments of any type." +msgid "UNO Object" msgstr "" -#. sCSES -#: sf_exception.xhp +#. BprB8 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id111621624672183\n" +"sf_document.xhp\n" +"par_id881582885195976\n" "help.text" -msgid "Displays the list of arguments in a readable form in the platform console. Arguments are separated by a TAB character (simulated by spaces)." +msgid "The UNO object com.sun.star.lang.XComponent or com.sun.star.comp.dba.ODatabaseDocument representing the document" msgstr "" -#. ujSFu -#: sf_exception.xhp +#. coFyk +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id841621426229467\n" +"sf_document.xhp\n" +"par_id861611146581334\n" "help.text" -msgid "The same string is added to the ScriptForge debug console." +msgid "The example below prints all the properties of a document. Note that the oDoc object returned by the UI.OpenDocument method is a SFDocuments.Document object." msgstr "" -#. kzBDb -#: sf_exception.xhp +#. eqL5J +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id551655563148866\n" +"sf_document.xhp\n" +"par_id571622826920742\n" "help.text" -msgid "If Python shell (APSO) is active, PythonPrint content is written to APSO console in place of the platform console." +msgid "To access document properties in a Python script the user needs to directly access them using their names, as shown below:" msgstr "" -#. ixNfF -#: sf_exception.xhp +#. wmiy9 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id391126449167833\n" +"sf_document.xhp\n" +"par_id651606319520519\n" "help.text" -msgid "arg0[, arg1, ...]: Any number of arguments of any type. The maximum length of each individual argument is 1024 characters." +msgid "List of Methods in the Document Service" msgstr "" -#. U88JC -#: sf_exception.xhp +#. UVWQb +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id261123015276160\n" +"sf_document.xhp\n" +"par_id93158919969864\n" "help.text" -msgid "In Python use a print statement to print to the APSO console or use the DebugPrint method to print to ScriptForge's console." +msgid "Returns True if the document could be activated. Otherwise, there is no change in the actual user interface. It is equivalent to the Activate method of the UI service." msgstr "" -#. CUoch -#: sf_exception.xhp +#. qcuXA +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id111621426672183\n" +"sf_document.xhp\n" +"par_id421611148353046\n" "help.text" -msgid "Opens an APSO Python shell as a non-modal window. The Python script keeps running after the shell is opened. The output from print statements inside the script are shown in the shell." +msgid "This method is useful when one needs to give focus for a document that is minimized or hidden." msgstr "" -#. f9ZzM -#: sf_exception.xhp +#. vFzrg +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id841621426922467\n" +"sf_document.xhp\n" +"par_id601611148017930\n" "help.text" -msgid "Only a single instance of the APSO Python shell can be opened at any time. Hence, if a Python shell is already open, then calling this method will have no effect." +msgid "The example below considers that the file \"My_File.ods\" is already open but not active." msgstr "" -#. KGi8B -#: sf_exception.xhp +#. zGRcs +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id391621449167833\n" +"sf_document.xhp\n" +"par_id601611148080503\n" "help.text" -msgid "variables: a Python dictionary with variable names and values that will be passed on to the APSO Python shell. By default all local variables are passed using Python's builtin locals() function." +msgid "Keep in mind that you can invoke the Document service by passing to CreateScriptService either \"Document\" or \"SFDocuments.Document\"" msgstr "" -#. zT7Gq -#: sf_exception.xhp +#. rB7Ab +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id991621449657850\n" +"sf_document.xhp\n" +"par_id651589200121138\n" "help.text" -msgid "The example below opens the APSO Python shell passing all global and local variables considering the context where the script is running." +msgid "Closes the document. If the document is already closed, regardless of how the document was closed, this method has no effect and returns False." msgstr "" -#. yUoFK -#: sf_exception.xhp +#. 64F7E +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id521621449800348\n" +"sf_document.xhp\n" +"par_id341611149562894\n" "help.text" -msgid "When the APSO Python shell is open, any subsequent output printed by the script will be shown in the shell. Hence, the string printed in the example below will be displayed in the Python shell." +msgid "The method will also return False if the user declines to close it." msgstr "" -#. 5xNCX -#: sf_exception.xhp +#. AGBjg +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"pyc_id731621449899901\n" +"sf_document.xhp\n" +"par_id981611149616934\n" "help.text" -msgid "print(\"Hello world!\")" +msgid "Returns True if the document was successfully closed." msgstr "" -#. aXDEK -#: sf_exception.xhp +#. Wt7L9 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id541587219824771\n" +"sf_document.xhp\n" +"par_id361589200121646\n" "help.text" -msgid "Generates a run-time error. An error message is displayed to the user and reported in the console. The execution is stopped. The Raise() method can be placed inside the normal script flow or in a dedicated error-handling routine." +msgid "saveask : If True (default), the user is invited to confirm if the changes should be written on disk. This argument is ignored if the document was not modified." msgstr "" -#. RuDTE -#: sf_exception.xhp +#. RhAbC +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id921587220542454\n" +"sf_document.xhp\n" +"par_id651589200121080\n" "help.text" -msgid "The code snippets presented next are equivalent. They show alternative ways to raise an exception with code 2100." +msgid "Creates a new menu entry in the menubar of a given document window." msgstr "" -#. 6wEJq -#: sf_exception.xhp +#. Cfyw4 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id851587219824597\n" +"sf_document.xhp\n" +"par_id981611149616155\n" "help.text" -msgid "Number: The error code, as a number or as a string. Default value is that of Err Basic builtin function." +msgid "This method returns an instance of the SFWidgets.Menu service." msgstr "" -#. 7zRRT -#: sf_exception.xhp +#. GKeq5 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id461587220986452\n" +"sf_document.xhp\n" +"par_id721643121487974\n" "help.text" -msgid "Source: The location of the error, as a number or as a string. Default value is that of Erl Basic builtin function." +msgid "The menu created is only available during the current %PRODUCTNAME session and is not saved neither in the document nor in the global application settings. Hence closing the document window will make the menu disappear. It will only reappear when the macro that creates the menu is executed again." msgstr "" -#. fSwCd -#: sf_exception.xhp +#. szVYB +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id721587221018162\n" +"sf_document.xhp\n" +"par_id361589200120316\n" "help.text" -msgid "Description: The message to display to the user and to report in the console. Default value is that of Error$ Basic builtin function." +msgid "menuheader: The toplevel name of the new menu." msgstr "" -#. Kzh7r -#: sf_exception.xhp +#. iCSZE +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"bas_id211587222852310\n" +"sf_document.xhp\n" +"par_id361589200129686\n" "help.text" -msgid "'See variants below ..." +msgid "before: The name (as a string) or position (as an integer starting at 1) of an existing menu before which the new menu will be placed. If no value is defined for this argument, the menu will be created at the last position in the menubar." msgstr "" -#. DV6VJ -#: sf_exception.xhp +#. LX4b9 +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id111587222580987\n" +"sf_document.xhp\n" +"par_id361589200122507\n" "help.text" -msgid "To raise an exception with the standard values:" +msgid "submenuchar: The delimiter used to create menu trees when calling methods as AddItem from the Menu service. The default value is \">\"." msgstr "" -#. SABN3 -#: sf_exception.xhp +#. FhwFZ +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id751587222598238\n" +"sf_document.xhp\n" +"bas_id751622827903865\n" "help.text" -msgid "To raise an exception with a specific code:" +msgid "Set oMenu = oDoc.CreateMenu(\"My Menu\")" msgstr "" -#. QXgCy -#: sf_exception.xhp +#. iDefE +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id501587222607771\n" +"sf_document.xhp\n" +"bas_id391643120224507\n" "help.text" -msgid "To replace the usual message:" +msgid "' Add items to the menu" msgstr "" -#. gdvqM -#: sf_exception.xhp +#. t4cXb +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"bas_id431587222670849\n" +"sf_document.xhp\n" +"bas_id100164312025160\n" "help.text" -msgid "SF_Exception.Raise(, , \"It is not a good idea to divide by zero.\")" +msgid "' After creating the menu, the service instance can be disposed of" msgstr "" -#. TaFgn -#: sf_exception.xhp +#. WuNHU +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id611587222617174\n" +"sf_document.xhp\n" +"pyc_id221622827943208\n" "help.text" -msgid "To raise an application error:" +msgid "menu = doc.CreateMenu(\"My Menu\")" msgstr "" -#. ifrWg -#: sf_exception.xhp +#. 5D4rC +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"bas_id71587222694657\n" +"sf_document.xhp\n" +"par_id271643139068194\n" "help.text" -msgid "SF_Exception.Raise(\"MyAppError\", \"Example_Raise()\", \"Something wrong happened !\")" +msgid "Refer to the SFWidgets.Menu help page to learn more about how to create/remove menus in %PRODUCTNAME document windows." msgstr "" -#. LuTSJ -#: sf_exception.xhp +#. v8axk +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id1001587224839900\n" +"sf_document.xhp\n" +"par_id156589200192258\n" "help.text" -msgid "This method has exactly the same syntax, arguments and behavior as the Raise() method." +msgid "Suspends user interface (UI) updates during the execution of a macro. Optionally, the mouse pointer can be changed into an hourglass while UI updates are suspended." msgstr "" -#. AXEnW -#: sf_exception.xhp +#. gAwTA +#: sf_document.xhp msgctxt "" -"sf_exception.xhp\n" -"par_id761587224839624\n" +"sf_document.xhp\n" +"par_id851688837646904\n" "help.text" -msgid "However, when a warning is raised, the macro execution is not stopped." +msgid "This method may provide some performance benefits for macros that perform numerous operations that require UI updates." msgstr "" -#. QTGXf -#: sf_filesystem.xhp +#. MRdkT +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"tit\n" +"sf_document.xhp\n" +"par_id211635436910325\n" "help.text" -msgid "ScriptForge.FileSystem service" +msgid "echoon: Specify False to suspend UI updates. The default value is True, which enables real time UI updates." msgstr "" -#. P8P86 -#: sf_filesystem.xhp +#. eLkJM +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"bm_id781582391760253\n" +"sf_document.xhp\n" +"par_id141635436912288\n" "help.text" -msgid "ScriptForge.FileSystem service" +msgid "hourglass: Specify True to change the mouse pointer to an hourglass (Default = False)." msgstr "" -#. wXVQJ -#: sf_filesystem.xhp +#. i8X6R +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id931583589764919\n" +"sf_document.xhp\n" +"par_id741689124521451\n" "help.text" -msgid "The FileSystem service includes routines to handle files and folders. Next are some examples of the features provided by this service:" +msgid "Moving the mouse pointer after it changed to an hourglass may cause it to switch to a different pointer depending on its new background." msgstr "" -#. NtXUq -#: sf_filesystem.xhp +#. PVXfC +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id121612917070593\n" +"sf_document.xhp\n" +"bas_id941688837091778\n" "help.text" -msgid "Verify whether a file or folder exists." +msgid "' Suspends UI updates and change mouse pointer to an hourglass" msgstr "" -#. gqggf -#: sf_filesystem.xhp +#. i5pkB +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id121612917070594\n" +"sf_document.xhp\n" +"bas_id561688837092732\n" "help.text" -msgid "Create and delete folders and files." +msgid "' Other macro commands" msgstr "" -#. FFUnD -#: sf_filesystem.xhp +#. hxDXE +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id121612917070595\n" +"sf_document.xhp\n" +"bas_id251688837093108\n" "help.text" -msgid "Launch dialog boxes to open/save files." +msgid "' Restores UI updates and mouse pointer" msgstr "" -#. bgECC -#: sf_filesystem.xhp +#. 6snES +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id121612917070596\n" +"sf_document.xhp\n" +"pyc_id691688837494400\n" "help.text" -msgid "Access the list of files in a folder, etc." +msgid "..." msgstr "" -#. 6TSXB -#: sf_filesystem.xhp +#. CGKZA +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id121612917368946\n" +"sf_document.xhp\n" +"par_id156589200123048\n" "help.text" -msgid "The methods in the FileSystem service are mostly based on the XSimpleFileAccess UNO interface." +msgid "Exports the document directly as a PDF file to the specified location. Returns True if the PDF file was successfully created." msgstr "" -#. wEqaV -#: sf_filesystem.xhp +#. FZYmR +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"hd_id961583589783025\n" +"sf_document.xhp\n" +"par_id811638276067119\n" "help.text" -msgid "Definitions" +msgid "The export options can be set either manually using the File - Export As - Export as PDF dialog or by calling the methods GetPDFExportOptions and SetPDFExportOptions from the Session service." msgstr "" -#. bczfJ -#: sf_filesystem.xhp +#. SFwEd +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id821612988815351\n" +"sf_document.xhp\n" +"par_id211635436910641\n" "help.text" -msgid "The table below lists the main parameters used by most of the methods in the FileSystem service." +msgid "filename: The full path and file name of the PDF to be created. It must follow the SF_FileSystem.FileNaming notation." msgstr "" -#. fV4jz -#: sf_filesystem.xhp +#. E6KyY +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id891612988600163\n" +"sf_document.xhp\n" +"par_id141635436912005\n" "help.text" -msgid "Parameter" +msgid "overwrite: Specifies if the destination file can be overwritten (Default = False). An error will occur if overwrite is set to False and the destination file already exists." msgstr "" -#. KdPjY -#: sf_filesystem.xhp +#. d9RRn +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id711612988600163\n" +"sf_document.xhp\n" +"par_id141635436913587\n" "help.text" -msgid "Description" +msgid "pages: String specifying which pages will be exported. This argument uses the same notation as in the dialog File - Export As - Export as PDF." msgstr "" -#. dEUyj -#: sf_filesystem.xhp +#. kBDPk +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321612988600163\n" +"sf_document.xhp\n" +"par_id141635436919655\n" "help.text" -msgid "The full name of the file including the path without a path separator at the end." +msgid "password: Specifies a password to open the PDF file." msgstr "" -#. Da76k -#: sf_filesystem.xhp +#. joeXi +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321612988600165\n" +"sf_document.xhp\n" +"par_id141635436913365\n" "help.text" -msgid "The full name of the folder including the path. It may or may not contain the ending path separator." +msgid "watermark: Text to be used as watermark in the PDF file, which will be drawn in every page of the resulting PDF." msgstr "" -#. LwB6Z -#: sf_filesystem.xhp +#. NmChF +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321612988600167\n" +"sf_document.xhp\n" +"par_id301638234284727\n" "help.text" -msgid "The last component of the Folder Name or File Name including its extension. This parameter is always expressed using the native format of the operating system." +msgid "The following example exports the current document as a PDF file, defines a password and overwrites the destination file if it already exists." msgstr "" -#. fjYSD -#: sf_filesystem.xhp +#. wEW7B +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321612988600169\n" +"sf_document.xhp\n" +"par_id311638276257020\n" "help.text" -msgid "The last component of the Folder Name or File Name without its extension." +msgid "The code snippet below gets the current PDF export options and uses them to create the PDF file." msgstr "" -#. 57Aab -#: sf_filesystem.xhp +#. 7uUWr +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321612988600172\n" +"sf_document.xhp\n" +"bas_id851638277174798\n" "help.text" -msgid "Any of the above names containing wildcards in its last component. Admitted wildcards are:" +msgid "' Sets to True the option to export comments as PDF notes" msgstr "" -#. arzQR -#: sf_filesystem.xhp +#. HNC9m +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id851583590809104\n" +"sf_document.xhp\n" +"par_id156589200121138\n" "help.text" -msgid "\"?\" represents any single character" +msgid "This method sends the contents of the document to the default printer or to the printer defined by the SetPrinter method." msgstr "" -#. wG8Bw -#: sf_filesystem.xhp +#. CJxTR +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id161583590819320\n" +"sf_document.xhp\n" +"par_id981611169416934\n" "help.text" -msgid "\"*\" represents zero, one, or multiple characters" +msgid "Returns True if the document was successfully printed." msgstr "" -#. BjZMB -#: sf_filesystem.xhp +#. uQMeV +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id911584540527980\n" +"sf_document.xhp\n" +"par_id211635436910093\n" "help.text" -msgid "The FileSystem service allows to perform operations over multiple files at the same time. By using name patterns, user scripts can copy, move or delete multiple files. Conversely, Basic built-in methods can only handle single files." +msgid "pages: The pages to print as a string, like in the user interface. Example: \"1-4;10;15-18\". Default is all pages." msgstr "" -#. zNCtF -#: sf_filesystem.xhp +#. EHtFi +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"hd_id991612918109871\n" +"sf_document.xhp\n" +"par_id141635436912146\n" "help.text" -msgid "File Naming Notation" +msgid "copies: The number of copies. Default is 1." msgstr "" -#. ZfsFV -#: sf_filesystem.xhp +#. VDMiZ +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id791612918141083\n" +"sf_document.xhp\n" +"par_id651589200165470\n" "help.text" -msgid "The notation used to express file and folder names, both for arguments and returned values, is defined by the FileNaming property of the FileSystem service." +msgid "Removes a toplevel menu from the menubar of a given document window." msgstr "" -#. wZA9G -#: sf_filesystem.xhp +#. wfDbr +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id951612918220255\n" +"sf_document.xhp\n" +"par_id981611149610695\n" "help.text" -msgid "In short, the possible representation types are \"URL\" (URL file notation), \"SYS\" (operating system notation) and \"ANY\" (default). See more information below." +msgid "Returns True if the specified menu could be removed. If the specified menu does not exist, the method returns False." msgstr "" -#. L84BJ -#: sf_filesystem.xhp +#. eNVDJ +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id861583589907100\n" +"sf_document.xhp\n" +"par_id571643121106014\n" "help.text" -msgid "An example of the URL notation is file:///C:/Documents/my_file.odt. Whenever possible consider using the URL notation because it is a more portable alternative." +msgid "This method can be used to remove any menu entry from the document window, including default menus. However, none of these changes in the menubar are saved to the document or to the application settings. To restore the menubar to the default settings, simply close and reopen the document window." msgstr "" -#. QrDqQ -#: sf_filesystem.xhp +#. E6ahL +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id931626652451855\n" +"sf_document.xhp\n" +"par_id361589200121156\n" "help.text" -msgid "The use of the shortcut \"~\" (tilde), which is common in Linux-based operating systems, is not supported to express a path to a folder and file name. Instead of using \"~/Documents/my_file.odt\" use the full path \"/home/user/Documents/my_file.odt\"." +msgid "menuheader: The toplevel name of the menu to be removed." msgstr "" -#. mao7x -#: sf_filesystem.xhp +#. yRoDW +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"hd_id581582885621841\n" +"sf_document.xhp\n" +"bas_id391643120223147\n" "help.text" -msgid "Service invocation" +msgid "oDoc.RemoveMenu(\"My Menu\")" msgstr "" -#. Miw3e -#: sf_filesystem.xhp +#. BnmiF +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id691612990276070\n" +"sf_document.xhp\n" +"pyc_id221622827946338\n" "help.text" -msgid "The following code snippet invokes the FileSystem service. The method BuildPath was used as an example." +msgid "doc.RemoveMenu(\"My Menu\")" msgstr "" -#. MJbkm -#: sf_filesystem.xhp +#. Ab7PE +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"hd_id981689594663689\n" +"sf_document.xhp\n" +"par_id991589202413257\n" "help.text" -msgid "Accessing the Virtual File System of a Document" +msgid "Runs a UNO command on the document window associated with the service instance. A few typical commands are: Save, SaveAs, ExportToPDF, Undo, Copy, Paste, etc." msgstr "" -#. LyBAJ -#: sf_filesystem.xhp +#. qBhYc +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id661689594721047\n" +"sf_document.xhp\n" +"par_id261589202778896\n" "help.text" -msgid "%PRODUCTNAME document files are compressed ZIP files that contain the files and folders that represent the actual document contents. While the document is open, it is possible to access this virtual file system, explore its structure, as well as read and create files and folders." +msgid "The document itself does not need to be active to be able to run commands." msgstr "" -#. YHDGU -#: sf_filesystem.xhp +#. 9FuBU +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id891689594949717\n" +"sf_document.xhp\n" +"par_id921611152932311\n" "help.text" -msgid "The following example shows how to create a text file named myFile.txt and store it inside the document's virtual file system." +msgid "Commands can be run with or without arguments. Arguments are not validated before running the command. If the command or its arguments are invalid, then nothing will happen." msgstr "" -#. rsRAs -#: sf_filesystem.xhp +#. xgByz +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"bas_id661689595249846\n" +"sf_document.xhp\n" +"par_id31644182402479\n" "help.text" -msgid "' Gets the URL path notation to the root of the virtual file system" +msgid "For a complete list of UNO commands that can be run in %PRODUCTNAME, refer to the Wiki page Development/DispatchCommands." msgstr "" -#. TG5wG -#: sf_filesystem.xhp +#. HBVsV +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"bas_id941689595087305\n" +"sf_document.xhp\n" +"par_id401589202413575\n" "help.text" -msgid "' Creates the folder \"myDir\" if it does not exist" +msgid "command: Case-sensitive string containing the UNO command name. The inclusion of the prefix \".uno:\" in the command is optional. The command itself is not checked for correctness. If nothing happens after the command call, then the command is probably wrong." msgstr "" -#. 2usN3 -#: sf_filesystem.xhp +#. xi32t +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"bas_id911689595459107\n" +"sf_document.xhp\n" +"par_id521644182774710\n" "help.text" -msgid "' Creates the file and write some text into it" +msgid "args: For each argument to be passed to the command, specify a pair containing the argument name and value." msgstr "" -#. 75XUC -#: sf_filesystem.xhp +#. MqEx7 +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id121689595522630\n" +"sf_document.xhp\n" +"par_id721611153068137\n" "help.text" -msgid "In general, all methods of the FileSystem service can be used to manipulate files in the document's virtual file system. However, the following restrictions apply:" +msgid "The following example runs the SelectData command in a Calc file named \"MyFile.ods\", which will result in the selection of the data area based on the currently selected cell. Note that this command does not require any arguments." msgstr "" -#. Du7UF -#: sf_filesystem.xhp +#. GGDgF +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321689595825516\n" +"sf_document.xhp\n" +"par_id371644184276886\n" "help.text" -msgid "It is not possible to create files in the root folder. Use existing subfolders or create new folders to store files in the document's file system." +msgid "Below is an example that runs the UNO command ReplaceAll and passes values for its arguments SearchString and ReplaceString. Running this command will replace all occurrence of the string \"abc\" by \"ABC\" in the current sheet." msgstr "" -#. vsqoB -#: sf_filesystem.xhp +#. Z4Egf +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id861689595826432\n" +"sf_document.xhp\n" +"bas_id631644184414955\n" "help.text" -msgid "The FileNaming notation is always considered to be \"URL\"." +msgid "' Arguments passed to the command:" msgstr "" -#. CbqEb -#: sf_filesystem.xhp +#. H5eQ9 +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id181689595826743\n" +"sf_document.xhp\n" +"par_id41644184549167\n" "help.text" -msgid "The methods CompareFiles, GetFileModified, HashFile, PickFile and PickFolder are not applicable." +msgid "Note that calling the command ReplaceAll without arguments will open the Find and Replace dialog." msgstr "" -#. AuBgo -#: sf_filesystem.xhp +#. Cp7Wk +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id361689595827152\n" +"sf_document.xhp\n" +"par_id811644243228448\n" "help.text" -msgid "The method GetFileLen always returns zero." +msgid "In Python it is also possible to call RunCommand using keyword arguments:" msgstr "" -#. WJsDa -#: sf_filesystem.xhp +#. m9AyA +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id131689596237329\n" +"sf_document.xhp\n" +"par_id191611153511038\n" "help.text" -msgid "The method Normalize always returns the input string unchanged." +msgid "Each %PRODUCTNAME component has its own set of commands available. One easy way to learn commands is going to Tools - Customize - Keyboard. When you position your mouse over a function in the Function list, a tooltip will appear with the corresponding UNO command." msgstr "" -#. GJMuQ -#: sf_filesystem.xhp +#. enSv9 +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id51689595641705\n" +"sf_document.xhp\n" +"par_id81589202925519\n" "help.text" -msgid "The path to the virtual file system is not a physical address on the computer's hard drive. It can only be accessed from within a %PRODUCTNAME script and it only exists while the document file is open." +msgid "Stores the document to the file location from which it was loaded. The method is ignored if the document was not modified." msgstr "" -#. Gsznv -#: sf_filesystem.xhp +#. sFUcr +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"hd_id651583668365757\n" +"sf_document.xhp\n" +"par_id731611153918907\n" "help.text" -msgid "Properties" +msgid "Returns False if the document could not be saved. An error is raised if the file is open as read-only, or if it is a new file that has not been saved yet." msgstr "" -#. QFtWW -#: sf_filesystem.xhp +#. Ys5oF +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id871583668386455\n" +"sf_document.xhp\n" +"par_id211589203690937\n" "help.text" -msgid "Name" +msgid "The document itself does not need to be active to run this method." msgstr "" -#. iXYjt -#: sf_filesystem.xhp +#. 75K92 +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id491583668386455\n" +"sf_document.xhp\n" +"par_id121589203370778\n" "help.text" -msgid "Readonly" +msgid "Stores the document to the given file location. The new location becomes the new file name on which simple Save method calls will be applied." msgstr "" -#. GC4Vu -#: sf_filesystem.xhp +#. R8D2A +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id271583668474014\n" +"sf_document.xhp\n" +"par_id31611154475602\n" "help.text" -msgid "Type" +msgid "Returns False if the document could not be saved. An error is raised when overwriting the destination is rejected or when the destination has its read-only attribute set." msgstr "" -#. FFkx3 -#: sf_filesystem.xhp +#. GAAfy +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id401583668386455\n" +"sf_document.xhp\n" +"par_id391589203370902\n" "help.text" -msgid "Description" +msgid "The document itself does not need to be active to run this method." msgstr "" -#. CyEEJ -#: sf_filesystem.xhp +#. 7tX6c +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id371583668519172\n" +"sf_document.xhp\n" +"par_id331589203370950\n" "help.text" -msgid "No" +msgid "filename: A string containing the file name to be used. It must follow the SF_FileSystem.FileNaming notation." msgstr "" -#. Gihmg -#: sf_filesystem.xhp +#. niFkh +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id771583668386455\n" +"sf_document.xhp\n" +"par_id631589204010142\n" "help.text" -msgid "Sets or returns the current files and folders notation, either \"ANY\", \"URL\" or \"SYS\":" +msgid "overwrite: If True, the destination file may be overwritten (default = False)." msgstr "" -#. QQGcp -#: sf_filesystem.xhp +#. snX8q +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id881585396501844\n" +"sf_document.xhp\n" +"par_id811589204084107\n" "help.text" -msgid "\"ANY\": (default) the methods of the FileSystem service accept both URL and current operating system's notation for input arguments but always return URL strings." +msgid "password (*): A non-space string to protect the document." msgstr "" -#. 6FA2G -#: sf_filesystem.xhp +#. g3wDy +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id261583669091722\n" +"sf_document.xhp\n" +"par_id451589204163772\n" "help.text" -msgid "\"URL\": the methods of the FileSystem service expect URL notation for input arguments and return URL strings." +msgid "filtername (*): The name of a filter that should be used for saving the document. If this argument is passed, then the filter must exist." msgstr "" -#. QxFC6 -#: sf_filesystem.xhp +#. qZaAJ +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id731583669120436\n" +"sf_document.xhp\n" +"par_id981589204207800\n" "help.text" -msgid "\"SYS\": the methods of the FileSystem service expect current operating system's notation for both input arguments and return strings." +msgid "filteroptions (*): An optional string of options associated with the filter." msgstr "" -#. VBAzn -#: sf_filesystem.xhp +#. FJywB +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id211583765169579\n" +"sf_document.xhp\n" +"par_id911589205147502\n" "help.text" -msgid "Once set, the FileNaming property remains unchanged either until the end of the %PRODUCTNAME session or until it is set again." +msgid "Stores a copy of or export the document to the given file location. The actual location is unchanged." msgstr "" -#. FayZT -#: sf_filesystem.xhp +#. ovvew +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id541583839708548\n" +"sf_document.xhp\n" +"par_id381611154800685\n" "help.text" -msgid "Yes" +msgid "Returns False if the document could not be saved. An error is raised when overwriting the destination is rejected or when the destination has its read-only attribute set." msgstr "" -#. ygE64 -#: sf_filesystem.xhp +#. BFKFn +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id731583839708412\n" +"sf_document.xhp\n" +"par_id11589205147643\n" "help.text" -msgid "Returns the configuration folder of %PRODUCTNAME." +msgid "The document itself does not need to be active to run this method." msgstr "" -#. svPxn -#: sf_filesystem.xhp +#. FAjhF +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id761584027709516\n" +"sf_document.xhp\n" +"par_id301589205147697\n" "help.text" -msgid "Yes" +msgid "filename: A string containing the file name to be used. It must follow the SF_FileSystem.FileNaming notation." msgstr "" -#. gjTpP -#: sf_filesystem.xhp +#. zr6Rx +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id971584027709752\n" +"sf_document.xhp\n" +"par_id851589205147348\n" "help.text" -msgid "Returns the folder where extensions are installed." +msgid "overwrite: If True, the destination file may be overwritten (default = False)." msgstr "" -#. DTGEP -#: sf_filesystem.xhp +#. k2uRD +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id31583839767743\n" +"sf_document.xhp\n" +"par_id821589205147330\n" "help.text" -msgid "Yes" +msgid "password (*): A non-space string to protect the document." msgstr "" -#. FP6D9 -#: sf_filesystem.xhp +#. eyrsV +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id111583839767195\n" +"sf_document.xhp\n" +"par_id67158920514729\n" "help.text" -msgid "Returns the user home folder." +msgid "filtername (*): The name of a filter that should be used for saving the document. If this argument is passed, then the filter must exist." msgstr "" -#. LUE79 -#: sf_filesystem.xhp +#. vA4NU +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id771583839920487\n" +"sf_document.xhp\n" +"par_id881589205147911\n" "help.text" -msgid "Yes" +msgid "filteroptions (*): An optional string of options associated with the filter." msgstr "" -#. dz5ju -#: sf_filesystem.xhp +#. 96EBt +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id451583839920858\n" +"sf_document.xhp\n" +"par_id911298505147502\n" "help.text" -msgid "Returns the installation folder of %PRODUCTNAME." +msgid "Defines the printer options for the document." msgstr "" -#. trBL7 -#: sf_filesystem.xhp +#. zoaQX +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id571588333908716\n" +"sf_document.xhp\n" +"par_id381651114800685\n" "help.text" -msgid "Yes" +msgid "Returns True when successful." msgstr "" -#. 3yNj2 -#: sf_filesystem.xhp +#. hGfVh +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id721588333908708\n" +"sf_document.xhp\n" +"par_id301589205741697\n" "help.text" -msgid "Returns the folder containing the system templates files." +msgid "printer: The name of the printer queue where to print to. When absent, the default printer is set." msgstr "" -#. hDFSQ -#: sf_filesystem.xhp +#. mRrfG +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id501583774433513\n" +"sf_document.xhp\n" +"par_id851985205147348\n" "help.text" -msgid "Yes" +msgid "orientation: Either PORTRAIT or LANDSCAPE. When absent, left unchanged with respect to the printer settings." msgstr "" -#. e2ruR -#: sf_filesystem.xhp +#. ENyZH +#: sf_document.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id71583774433459\n" +"sf_document.xhp\n" +"par_id821985205147330\n" "help.text" -msgid "Returns the temporary files folder defined in the %PRODUCTNAME path settings." +msgid "paperformat: Specifies the paper format as a string value that can be either A3, A4, A5, LETTER, LEGAL or TABLOID. Left unchanged when absent." msgstr "" -#. wjVgE -#: sf_filesystem.xhp +#. WCH7E +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id271588334016191\n" +"sf_exception.xhp\n" +"tit\n" "help.text" -msgid "Yes" +msgid "ScriptForge.Exception service (SF_Exception)" msgstr "" -#. Ggnnt -#: sf_filesystem.xhp +#. PPqb2 +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id251588334016874\n" +"sf_exception.xhp\n" +"hd_id521580038927003\n" "help.text" -msgid "Returns the folder containing the user-defined template files." +msgid "ScriptForge.Exception service" msgstr "" -#. rpvtx -#: sf_filesystem.xhp +#. 4X7Xk +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id891611613601554\n" +"sf_exception.xhp\n" +"par_id181587139648008\n" "help.text" -msgid "List of Methods in the FileSystem Service" +msgid "The Exception service is a collection of methods to assist in code debugging in Basic and Python scripts and in error handling in Basic scripts." msgstr "" -#. EgkPG -#: sf_filesystem.xhp +#. XeYa4 +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id871583933076448\n" +"sf_exception.xhp\n" +"par_id141587140927573\n" "help.text" -msgid "Joins a folder path and the name of a file and returns the full file name with a valid path separator. The path separator is added only if necessary." +msgid "In Basic scripts, when a run-time error occurs, the methods and properties of the Exception service help identify the error context and allow to handle it." msgstr "" -#. 2pwBF -#: sf_filesystem.xhp +#. zF4vz +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id90158393307695\n" +"sf_exception.xhp\n" +"par_id401621450898070\n" "help.text" -msgid "foldername: The path with which name will be combined. The specified path does not need to be an existing folder." +msgid "The SF_Exception service is similar to the VBA Err object." msgstr "" -#. xFCWJ -#: sf_filesystem.xhp +#. vpB42 +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id891583933076975\n" +"sf_exception.xhp\n" +"par_id361621450908874\n" "help.text" -msgid "name: The name of the file to be appended to foldername. This parameter uses the notation of the current operating system." +msgid "The Number property identifies the error." msgstr "" -#. DwTpc -#: sf_filesystem.xhp +#. TnWpD +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id33160111891079\n" +"sf_exception.xhp\n" +"par_id861621450910254\n" "help.text" -msgid "Compares two files and returns True when they seem identical." +msgid "Use the Raise method to interrupt processing. The RaiseWarning method can be used to trap an anomaly without interrupting the macro execution." msgstr "" -#. 6A5Da -#: sf_filesystem.xhp +#. CpxKC +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id631601119001315\n" +"sf_exception.xhp\n" +"par_id621587225732733\n" "help.text" -msgid "Depending on the value of the comparecontents argument, the comparison between both files can be either based only on file attributes (such as the last modified date), or based on the file contents." +msgid "Errors and warnings raised with the Exception service are stored in memory and can be retrieved using the Console method." msgstr "" -#. MGA4A -#: sf_filesystem.xhp +#. ioDzp +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id481601118910755\n" +"sf_exception.xhp\n" +"par_id411587141146677\n" "help.text" -msgid "filename1, filename2: The files to compare." +msgid "The Exception service console stores events, variable values and information about errors. Use the console when the Basic IDE is not easily accessible, for example in Calc user defined functions (UDF) or during events processing." msgstr "" -#. aKfwh -#: sf_filesystem.xhp +#. NrY9C +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id111601118910848\n" +"sf_exception.xhp\n" +"par_id251621034725811\n" "help.text" -msgid "comparecontents: When True, the contents of the files are compared (default = False)." +msgid "Use the DebugPrint method to add any relevant information to the console. Console entries can be dumped to a text file or visualized in a dialog window." msgstr "" -#. EZNG5 -#: sf_filesystem.xhp +#. 9AW2i +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id161584541257982\n" +"sf_exception.xhp\n" +"par_id111587141158495\n" "help.text" -msgid "Copies one or more files from one location to another. Returns True if at least one file has been copied or False if an error occurred." +msgid "When an error occurs, an application macro may:" msgstr "" -#. xE9SU -#: sf_filesystem.xhp +#. hxxxr +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id401612998805699\n" +"sf_exception.xhp\n" +"par_id451587141202844\n" "help.text" -msgid "An error will also occur if the source parameter uses wildcard characters and does not match any files." +msgid "Report the error in the Exception console" msgstr "" -#. AZCsn -#: sf_filesystem.xhp +#. N9X2f +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id331612998814805\n" +"sf_exception.xhp\n" +"par_id751587141235313\n" "help.text" -msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." +msgid "Inform the user about the error using either a standard message or a custom message" msgstr "" -#. aVGzZ -#: sf_filesystem.xhp +#. C3NMD +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id1001584541257789\n" +"sf_exception.xhp\n" +"par_id931587141260777\n" "help.text" -msgid "source: It can be a FileName or a NamePattern indicating one or more files to be copied." +msgid "Optionally stop its execution" msgstr "" -#. ycEpt -#: sf_filesystem.xhp +#. vFJRL +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id111584542310166\n" +"sf_exception.xhp\n" +"par_id771621035263403\n" "help.text" -msgid "destination: It can be either a FileName specifying where the single source file is to be copied, or a FolderName into which the multiple files from source are to be copied." +msgid "In Python scripts the Exception service is mostly used for debugging purposes. Methods such as DebugPrint, Console and DebugDisplay are useful to quickly print messages, log data and open the console window from within a Python script." msgstr "" -#. frwD2 -#: sf_filesystem.xhp +#. VAaLU +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id491612999134752\n" +"sf_exception.xhp\n" +"par_id211621035276160\n" "help.text" -msgid "If destination does not exist, it is created." +msgid "Not all methods and properties are available for Python scripts since the Python language already has a comprehensive exception handling system." msgstr "" -#. z3Tok -#: sf_filesystem.xhp +#. yQzKr +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id591612999166788\n" +"sf_exception.xhp\n" +"hd_id201586594659135\n" "help.text" -msgid "Wildcard characters are not allowed in destination." +msgid "Service invocation" msgstr "" -#. zFyVX -#: sf_filesystem.xhp +#. T8o7G +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id251584542431558\n" +"sf_exception.xhp\n" +"par_id161610652161795\n" "help.text" -msgid "overwrite: If True (default), files may be overwritten. The method will fail if destination is readonly, regardless of the value specified in overwrite." +msgid "The following examples show three different approaches to call the method Raise. All other methods can be executed in a similar fashion." msgstr "" -#. uRMe8 -#: sf_filesystem.xhp +#. tGmaZ +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id691626216252568\n" +"sf_exception.xhp\n" +"par_id901621036227048\n" "help.text" -msgid "In the examples below the first line copies a single file whereas the second line copies multiple files using wildcards." +msgid "The code snippet below creates an instance of the Exception service, logs a message and displays the Console window." msgstr "" -#. 7xndg -#: sf_filesystem.xhp +#. HABsh +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id411626216328023\n" +"sf_exception.xhp\n" +"hd_id651584978211886\n" "help.text" -msgid "Be aware that subfolders and their contents are not copied when wildcards are used in the source argument." +msgid "Properties" msgstr "" -#. TdGi7 -#: sf_filesystem.xhp +#. JDNi6 +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id731584544734412\n" +"sf_exception.xhp\n" +"par_id911621036526404\n" "help.text" -msgid "Copies one or more folders from one location to another. Returns True if at least one folder has been copied or False if an error occurred." +msgid "The properties listed below are only available for Basic scripts." msgstr "" -#. TSLCU -#: sf_filesystem.xhp +#. s3E9G +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id21612999775377\n" +"sf_exception.xhp\n" +"par_id271584978211792\n" "help.text" -msgid "An error will also occur if the source parameter uses wildcard characters and does not match any folders." +msgid "Name" msgstr "" -#. m3Hzh -#: sf_filesystem.xhp +#. b96rE +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id701612999808912\n" +"sf_exception.xhp\n" +"par_id241584978211550\n" "help.text" -msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." +msgid "Readonly" msgstr "" -#. GCCf3 -#: sf_filesystem.xhp +#. TkMLa +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id851584544734202\n" +"sf_exception.xhp\n" +"par_id621584978211403\n" "help.text" -msgid "source: It can be a FolderName or a NamePattern indicating one or more folders to be copied." +msgid "Description" msgstr "" -#. msqGq -#: sf_filesystem.xhp +#. tJZkJ +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id321584544734273\n" +"sf_exception.xhp\n" +"par_id71584978715562\n" "help.text" -msgid "destination: Specifies the FolderName into which the single or multiple folders defined in source are to be copied." +msgid "No" msgstr "" -#. iLKYc -#: sf_filesystem.xhp +#. RyJkE +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id491612999134762\n" +"sf_exception.xhp\n" +"par_id581584978715701\n" "help.text" -msgid "If destination does not exist, it is created." +msgid "The error message text." msgstr "" -#. TvYDS -#: sf_filesystem.xhp +#. Wcy7s +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id591612999166740\n" +"sf_exception.xhp\n" +"par_id241610652688334\n" "help.text" -msgid "Wildcard characters are not allowed in destination." +msgid "Default value is \"\" or a string containing the Basic run-time error message." msgstr "" -#. 3A2C2 -#: sf_filesystem.xhp +#. BT7GF +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id251584542431525\n" +"sf_exception.xhp\n" +"par_id211584978211383\n" "help.text" -msgid "overwrite: If True (default), files may be overwritten. The method will fail if destination is readonly, regardless of the value specified in overwrite." +msgid "No" msgstr "" -#. 7CxBB -#: sf_filesystem.xhp +#. AnFVG +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id751626216627481\n" +"sf_exception.xhp\n" +"par_id691584978211774\n" "help.text" -msgid "In the examples below all files, folders and subfolders are copied." +msgid "The code of the error. It can be a numeric value or text." msgstr "" -#. fNBgH -#: sf_filesystem.xhp +#. dCADC +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id31158454067562\n" +"sf_exception.xhp\n" +"par_id151610652632828\n" "help.text" -msgid "Creates the specified FolderName. Returns True if the folder could be successfully created." +msgid "Default value is 0 or the numeric value corresponding to the Basic run-time error code." msgstr "" -#. 9H3cp -#: sf_filesystem.xhp +#. uLE2Q +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id431613000475359\n" +"sf_exception.xhp\n" +"par_id671584978666689\n" "help.text" -msgid "If the specified folder has a parent folder that does not exist, it is created." +msgid "No" msgstr "" -#. 7gTts -#: sf_filesystem.xhp +#. G3q2n +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id491584540675469\n" +"sf_exception.xhp\n" +"par_id951584978666296\n" "help.text" -msgid "foldername: A string representing the folder to be created. If the folder already exists, an exception will be raised." +msgid "The location in the code where the error occurred. It can be a numeric value or text." msgstr "" -#. 2zcfH -#: sf_filesystem.xhp +#. kBXGC +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id731585322689518\n" +"sf_exception.xhp\n" +"par_id681610652723345\n" "help.text" -msgid "Creates a specified file and returns a TextStream service instance that can be used to write to the file." +msgid "Default value is 0 or the code line number for a standard Basic run-time error." msgstr "" -#. YMZDA -#: sf_filesystem.xhp +#. mnFGS +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id821613001057759\n" +"sf_exception.xhp\n" +"par_id461584978880380\n" "help.text" -msgid "The method returns a Null object if an error occurred." +msgid "Raising or clearing an Exception resets its properties." msgstr "" -#. 2NPVD -#: sf_filesystem.xhp +#. ssXEB +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id901585322689715\n" +"sf_exception.xhp\n" +"par_id881608131596153\n" "help.text" -msgid "filename: The name of the file to be created." +msgid "List of Methods in the Exception Service" msgstr "" -#. gEJA4 -#: sf_filesystem.xhp +#. CDgEM +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id501585322689209\n" +"sf_exception.xhp\n" +"par_id271579683706571\n" "help.text" -msgid "overwrite: Boolean value that determines if filename can be overwritten (default = True)." +msgid "Resets the current error status and clears the SF_Exception properties." msgstr "" -#. CkbhC -#: sf_filesystem.xhp +#. 7jFLi +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id551585322689192\n" +"sf_exception.xhp\n" +"par_id701610654263121\n" "help.text" -msgid "encoding: The character set to be used. The default encoding is \"UTF-8\"." +msgid "The following example shows how to catch a division-by-zero exception, whose error code is 11." msgstr "" -#. z3d9F -#: sf_filesystem.xhp +#. JhADn +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id141613001281573\n" +"sf_exception.xhp\n" +"bas_id51587215508130\n" "help.text" -msgid "To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets." +msgid "'If division by zero, ignore the error" msgstr "" -#. DVGxr -#: sf_filesystem.xhp +#. DHZ5A +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id11584882040881\n" +"sf_exception.xhp\n" +"par_id201610654368082\n" "help.text" -msgid "Deletes one or more files. Returns True if at least one file has been deleted or False if an error occurred." +msgid "For a complete list of Basic run-time error codes, refer to Debugging a Basic Program." msgstr "" -#. y69YZ -#: sf_filesystem.xhp +#. efEEX +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id21612999775356\n" +"sf_exception.xhp\n" +"par_id651598718179382\n" "help.text" -msgid "An error will also occur if the filename parameter uses wildcard characters and does not match any files." +msgid "Displays the console messages in a modal or non-modal dialog. In both modes, all the past messages issued by a DebugPrint() method or resulting from an exception are displayed. In non-modal mode, subsequent entries are added automatically." msgstr "" -#. TWJRd -#: sf_filesystem.xhp +#. KKgdp +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id21613001848493\n" +"sf_exception.xhp\n" +"par_id161598718286205\n" "help.text" -msgid "The files to be deleted must not be readonly." +msgid "If the console is already open, when non-modal, it is brought to the front." msgstr "" -#. PEFBq -#: sf_filesystem.xhp +#. ypzYc +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id701612999808832\n" +"sf_exception.xhp\n" +"par_id801598718629151\n" "help.text" -msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." +msgid "A modal console can only be closed by the user. A non-modal console can either be closed by the user or upon macro termination." msgstr "" -#. DkCdk -#: sf_filesystem.xhp +#. HUgnb +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id441584882040860\n" +"sf_exception.xhp\n" +"par_id511598718179819\n" "help.text" -msgid "filename: It can be a FileName or a NamePattern indicating one or more files to be deleted." +msgid "modal: Determine if the console window is modal (True) or non-modal (False). Default value is True." msgstr "" -#. FnaSi -#: sf_filesystem.xhp +#. xu6FA +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id851626217167909\n" +"sf_exception.xhp\n" +"par_id641587215098903\n" "help.text" -msgid "In the examples below only files are deleted, subfolders are not deleted." +msgid "Clears the console keeping an optional number of recent messages. If the console is activated in non-modal mode, it is refreshed." msgstr "" -#. c9ZCd -#: sf_filesystem.xhp +#. SE7ei +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id11584882015881\n" +"sf_exception.xhp\n" +"par_id351587215098527\n" "help.text" -msgid "Deletes one or more folders. Returns True if at least one folder has been deleted or False if an error occurred." +msgid "keep: The number of recent messages to be kept. Default value is 0." msgstr "" -#. bGmGo -#: sf_filesystem.xhp +#. GLEVv +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id21612999775346\n" +"sf_exception.xhp\n" +"par_id521610655023824\n" "help.text" -msgid "An error will also occur if the foldername parameter uses wildcard characters and does not match any folders." +msgid "The following example clears the console keeping the 10 most recent messages." msgstr "" -#. GsqDD -#: sf_filesystem.xhp +#. 4LD2d +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id21613001848853\n" +"sf_exception.xhp\n" +"par_id281587218077400\n" "help.text" -msgid "The folders to be deleted must not be readonly." +msgid "Exports the contents of the console to a text file. If the file already exists and the console is not empty, it will be overwritten without warning. Returns True if successful." msgstr "" -#. kRSqe -#: sf_filesystem.xhp +#. cAusu +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id701612999808842\n" +"sf_exception.xhp\n" +"par_id851587218077862\n" "help.text" -msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." +msgid "filename: The name of the text file the console should be dumped into. The name is expressed according to the current FileNaming property of the SF_FileSystem service. By default, URL notation and the native operating system's format are both admitted." msgstr "" -#. 7YCXM -#: sf_filesystem.xhp +#. F3tVM +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id451584882542247\n" +"sf_exception.xhp\n" +"par_id701621043185177\n" "help.text" -msgid "foldername: It can be a FolderName or a NamePattern indicating one or more folders to be deleted." +msgid "Concatenates all the arguments into a single human-readable string and displays it in a MsgBox with an Information icon and an OK button." msgstr "" -#. cCnG9 -#: sf_filesystem.xhp +#. KaGM6 +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id651626217314709\n" +"sf_exception.xhp\n" +"par_id791621097689492\n" "help.text" -msgid "In the examples below only folders and their contents are deleted. Files in the parent folder \"C:\\Temp\" are not deleted." +msgid "The final string is also added to the Console." msgstr "" -#. gSG9s -#: sf_filesystem.xhp +#. QhRgF +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id11584882015025\n" +"sf_exception.xhp\n" +"par_id481587218636884\n" "help.text" -msgid "Returns a string containing the folder where the specified extension package is installed." +msgid "arg0[, arg1, ...]: Any number of arguments of any type." msgstr "" -#. pJWi2 -#: sf_filesystem.xhp +#. 2qser +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id711658780480236\n" +"sf_exception.xhp\n" +"par_id281587218637490\n" "help.text" -msgid "The current value of the property SF_FileSystem.FileNaming is used to determine the notation of the returned string." +msgid "Assembles all the given arguments into a single human-readable string and adds it as a new entry in the console." msgstr "" -#. 3R4jx -#: sf_filesystem.xhp +#. mUSEP +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id891644442917193\n" +"sf_exception.xhp\n" +"par_id481587218637988\n" "help.text" -msgid "Use the property Extensions from the Platform service to get string array with the IDs of all installed extensions." +msgid "arg0[, arg1, ...]: Any number of arguments of any type." msgstr "" -#. w9vDF -#: sf_filesystem.xhp +#. sCSES +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id451584882542121\n" +"sf_exception.xhp\n" +"par_id111621624672183\n" "help.text" -msgid "extension: A string value with the ID of the extension. If the extension is not installed, an exception is raised." +msgid "Displays the list of arguments in a readable form in the platform console. Arguments are separated by a TAB character (simulated by spaces)." msgstr "" -#. YhQmv -#: sf_filesystem.xhp +#. ujSFu +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id651626217313369\n" +"sf_exception.xhp\n" +"par_id841621426229467\n" "help.text" -msgid "The examples below in Basic and Python return the folder where the APSO extension is installed." +msgid "The same string is added to the ScriptForge debug console." msgstr "" -#. ZbyLn -#: sf_filesystem.xhp +#. kzBDb +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id161583764426709\n" +"sf_exception.xhp\n" +"par_id551655563148866\n" "help.text" -msgid "Returns True if a given file name is valid and exists, otherwise the method returns False." +msgid "If Python shell (APSO) is active, PythonPrint content is written to APSO console in place of the platform console." msgstr "" -#. 7j5TN -#: sf_filesystem.xhp +#. ixNfF +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id91613003122613\n" +"sf_exception.xhp\n" +"par_id391126449167833\n" "help.text" -msgid "If the filename parameter is actually an existing folder name, the method returns False." +msgid "arg0[, arg1, ...]: Any number of arguments of any type. The maximum length of each individual argument is 1024 characters." msgstr "" -#. fr2Ei -#: sf_filesystem.xhp +#. U88JC +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id361583764426547\n" +"sf_exception.xhp\n" +"par_id261123015276160\n" "help.text" -msgid "filename: A string representing the file to be tested." +msgid "In Python use a print statement to print to the APSO console or use the DebugPrint method to print to ScriptForge's console." msgstr "" -#. ChDCL -#: sf_filesystem.xhp +#. CUoch +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id11158394432779\n" +"sf_exception.xhp\n" +"par_id111621426672183\n" "help.text" -msgid "Returns a zero-based array of the files stored in a given folder. Each entry in the array is a string containing the full path and file name." +msgid "Opens an APSO Python shell as a non-modal window. The Python script keeps running after the shell is opened. The output from print statements inside the script are shown in the shell." msgstr "" -#. JVjE3 -#: sf_filesystem.xhp +#. f9ZzM +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id641613003790120\n" +"sf_exception.xhp\n" +"par_id841621426922467\n" "help.text" -msgid "If the argument foldername specifies a folder that does not exist, an exception is raised." +msgid "Only a single instance of the APSO Python shell can be opened at any time. Hence, if a Python shell is already open, then calling this method will have no effect." msgstr "" -#. nFaPD -#: sf_filesystem.xhp +#. KGi8B +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id821613003779799\n" +"sf_exception.xhp\n" +"par_id391621449167833\n" "help.text" -msgid "The resulting list may be filtered with wildcards." +msgid "variables: a Python dictionary with variable names and values that will be passed on to the APSO Python shell. By default all local variables are passed using Python's builtin locals() function." msgstr "" -#. bq6vD -#: sf_filesystem.xhp +#. zT7Gq +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id731583944543140\n" +"sf_exception.xhp\n" +"par_id991621449657850\n" "help.text" -msgid "foldername: A string representing a folder. The folder must exist. This argument must not designate a file." +msgid "The example below opens the APSO Python shell passing all global and local variables considering the context where the script is running." msgstr "" -#. EM5cJ -#: sf_filesystem.xhp +#. yUoFK +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id591585648450060\n" +"sf_exception.xhp\n" +"par_id521621449800348\n" "help.text" -msgid "filter: A string containing wildcards (\"?\" and \"*\") that will be applied to the resulting list of files (default = \"\")." +msgid "When the APSO Python shell is open, any subsequent output printed by the script will be shown in the shell. Hence, the string printed in the example below will be displayed in the Python shell." msgstr "" -#. zG7ec -#: sf_filesystem.xhp +#. 5xNCX +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id51583765642590\n" +"sf_exception.xhp\n" +"pyc_id731621449899901\n" "help.text" -msgid "Returns True if the specified FolderName is valid and exists, otherwise the method returns False." +msgid "print(\"Hello world!\")" msgstr "" -#. 9xtCG -#: sf_filesystem.xhp +#. aXDEK +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id151613004111990\n" +"sf_exception.xhp\n" +"par_id541587219824771\n" "help.text" -msgid "If the foldername parameter is actually an existing file name, the method returns False." +msgid "Generates a run-time error. An error message is displayed to the user and reported in the console. The execution is stopped. The Raise() method can be placed inside the normal script flow or in a dedicated error-handling routine." msgstr "" -#. qrf4A -#: sf_filesystem.xhp +#. RuDTE +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id1001583765642211\n" +"sf_exception.xhp\n" +"par_id921587220542454\n" "help.text" -msgid "foldername: A string representing the folder to be tested." +msgid "The code snippets presented next are equivalent. They show alternative ways to raise an exception with code 2100." msgstr "" -#. eAFVs -#: sf_filesystem.xhp +#. 6wEJq +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id521584110618989\n" +"sf_exception.xhp\n" +"par_id851587219824597\n" "help.text" -msgid "Returns the BaseName (equal to the last component) of a folder or file name, without its extension." +msgid "Number: The error code, as a number or as a string. Default value is that of Err Basic builtin function." msgstr "" -#. YnBXv -#: sf_filesystem.xhp +#. 7zRRT +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id731613004316790\n" +"sf_exception.xhp\n" +"par_id461587220986452\n" "help.text" -msgid "The method does not check if the specified file or folder exists." +msgid "Source: The location of the error, as a number or as a string. Default value is that of Erl Basic builtin function." msgstr "" -#. 3FPjB -#: sf_filesystem.xhp +#. fSwCd +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id691584110618308\n" +"sf_exception.xhp\n" +"par_id721587221018162\n" "help.text" -msgid "filename: A string representing the file name and its path." +msgid "Description: The message to display to the user and to report in the console. Default value is that of Error$ Basic builtin function." msgstr "" -#. jwFaP -#: sf_filesystem.xhp +#. Kzh7r +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id1001626271201609\n" +"sf_exception.xhp\n" +"bas_id211587222852310\n" "help.text" -msgid "In the examples below, the first GetBaseName method call corresponds to a folder, so the function returns the last component of the path. The second call receives a file name as input, so the name of the file is returned without its extension." +msgid "'See variants below ..." msgstr "" -#. A56XC -#: sf_filesystem.xhp +#. DV6VJ +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id831584032680866\n" +"sf_exception.xhp\n" +"par_id111587222580987\n" "help.text" -msgid "Returns the extension part of a file or folder name without the dot \".\" character." +msgid "To raise an exception with the standard values:" msgstr "" -#. pdCJv -#: sf_filesystem.xhp +#. SABN3 +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id941613060736524\n" +"sf_exception.xhp\n" +"par_id751587222598238\n" "help.text" -msgid "The method does not check for the existence of the specified file or folder." +msgid "To raise an exception with a specific code:" msgstr "" -#. Aqvwt -#: sf_filesystem.xhp +#. QXgCy +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id561613060896361\n" +"sf_exception.xhp\n" +"par_id501587222607771\n" "help.text" -msgid "If this method is applied to a folder name or to a file without an extension, then an empty string is returned." +msgid "To replace the usual message:" msgstr "" -#. NzK5z -#: sf_filesystem.xhp +#. gdvqM +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id821584032680311\n" +"sf_exception.xhp\n" +"bas_id431587222670849\n" "help.text" -msgid "filename: A string representing the file name and its path." +msgid "SF_Exception.Raise(, , \"It is not a good idea to divide by zero.\")" msgstr "" -#. Am6Bu -#: sf_filesystem.xhp +#. TaFgn +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id48160068505010\n" +"sf_exception.xhp\n" +"par_id611587222617174\n" "help.text" -msgid "The builtin FileLen Basic function returns the number of bytes contained in a file as a Long value, i.e. up to 2GB." +msgid "To raise an application error:" msgstr "" -#. 2FHpa -#: sf_filesystem.xhp +#. ifrWg +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id571613061005426\n" +"sf_exception.xhp\n" +"bas_id71587222694657\n" "help.text" -msgid "The GetFileLen method can handle files with much larger sizes by returning a Currency value." +msgid "SF_Exception.Raise(\"MyAppError\", \"Example_Raise()\", \"Something wrong happened !\")" msgstr "" -#. PK2Fo -#: sf_filesystem.xhp +#. LuTSJ +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id161600685050367\n" +"sf_exception.xhp\n" +"par_id1001587224839900\n" "help.text" -msgid "filename: A string representing an existing file." +msgid "This method has exactly the same syntax, arguments and behavior as the Raise() method." msgstr "" -#. o2GGJ -#: sf_filesystem.xhp +#. AXEnW +#: sf_exception.xhp msgctxt "" -"sf_filesystem.xhp\n" -"par_id191584811478936\n" +"sf_exception.xhp\n" +"par_id761587224839624\n" "help.text" -msgid "Returns the last modified date of a given file." +msgid "However, when a warning is raised, the macro execution is not stopped." msgstr "" -#. VMB4i +#. QTGXf #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id25158481147822\n" +"tit\n" "help.text" -msgid "filename: A string representing an existing file." +msgid "ScriptForge.FileSystem service" msgstr "" -#. VEZR6 +#. P8P86 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id711584032366587\n" +"bm_id781582391760253\n" "help.text" -msgid "Returns the last component of a file or folder name in native operating system format." +msgid "ScriptForge.FileSystem service" msgstr "" -#. 4vAvz +#. wXVQJ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id541613061300811\n" +"par_id931583589764919\n" "help.text" -msgid "The method does not check if the specified file or folder exists." +msgid "The FileSystem service includes routines to handle files and folders. Next are some examples of the features provided by this service:" msgstr "" -#. iajZD +#. NtXUq #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id671584032366193\n" +"par_id121612917070593\n" "help.text" -msgid "filename: A string representing the file name and its path." +msgid "Verify whether a file or folder exists." msgstr "" -#. ffxFe +#. gqggf #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id871584113432747\n" +"par_id121612917070594\n" "help.text" -msgid "Returns a string containing the name of the parent folder of a specified file or folder name." +msgid "Create and delete folders and files." msgstr "" -#. 2eBgA +#. FFUnD #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id611613061603039\n" +"par_id121612917070595\n" "help.text" -msgid "The method does not check if the specified file or folder exists." +msgid "Launch dialog boxes to open/save files." msgstr "" -#. YUAQ3 +#. bgECC #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id471584113432231\n" +"par_id121612917070596\n" "help.text" -msgid "filename: A string with the file or folder name to be analyzed." +msgid "Access the list of files in a folder, etc." msgstr "" -#. Uc93M +#. 6TSXB #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id82158385117289\n" +"par_id121612917368946\n" "help.text" -msgid "Returns a randomly generated temporary file name that is useful for performing operations that require a temporary file." +msgid "The methods in the FileSystem service are mostly based on the XSimpleFileAccess UNO interface." msgstr "" -#. 7saEX +#. wEqaV #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id391613061770924\n" +"hd_id961583589783025\n" "help.text" -msgid "By default, the returned file name does not have an extension. Use the extension parameter to specify the extension of the file name to be generated." +msgid "Definitions" msgstr "" -#. FTQwD +#. bczfJ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id251689599133544\n" +"par_id821612988815351\n" "help.text" -msgid "The folder part of the returned string is the system's temporary folder." +msgid "The table below lists the main parameters used by most of the methods in the FileSystem service." msgstr "" -#. W7gF7 +#. fV4jz #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id971613061774934\n" +"par_id891612988600163\n" "help.text" -msgid "The method does not create the temporary file." +msgid "Parameter" msgstr "" -#. pDA3H +#. KdPjY #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id471584113435991\n" +"par_id711612988600163\n" "help.text" -msgid "extension: The extension of the temporary file name (Default = \"\")." +msgid "Description" msgstr "" -#. ch2AJ +#. dEUyj #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id58160104251423\n" +"par_id321612988600163\n" "help.text" -msgid "Hash functions are used by some cryptographic algorithms, in digital signatures, message authentication codes, fraud detection, fingerprints, checksums (message integrity check), hash tables, password storage and much more." +msgid "The full name of the file including the path without a path separator at the end." msgstr "" -#. qxDnP +#. Da76k #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id301601042791356\n" +"par_id321612988600165\n" "help.text" -msgid "The HashFile method returns the result of a hash function, applied on a given file and using a specified algorithm. The returned value is a string of lower-case hexadecimal digits." +msgid "The full name of the folder including the path. It may or may not contain the ending path separator." msgstr "" -#. eAW33 +#. LwB6Z #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id861601043268484\n" +"par_id321612988600167\n" "help.text" -msgid "The hash algorithms supported are: MD5, SHA1, SHA224, SHA256, SHA384 and SHA512." +msgid "The last component of the Folder Name or File Name including its extension. This parameter is always expressed using the native format of the operating system." msgstr "" -#. s5ZiA +#. fjYSD #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id28160104251451\n" +"par_id321612988600169\n" "help.text" -msgid "filename: A string representing an existing file." +msgid "The last component of the Folder Name or File Name without its extension." msgstr "" -#. Eomhm +#. 57Aab #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id71601042959846\n" +"par_id321612988600172\n" "help.text" -msgid "algorithm: One of the supported algorithms." +msgid "Any of the above names containing wildcards in its last component. Admitted wildcards are:" msgstr "" -#. HzFs2 +#. arzQR #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id51584791330688\n" +"par_id851583590809104\n" "help.text" -msgid "Moves one or more files from one location to another. Returns True if at least one file has been moved or False if an error occurred." +msgid "\"?\" represents any single character" msgstr "" -#. RFrNE +#. wG8Bw #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id631613062890648\n" +"par_id161583590819320\n" "help.text" -msgid "An error will also occur if the source parameter uses wildcard characters and does not match any files." +msgid "\"*\" represents zero, one, or multiple characters" msgstr "" -#. ETmEP +#. BjZMB #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id241613062902777\n" +"par_id911584540527980\n" "help.text" -msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." +msgid "The FileSystem service allows to perform operations over multiple files at the same time. By using name patterns, user scripts can copy, move or delete multiple files. Conversely, Basic built-in methods can only handle single files." msgstr "" -#. DbC6F +#. zNCtF #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id721584791330406\n" +"hd_id991612918109871\n" "help.text" -msgid "source: It can be a FileName or NamePattern to designate one or more files to be moved." +msgid "File Naming Notation" msgstr "" -#. BHa7Y +#. ZfsFV #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id291584791330181\n" +"par_id791612918141083\n" "help.text" -msgid "destination: If source is a FileName then this parameter indicates the new path and file name of the moved file." +msgid "The notation used to express file and folder names, both for arguments and returned values, is defined by the FileNaming property of the FileSystem service." msgstr "" -#. ZzA3Y +#. wZA9G #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id31613063334246\n" +"par_id951612918220255\n" "help.text" -msgid "If the move operation involves multiple files, then destination must be a folder name. If it does not exist, it is created." +msgid "In short, the possible representation types are \"URL\" (URL file notation), \"SYS\" (operating system notation) and \"ANY\" (default). See more information below." msgstr "" -#. 39oR8 +#. L84BJ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id391613063494599\n" +"par_id861583589907100\n" "help.text" -msgid "If source and destination have the same parent folder, the method will rename the source." +msgid "An example of the URL notation is file:///C:/Documents/my_file.odt. Whenever possible consider using the URL notation because it is a more portable alternative." msgstr "" -#. 7bzK4 +#. QrDqQ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id941613063476533\n" +"par_id931626652451855\n" "help.text" -msgid "Wildcard characters are not allowed in destination." +msgid "The use of the shortcut \"~\" (tilde), which is common in Linux-based operating systems, is not supported to express a path to a folder and file name. Instead of using \"~/Documents/my_file.odt\" use the full path \"/home/user/Documents/my_file.odt\"." msgstr "" -#. Bysqd +#. mao7x #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id91626272612758\n" +"hd_id581582885621841\n" "help.text" -msgid "In the following examples only files are moved, subfolders are not." +msgid "Service invocation" msgstr "" -#. iYBMe +#. Miw3e #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id301584791330868\n" +"par_id691612990276070\n" "help.text" -msgid "Moves one or more folders from one location to another. Returns True if at least one folder has been moved or False if an error occurred." +msgid "The following code snippet invokes the FileSystem service. The method BuildPath was used as an example." msgstr "" -#. RHjYG +#. MJbkm #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id411613072570664\n" +"hd_id981689594663689\n" "help.text" -msgid "An error will also occur if the source parameter uses wildcard characters and does not match any folders." +msgid "Accessing the Virtual File System of a Document" msgstr "" -#. F2DaD +#. LyBAJ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id601613072595264\n" +"par_id661689594721047\n" "help.text" -msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." +msgid "%PRODUCTNAME document files are compressed ZIP files that contain the files and folders that represent the actual document contents. While the document is open, it is possible to access this virtual file system, explore its structure, as well as read and create files and folders." msgstr "" -#. xVGBy +#. YHDGU #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id541584791330777\n" +"par_id891689594949717\n" "help.text" -msgid "source: It can be a FolderName or NamePattern to designate one or more folders to be moved." +msgid "The following example shows how to create a text file named myFile.txt and store it inside the document's virtual file system." msgstr "" -#. 4Ampu +#. rsRAs #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id551584791330279\n" +"bas_id661689595249846\n" "help.text" -msgid "destination: If the move operation involves a single folder, then destination is the name and path of the moved folder and it must not exist." +msgid "' Gets the URL path notation to the root of the virtual file system" msgstr "" -#. dD7SB +#. TG5wG #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id11613072890641\n" +"bas_id941689595087305\n" "help.text" -msgid "If multiple folders are being moved, then destination designates where the folders in source will be moved into. If destination does not exist, it is created." +msgid "' Creates the folder \"myDir\" if it does not exist" msgstr "" -#. A69QS +#. 2usN3 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id301613072928159\n" +"bas_id911689595459107\n" "help.text" -msgid "Wildcard characters are not allowed in destination." +msgid "' Creates the file and write some text into it" msgstr "" -#. DqpaF +#. 75XUC #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id871583670342051\n" +"par_id121689595522630\n" "help.text" -msgid "Returns a string containing the normalized path name by collapsing redundant separators and up-level references." +msgid "In general, all methods of the FileSystem service can be used to manipulate files in the document's virtual file system. However, the following restrictions apply:" msgstr "" -#. heCzw +#. Du7UF #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id541658780038027\n" +"par_id321689595825516\n" "help.text" -msgid "For instance, the path names A//B, A/B/, A/./B and A/foo/../B are all normalized to A/B." +msgid "It is not possible to create files in the root folder. Use existing subfolders or create new folders to store files in the document's file system." msgstr "" -#. A6mAb +#. vsqoB #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id881613074436118\n" +"par_id861689595826432\n" "help.text" -msgid "On Windows, forward slashes \"/\" are converted to backward slashes \"\\\"." +msgid "The FileNaming notation is always considered to be \"URL\"." msgstr "" -#. 56xkN +#. CbqEb #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id381658780455018\n" +"par_id181689595826743\n" "help.text" -msgid "The current value of the property SF_FileSystem.FileNaming is used to determine the notation of the filename argument as well as the format of the returned string." +msgid "The methods CompareFiles, GetFileModified, HashFile, PickFile and PickFolder are not applicable." msgstr "" -#. G9ARW +#. AuBgo #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id481583670340107\n" +"par_id361689595827152\n" "help.text" -msgid "filename: a string representing a valid path name. The file or directory represented by this argument may not exist." +msgid "The method GetFileLen always returns zero." msgstr "" -#. JNTia +#. WJsDa #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id121585320922117\n" +"par_id131689596237329\n" "help.text" -msgid "Opens a file and returns a TextStream object that can be used to read from, write to, or append to the file." +msgid "The method Normalize always returns the input string unchanged." msgstr "" -#. ePMpQ +#. GJMuQ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id591613073104711\n" +"par_id51689595641705\n" "help.text" -msgid "Note that the method does not check if the given file is really a text file." +msgid "The path to the virtual file system is not a physical address on the computer's hard drive. It can only be accessed from within a %PRODUCTNAME script and it only exists while the document file is open." msgstr "" -#. SGJCd +#. Gsznv #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id951613073135036\n" +"hd_id651583668365757\n" "help.text" -msgid "The method returns a Null object (in Basic) or None (in Python) if an error occurred." +msgid "Properties" msgstr "" -#. mxuwo +#. QFtWW #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id551585320922678\n" +"par_id871583668386455\n" "help.text" -msgid "filename: Identifies the file to open." +msgid "Name" msgstr "" -#. tsRLR +#. iXYjt #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id671585320922388\n" +"par_id491583668386455\n" "help.text" -msgid "iomode: Indicates the input/output mode. It can be one of three constants: svc.ForReading (default), svc.ForWriting, or svc.ForAppending." +msgid "Readonly" msgstr "" -#. z27vT +#. GC4Vu #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id21585321398586\n" +"par_id271583668474014\n" "help.text" -msgid "create: Boolean value that indicates whether a new file can be created if the specified filename doesn't exist:" +msgid "Type" msgstr "" -#. VDFAi +#. FFkx3 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id721613073434797\n" +"par_id401583668386455\n" "help.text" -msgid "If True a new file and its parent folders will be created if they do not exist;" +msgid "Description" msgstr "" -#. EypVC +#. CyEEJ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id201613073469289\n" +"par_id371583668519172\n" "help.text" -msgid "If False then new files are not created (default)." +msgid "No" msgstr "" -#. wjGYH +#. Gihmg #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id771585321576210\n" +"par_id771583668386455\n" "help.text" -msgid "encoding: The character set to be used. The default encoding is \"UTF-8\"." +msgid "Sets or returns the current files and folders notation, either \"ANY\", \"URL\" or \"SYS\":" msgstr "" -#. FuYwe +#. QQGcp #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id871583670342501\n" +"par_id881585396501844\n" "help.text" -msgid "Opens a dialog box to open or save files." +msgid "\"ANY\": (default) the methods of the FileSystem service accept both URL and current operating system's notation for input arguments but always return URL strings." msgstr "" -#. SjDBv +#. 6FA2G #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id881613074436979\n" +"par_id261583669091722\n" "help.text" -msgid "If the SAVE mode is set and the picked file exists, a warning message will be displayed." +msgid "\"URL\": the methods of the FileSystem service expect URL notation for input arguments and return URL strings." msgstr "" -#. YgsLZ +#. QxFC6 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id481583670342502\n" +"par_id731583669120436\n" "help.text" -msgid "defaultfile: This argument is a string composed of a folder and file name:" +msgid "\"SYS\": the methods of the FileSystem service expect current operating system's notation for both input arguments and return strings." msgstr "" -#. fyVCs +#. VBAzn #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id511613074665951\n" +"par_id211583765169579\n" "help.text" -msgid "The folder part indicates the folder that will be shown when the dialog opens (default = the last selected folder)." +msgid "Once set, the FileNaming property remains unchanged either until the end of the %PRODUCTNAME session or until it is set again." msgstr "" -#. xs5hU +#. FayZT #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id631613074685308\n" +"par_id541583839708548\n" "help.text" -msgid "The file part designates the default file to open or save." +msgid "Yes" msgstr "" -#. fBHyg +#. ygE64 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id981583670342502\n" +"par_id731583839708412\n" "help.text" -msgid "mode: A string value that can be either \"OPEN\" (for input files) or \"SAVE\" (for output files). The default value is \"OPEN\"." +msgid "Returns the configuration folder of %PRODUCTNAME." msgstr "" -#. uvwDP +#. svPxn #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id31583670342502\n" +"par_id761584027709516\n" "help.text" -msgid "filter: The extension of the files displayed when the dialog is opened (default = no filter)." +msgid "Yes" msgstr "" -#. niaGR +#. gjTpP #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id881626276134300\n" +"par_id971584027709752\n" "help.text" -msgid "The examples below open a file picker with the \"txt\" filter applied." +msgid "Returns the folder where extensions are installed." msgstr "" -#. HkwaR +#. DTGEP #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id521583671701777\n" +"par_id31583839767743\n" "help.text" -msgid "Opens a dialog box to select a folder." +msgid "Yes" msgstr "" -#. mG6QD +#. FP6D9 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id951583671701872\n" +"par_id111583839767195\n" "help.text" -msgid "defaultfolder: A string containing the folder name that will be displayed when the dialog is opened (default = the last selected folder)." +msgid "Returns the user home folder." msgstr "" -#. ymABK +#. LUE79 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id821583671701764\n" +"par_id771583839920487\n" "help.text" -msgid "freetext: Text to display in the dialog (default = \"\")." +msgid "Yes" msgstr "" -#. 4FFby +#. dz5ju #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"bas_id921583671701610\n" +"par_id451583839920858\n" "help.text" -msgid "aFolder = FSO.PickFolder(\"C:\\Documents\", \"Choose a folder or press Cancel\")" +msgid "Returns the installation folder of %PRODUCTNAME." msgstr "" -#. nW8Rx +#. trBL7 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"pyc_id631626276402296\n" +"par_id571588333908716\n" "help.text" -msgid "aFolder = fs.PickFolder(r\"C:\\Documents\", \"Choose a folder or press Cancel\")" +msgid "Yes" msgstr "" -#. xdfBh +#. 3yNj2 #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id431584016761996\n" +"par_id721588333908708\n" "help.text" -msgid "Returns a zero-based array of strings corresponding to the folders stored in a given foldername." +msgid "Returns the folder containing the system templates files." msgstr "" -#. LVNZq +#. hDFSQ #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id431613075267241\n" +"par_id501583774433513\n" "help.text" -msgid "The list may be filtered with wildcards." +msgid "Yes" msgstr "" -#. 7pDiA +#. e2ruR #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id701584016761945\n" +"par_id71583774433459\n" "help.text" -msgid "foldername: A string representing a folder. The folder must exist. foldername must not designate a file." +msgid "Returns the temporary files folder defined in the %PRODUCTNAME path settings." msgstr "" -#. Xmg8b +#. wjVgE #: sf_filesystem.xhp msgctxt "" "sf_filesystem.xhp\n" -"par_id471585648674921\n" +"par_id271588334016191\n" "help.text" -msgid "filter: A string containing wildcards (\"?\" and \"*\") that will be applied to the resulting list of folders (default = \"\")." +msgid "Yes" msgstr "" -#. XQG8t -#: sf_form.xhp +#. Ggnnt +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"tit\n" +"sf_filesystem.xhp\n" +"par_id251588334016874\n" "help.text" -msgid "SFDocuments.Form service" +msgid "Returns the folder containing the user-defined template files." msgstr "" -#. cFDGc -#: sf_form.xhp +#. rpvtx +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bm_id781582391760253\n" +"sf_filesystem.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "SFDocuments.Form service" +msgid "List of Methods in the FileSystem Service" msgstr "" -#. LDpRB -#: sf_form.xhp +#. EgkPG +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id931583589764919\n" +"sf_filesystem.xhp\n" +"par_id871583933076448\n" "help.text" -msgid "The Form service provides methods and properties to manage forms in %PRODUCTNAME documents. This service supports forms in Base, Calc and Writer documents and allows to:" +msgid "Joins a folder path and the name of a file and returns the full file name with a valid path separator. The path separator is added only if necessary." msgstr "" -#. U3zGB -#: sf_form.xhp +#. 2pwBF +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id381618172063851\n" +"sf_filesystem.xhp\n" +"par_id90158393307695\n" "help.text" -msgid "Open and activate forms." +msgid "foldername: The path with which name will be combined. The specified path does not need to be an existing folder." msgstr "" -#. SC6Yb -#: sf_form.xhp +#. xFCWJ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id261618172129782\n" +"sf_filesystem.xhp\n" +"par_id891583933076975\n" "help.text" -msgid "Navigate through records shown by the form." +msgid "name: The name of the file to be appended to foldername. This parameter uses the notation of the current operating system." msgstr "" -#. krQfB -#: sf_form.xhp +#. DwTpc +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id281618172141607\n" +"sf_filesystem.xhp\n" +"par_id33160111891079\n" "help.text" -msgid "Get access to the controls inside the form." +msgid "Compares two files and returns True when they seem identical." msgstr "" -#. itKdZ -#: sf_form.xhp +#. 6A5Da +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id371618172155483\n" +"sf_filesystem.xhp\n" +"par_id631601119001315\n" "help.text" -msgid "Get access to subforms of a parent form." +msgid "Depending on the value of the comparecontents argument, the comparison between both files can be either based only on file attributes (such as the last modified date), or based on the file contents." msgstr "" -#. QcJ24 -#: sf_form.xhp +#. MGA4A +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id351616768789190\n" +"sf_filesystem.xhp\n" +"par_id481601118910755\n" "help.text" -msgid "The SFDocuments.Form service is available from %PRODUCTNAME 7.2 onwards." +msgid "filename1, filename2: The files to compare." msgstr "" -#. BqhwE -#: sf_form.xhp +#. aKfwh +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id451616765867881\n" +"sf_filesystem.xhp\n" +"par_id111601118910848\n" "help.text" -msgid "Forms are usually used in %PRODUCTNAME documents to create user interfaces connected to relational databases. Hence, the Form service provides quick access to the linked database through the SFDatabases.Database service." +msgid "comparecontents: When True, the contents of the files are compared (default = False)." msgstr "" -#. bkmyS -#: sf_form.xhp +#. EZNG5 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id891598188164936\n" +"sf_filesystem.xhp\n" +"par_id161584541257982\n" "help.text" -msgid "The SFDocuments.Form service is closely related to the SFDocuments.FormControl service." +msgid "Copies one or more files from one location to another. Returns True if at least one file has been copied or False if an error occurred." msgstr "" -#. 3HUmh -#: sf_form.xhp +#. xE9SU +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id161616766330804\n" +"sf_filesystem.xhp\n" +"par_id401612998805699\n" "help.text" -msgid "Definitions" +msgid "An error will also occur if the source parameter uses wildcard characters and does not match any files." msgstr "" -#. GYDbT -#: sf_form.xhp +#. AZCsn +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id951618172906010\n" +"sf_filesystem.xhp\n" +"par_id331612998814805\n" "help.text" -msgid "Forms are usually created in Base documents, but they can be added to Writer and Calc documents as well." +msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." msgstr "" -#. z79tf -#: sf_form.xhp +#. aVGzZ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id671618173380680\n" +"sf_filesystem.xhp\n" +"par_id1001584541257789\n" "help.text" -msgid "In Base, each form you create using the Insert - Form functionality or through the Form Wizard is actually a FormDocument that can be handled with the Form service. Base documents can contain an unlimited number of form documents." +msgid "source: It can be a FileName or a NamePattern indicating one or more files to be copied." msgstr "" -#. kegBD -#: sf_form.xhp +#. ycEpt +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id841618177362626\n" +"sf_filesystem.xhp\n" +"par_id111584542310166\n" "help.text" -msgid "Below is an example showing the hierarchy of all the elements involved in accessing forms and subforms in a Base document. Suppose you have a Base file named Employees.odb and inside it you created a form document to add new employees to the database. The form document contains a main form named EmployeeData that gives access to a table. There is also a subform WorksAtPlant that allows you to associate the new employee to one of the plants of the company." +msgid "destination: It can be either a FileName specifying where the single source file is to be copied, or a FolderName into which the multiple files from source are to be copied." msgstr "" -#. izkiB -#: sf_form.xhp +#. frwD2 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bas_id151618176848874\n" +"sf_filesystem.xhp\n" +"par_id491612999134752\n" "help.text" -msgid "Employees.odb (Base document)" +msgid "If destination does not exist, it is created." msgstr "" -#. cz2fJ -#: sf_form.xhp +#. z3Tok +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bas_id941618176869485\n" +"sf_filesystem.xhp\n" +"par_id591612999166788\n" "help.text" -msgid "|-- EmployeeData (Main Form)" +msgid "Wildcard characters are not allowed in destination." msgstr "" -#. aD5yW -#: sf_form.xhp +#. zFyVX +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id221618173444457\n" +"sf_filesystem.xhp\n" +"par_id251584542431558\n" "help.text" -msgid "A FormDocument can be seen as a set of forms that provide access to datasets such as database tables and queries from within %PRODUCTNAME documents. The names of forms and subforms inside a FormDocument can be accessed using the Form Navigator." +msgid "overwrite: If True (default), files may be overwritten. The method will fail if destination is readonly, regardless of the value specified in overwrite." msgstr "" -#. AMFVt -#: sf_form.xhp +#. uRMe8 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id851616767037521\n" +"sf_filesystem.xhp\n" +"par_id691626216252568\n" "help.text" -msgid "Forms and Subforms" +msgid "In the examples below the first line copies a single file whereas the second line copies multiple files using wildcards." msgstr "" -#. GA63u -#: sf_form.xhp +#. 7xndg +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id681616767265034\n" +"sf_filesystem.xhp\n" +"par_id411626216328023\n" "help.text" -msgid "A form document is composed of one or more forms which, in turn, may also contain any number of subforms. A Form is an abstract set of controls that are linked to a specified data source, which can be a database table, a query or a SQL SELECT statement." +msgid "Be aware that subfolders and their contents are not copied when wildcards are used in the source argument." msgstr "" -#. fDvBD -#: sf_form.xhp +#. TdGi7 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id711618178831976\n" +"sf_filesystem.xhp\n" +"par_id731584544734412\n" "help.text" -msgid "In Calc and Writer documents, each form can be linked to datasets located in different databases. On the other hand, in Base documents the database contained in the document is common to all forms." +msgid "Copies one or more folders from one location to another. Returns True if at least one folder has been copied or False if an error occurred." msgstr "" -#. GhipT -#: sf_form.xhp +#. TSLCU +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id191616837111507\n" +"sf_filesystem.xhp\n" +"par_id21612999775377\n" "help.text" -msgid "To invoke the SFDocuments.Form service refer to the methods Forms(), FormDocuments() and OpenFormDocument() of the SFDocuments.Document service" +msgid "An error will also occur if the source parameter uses wildcard characters and does not match any folders." msgstr "" -#. gs4KC -#: sf_form.xhp +#. m3Hzh +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id581582885621841\n" +"sf_filesystem.xhp\n" +"par_id701612999808912\n" "help.text" -msgid "Service invocation" +msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." msgstr "" -#. WyEtQ -#: sf_form.xhp +#. GCCf3 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id141609955500101\n" +"sf_filesystem.xhp\n" +"par_id851584544734202\n" "help.text" -msgid "Before using the Form service the ScriptForge library needs to be loaded or imported:" +msgid "source: It can be a FolderName or a NamePattern indicating one or more folders to be copied." msgstr "" -#. KfjEA -#: sf_form.xhp +#. msqGq +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id991618179698545\n" +"sf_filesystem.xhp\n" +"par_id321584544734273\n" "help.text" -msgid "In Writer documents" +msgid "destination: Specifies the FolderName into which the single or multiple folders defined in source are to be copied." msgstr "" -#. 8s4VD -#: sf_form.xhp +#. iLKYc +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id51616767892693\n" +"sf_filesystem.xhp\n" +"par_id491612999134762\n" "help.text" -msgid "The code snippet below shows how to access the form named Form1 that is inside a Writer file:" +msgid "If destination does not exist, it is created." msgstr "" -#. NFikt -#: sf_form.xhp +#. TvYDS +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id531618179517628\n" +"sf_filesystem.xhp\n" +"par_id591612999166740\n" "help.text" -msgid "Forms can be accessed by their names or by their indices, as shown below:" +msgid "Wildcard characters are not allowed in destination." msgstr "" -#. 8PHy6 -#: sf_form.xhp +#. 3A2C2 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id181618250546617\n" +"sf_filesystem.xhp\n" +"par_id251584542431525\n" "help.text" -msgid "If you try to access a FormDocument that is currently opened in Design Mode an exception will be raised." +msgid "overwrite: If True (default), files may be overwritten. The method will fail if destination is readonly, regardless of the value specified in overwrite." msgstr "" -#. xNr3R -#: sf_form.xhp +#. 7CxBB +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id921618179792926\n" +"sf_filesystem.xhp\n" +"par_id751626216627481\n" "help.text" -msgid "In Calc documents" +msgid "In the examples below all files, folders and subfolders are copied." msgstr "" -#. yCpnG -#: sf_form.xhp +#. fNBgH +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id481618179851104\n" +"sf_filesystem.xhp\n" +"par_id31158454067562\n" "help.text" -msgid "A form in a Calc file must have a unique name inside its sheet. Hence, the Forms method requires two arguments, the first indicating the sheet name and the second specifying the form name." +msgid "Creates the specified FolderName. Returns True if the folder could be successfully created." msgstr "" -#. i9Um4 -#: sf_form.xhp +#. 9H3cp +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id51622028165429\n" +"sf_filesystem.xhp\n" +"par_id431613000475359\n" "help.text" -msgid "This is achieved identically using Python:" +msgid "If the specified folder has a parent folder that does not exist, it is created." msgstr "" -#. 2fB94 -#: sf_form.xhp +#. 7gTts +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id201618180055756\n" +"sf_filesystem.xhp\n" +"par_id491584540675469\n" "help.text" -msgid "In Base documents" +msgid "foldername: A string representing the folder to be created. If the folder already exists, an exception will be raised." msgstr "" -#. J3Btp -#: sf_form.xhp +#. 2zcfH +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id711616768164987\n" +"sf_filesystem.xhp\n" +"par_id731585322689518\n" "help.text" -msgid "A FormDocument inside a Base document is accessed by its name. The following example opens the form document named thisFormDocument and accesses the form MainForm:" +msgid "Creates a specified file and returns a TextStream service instance that can be used to write to the file." msgstr "" -#. pbtEM -#: sf_form.xhp +#. YMZDA +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bas_id271598171225874\n" +"sf_filesystem.xhp\n" +"par_id821613001057759\n" "help.text" -msgid "' The statement below is necessary only if the form hasn't been opened yet" +msgid "The method returns a Null object if an error occurred." msgstr "" -#. EDADK -#: sf_form.xhp +#. 2NPVD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bas_id51616768358888\n" +"sf_filesystem.xhp\n" +"par_id901585322689715\n" "help.text" -msgid "' Or, alternatively, to access the form by its index ..." +msgid "filename: The name of the file to be created." msgstr "" -#. BFQEU -#: sf_form.xhp +#. gEJA4 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id991618249636036\n" +"sf_filesystem.xhp\n" +"par_id501585322689209\n" "help.text" -msgid "To perform any action on a form using the Form service, the FormDocument must have been opened either manually by the user or programmatically in a user script. The latter can be done by calling the OpenFormDocument method of the Base service." +msgid "overwrite: Boolean value that determines if filename can be overwritten (default = True)." msgstr "" -#. DDerZ -#: sf_form.xhp +#. CkbhC +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id11618180564274\n" +"sf_filesystem.xhp\n" +"par_id551585322689192\n" "help.text" -msgid "To access a given subform of a form use the SubForms method. Note that in the example below mySubForm is a new instance of the Form service." +msgid "encoding: The character set to be used. The default encoding is \"UTF-8\"." msgstr "" -#. e7fcY -#: sf_form.xhp +#. z3d9F +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id681622028653480\n" +"sf_filesystem.xhp\n" +"par_id141613001281573\n" "help.text" -msgid "Previous examples translate in Python as:" +msgid "To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets." msgstr "" -#. ebc4K -#: sf_form.xhp +#. DVGxr +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"pyc_id811622808499801\n" +"sf_filesystem.xhp\n" +"par_id11584882040881\n" "help.text" -msgid "# The statement below is necessary only if the form hasn't been opened yet" +msgid "Deletes one or more files. Returns True if at least one file has been deleted or False if an error occurred." msgstr "" -#. GdyX6 -#: sf_form.xhp +#. y69YZ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"pyc_id511622808538351\n" +"sf_filesystem.xhp\n" +"par_id21612999775356\n" "help.text" -msgid "# Or, alternatively, to access the form by its index ..." +msgid "An error will also occur if the filename parameter uses wildcard characters and does not match any files." msgstr "" -#. QFFzk -#: sf_form.xhp +#. TWJRd +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id211618180379064\n" +"sf_filesystem.xhp\n" +"par_id21613001848493\n" "help.text" -msgid "In Form events" +msgid "The files to be deleted must not be readonly." msgstr "" -#. WBzCD -#: sf_form.xhp +#. PEFBq +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id421616768529754\n" +"sf_filesystem.xhp\n" +"par_id701612999808832\n" "help.text" -msgid "To invoke the Form service when a form event takes place:" +msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." msgstr "" -#. k2fKf -#: sf_form.xhp +#. DkCdk +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id721623150543016\n" +"sf_filesystem.xhp\n" +"par_id441584882040860\n" "help.text" -msgid "It is recommended to free resources after use of the Form service." +msgid "filename: It can be a FileName or a NamePattern indicating one or more files to be deleted." msgstr "" -#. pF9UQ -#: sf_form.xhp +#. FnaSi +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id221623150547406\n" +"sf_filesystem.xhp\n" +"par_id851626217167909\n" "help.text" -msgid "This operation is done implicitly when a form document is closed with the CloseFormDocument() method described below." +msgid "In the examples below only files are deleted, subfolders are not deleted." msgstr "" -#. GueeT -#: sf_form.xhp +#. c9ZCd +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id651583668365757\n" +"sf_filesystem.xhp\n" +"par_id11584882015881\n" "help.text" -msgid "Properties" +msgid "Deletes one or more folders. Returns True if at least one folder has been deleted or False if an error occurred." msgstr "" -#. 9LaxS -#: sf_form.xhp +#. bGmGo +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id871583668386455\n" +"sf_filesystem.xhp\n" +"par_id21612999775346\n" "help.text" -msgid "Name" +msgid "An error will also occur if the foldername parameter uses wildcard characters and does not match any folders." msgstr "" -#. SpGw6 -#: sf_form.xhp +#. GsqDD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id491583668386455\n" +"sf_filesystem.xhp\n" +"par_id21613001848853\n" "help.text" -msgid "Readonly" +msgid "The folders to be deleted must not be readonly." msgstr "" -#. K7Bsy -#: sf_form.xhp +#. kRSqe +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id271583668474014\n" +"sf_filesystem.xhp\n" +"par_id701612999808842\n" "help.text" -msgid "Type" +msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." msgstr "" -#. ekeZU -#: sf_form.xhp +#. 7YCXM +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id401583668386455\n" +"sf_filesystem.xhp\n" +"par_id451584882542247\n" "help.text" -msgid "Description" +msgid "foldername: It can be a FolderName or a NamePattern indicating one or more folders to be deleted." msgstr "" -#. wSC47 -#: sf_form.xhp +#. cCnG9 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id371583668519172\n" +"sf_filesystem.xhp\n" +"par_id651626217314709\n" "help.text" -msgid "No" +msgid "In the examples below only folders and their contents are deleted. Files in the parent folder \"C:\\Temp\" are not deleted." msgstr "" -#. jJ2dL -#: sf_form.xhp +#. gSG9s +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id771583668386455\n" +"sf_filesystem.xhp\n" +"par_id11584882015025\n" "help.text" -msgid "Specifies if the form allows to delete records." +msgid "Returns a string containing the folder where the specified extension package is installed." msgstr "" -#. DBxgx -#: sf_form.xhp +#. pJWi2 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id541583839708548\n" +"sf_filesystem.xhp\n" +"par_id711658780480236\n" "help.text" -msgid "No" +msgid "The current value of the property SF_FileSystem.FileNaming is used to determine the notation of the returned string." msgstr "" -#. j5J3C -#: sf_form.xhp +#. 3R4jx +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id731583839708412\n" +"sf_filesystem.xhp\n" +"par_id891644442917193\n" "help.text" -msgid "Specifies if the form allows to add records." +msgid "Use the property Extensions from the Platform service to get string array with the IDs of all installed extensions." msgstr "" -#. FCFEk -#: sf_form.xhp +#. w9vDF +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id761584027709516\n" +"sf_filesystem.xhp\n" +"par_id451584882542121\n" "help.text" -msgid "No" +msgid "extension: A string value with the ID of the extension. If the extension is not installed, an exception is raised." msgstr "" -#. 8qCAE -#: sf_form.xhp +#. YhQmv +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id971584027709752\n" +"sf_filesystem.xhp\n" +"par_id651626217313369\n" "help.text" -msgid "Specifies if the form allows to update records." +msgid "The examples below in Basic and Python return the folder where the APSO extension is installed." msgstr "" -#. VxAL4 -#: sf_form.xhp +#. ZbyLn +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id31583839767743\n" +"sf_filesystem.xhp\n" +"par_id161583764426709\n" "help.text" -msgid "Yes" +msgid "Returns True if a given file name is valid and exists, otherwise the method returns False." msgstr "" -#. CRA7v -#: sf_form.xhp +#. 7j5TN +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id111583839767195\n" +"sf_filesystem.xhp\n" +"par_id91613003122613\n" "help.text" -msgid "Specifies the hierarchical name of the Base Form containing the actual form." +msgid "If the filename parameter is actually an existing folder name, the method returns False." msgstr "" -#. FehA2 -#: sf_form.xhp +#. fr2Ei +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id771583839920487\n" +"sf_filesystem.xhp\n" +"par_id361583764426547\n" "help.text" -msgid "No" +msgid "filename: A string representing the file to be tested." msgstr "" -#. V8tZX -#: sf_form.xhp +#. ChDCL +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id451583839920858\n" +"sf_filesystem.xhp\n" +"par_id11158394432779\n" "help.text" -msgid "Specifies uniquely the current record of the form's underlying table, query or SQL statement." +msgid "Returns a zero-based array of the files stored in a given folder. Each entry in the array is a string containing the full path and file name." msgstr "" -#. 3jDxi -#: sf_form.xhp +#. JVjE3 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id571588333908716\n" +"sf_filesystem.xhp\n" +"par_id641613003790120\n" "help.text" -msgid "No" +msgid "If the argument foldername specifies a folder that does not exist, an exception is raised." msgstr "" -#. 7NUo8 -#: sf_form.xhp +#. nFaPD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id721588333908708\n" +"sf_filesystem.xhp\n" +"par_id821613003779799\n" "help.text" -msgid "Identifies the current record in the dataset being viewed on a form. If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. Row count starts at 1. If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. Row -1 refers to the last row in the result set." +msgid "The resulting list may be filtered with wildcards." msgstr "" -#. FKDA7 -#: sf_form.xhp +#. bq6vD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id501583774433513\n" +"sf_filesystem.xhp\n" +"par_id731583944543140\n" "help.text" -msgid "No" +msgid "foldername: A string representing a folder. The folder must exist. This argument must not designate a file." msgstr "" -#. eAsdX -#: sf_form.xhp +#. EM5cJ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id151598177605296\n" +"sf_filesystem.xhp\n" +"par_id591585648450060\n" "help.text" -msgid "Specifies a subset of records to be displayed as a SQL WHERE-clause without the WHERE keyword." +msgid "filter: A string containing wildcards (\"?\" and \"*\") that will be applied to the resulting list of files (default = \"\")." msgstr "" -#. uyje5 -#: sf_form.xhp +#. DpWGe +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id271588334016191\n" +"sf_filesystem.xhp\n" +"par_id731583944543907\n" "help.text" -msgid "Yes" +msgid "includesubfolders: Set this argument to True to include the contents of subfolders (Default = False)." msgstr "" -#. FQDDW -#: sf_form.xhp +#. snMqC +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id251588334016874\n" +"sf_filesystem.xhp\n" +"bas_id901701437618763\n" "help.text" -msgid "Specifies how records in a child subform are linked to records in its parent form." +msgid "' Returns all files matching the \"*.txt\" filter, including files in subfolders" msgstr "" -#. DMwPW -#: sf_form.xhp +#. zG7ec +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id901616774153495\n" +"sf_filesystem.xhp\n" +"par_id51583765642590\n" "help.text" -msgid "Yes" +msgid "Returns True if the specified FolderName is valid and exists, otherwise the method returns False." msgstr "" -#. 2EiCA -#: sf_form.xhp +#. 9xtCG +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id981616774153723\n" +"sf_filesystem.xhp\n" +"par_id151613004111990\n" "help.text" -msgid "Specifies how records in a child subform are linked to records in its parent form." +msgid "If the foldername parameter is actually an existing file name, the method returns False." msgstr "" -#. ppCiD -#: sf_form.xhp +#. qrf4A +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id501616774304840\n" +"sf_filesystem.xhp\n" +"par_id1001583765642211\n" "help.text" -msgid "Yes" +msgid "foldername: A string representing the folder to be tested." msgstr "" -#. kPfzG -#: sf_form.xhp +#. eAFVs +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id461616774304497\n" +"sf_filesystem.xhp\n" +"par_id521584110618989\n" "help.text" -msgid "The name of the current form." +msgid "Returns the BaseName (equal to the last component) of a folder or file name, without its extension." msgstr "" -#. vpBCA -#: sf_form.xhp +#. YnBXv +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id751616774384451\n" +"sf_filesystem.xhp\n" +"par_id731613004316790\n" "help.text" -msgid "No" +msgid "The method does not check if the specified file or folder exists." msgstr "" -#. ppErx -#: sf_form.xhp +#. 3FPjB +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id321616774384489\n" +"sf_filesystem.xhp\n" +"par_id691584110618308\n" "help.text" -msgid "Specifies in which order the records should be displayed as a SQL ORDER BY clause without the ORDER BY keywords." +msgid "filename: A string representing the file name and its path." msgstr "" -#. AGC5s -#: sf_form.xhp +#. jwFaP +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id261616774918923\n" +"sf_filesystem.xhp\n" +"par_id1001626271201609\n" "help.text" -msgid "Yes" +msgid "In the examples below, the first GetBaseName method call corresponds to a folder, so the function returns the last component of the path. The second call receives a file name as input, so the name of the file is returned without its extension." msgstr "" -#. rjCpM -#: sf_form.xhp +#. A56XC +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id171616774918881\n" +"sf_filesystem.xhp\n" +"par_id831584032680866\n" "help.text" -msgid "The parent of the current form. It can be either a SFDocuments.Form or a SFDocuments.Document object." +msgid "Returns the extension part of a file or folder name without the dot \".\" character." msgstr "" -#. rLS8r -#: sf_form.xhp +#. pdCJv +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id501616777650751\n" +"sf_filesystem.xhp\n" +"par_id941613060736524\n" "help.text" -msgid "No" +msgid "The method does not check for the existence of the specified file or folder." msgstr "" -#. USDVC -#: sf_form.xhp +#. Aqvwt +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id91616777650933\n" +"sf_filesystem.xhp\n" +"par_id561613060896361\n" "help.text" -msgid "Specifies the source of the data, as a table name, a query name or a SQL statement." +msgid "If this method is applied to a folder name or to a file without an extension, then an empty string is returned." msgstr "" -#. rtCsj -#: sf_form.xhp +#. NzK5z +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id451598177924437\n" +"sf_filesystem.xhp\n" +"par_id821584032680311\n" "help.text" -msgid "Yes" +msgid "filename: A string representing the file name and its path." msgstr "" -#. GxHLP -#: sf_form.xhp +#. Am6Bu +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id94159817792441\n" +"sf_filesystem.xhp\n" +"par_id48160068505010\n" "help.text" -msgid "UNO
object" +msgid "The builtin FileLen Basic function returns the number of bytes contained in a file as a Long value, i.e. up to 2GB." msgstr "" -#. 6xrep -#: sf_form.xhp +#. 2FHpa +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id191598177924897\n" +"sf_filesystem.xhp\n" +"par_id571613061005426\n" "help.text" -msgid "The UNO object representing interactions with the form. Refer to XForm and DataForm in the API documentation for detailed information." +msgid "The GetFileLen method can handle files with much larger sizes by returning a Currency value." msgstr "" -#. cwE3k -#: sf_form.xhp +#. PK2Fo +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"hd_id421612628828054\n" +"sf_filesystem.xhp\n" +"par_id161600685050367\n" "help.text" -msgid "Event properties" +msgid "filename: A string representing an existing file." msgstr "" -#. eTuoa -#: sf_form.xhp +#. o2GGJ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id41612629140856\n" +"sf_filesystem.xhp\n" +"par_id191584811478936\n" "help.text" -msgid "The properties below return or set URI strings that define the script triggered by the event." +msgid "Returns the last modified date of a given file." msgstr "" -#. fdses -#: sf_form.xhp +#. VMB4i +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id961612628879819\n" +"sf_filesystem.xhp\n" +"par_id25158481147822\n" "help.text" -msgid "Name" +msgid "filename: A string representing an existing file." msgstr "" -#. DsQGQ -#: sf_form.xhp +#. VEZR6 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id401612628879819\n" +"sf_filesystem.xhp\n" +"par_id711584032366587\n" "help.text" -msgid "ReadOnly" +msgid "Returns the last component of a file or folder name in native operating system format." msgstr "" -#. 5FemG -#: sf_form.xhp +#. 4vAvz +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id281612628879819\n" +"sf_filesystem.xhp\n" +"par_id541613061300811\n" "help.text" -msgid "Basic IDE Description" +msgid "The method does not check if the specified file or folder exists." msgstr "" -#. PgdP8 -#: sf_form.xhp +#. iajZD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id111612629836630\n" +"sf_filesystem.xhp\n" +"par_id671584032366193\n" "help.text" -msgid "No" +msgid "filename: A string representing the file name and its path." msgstr "" -#. GAgms -#: sf_form.xhp +#. ffxFe +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id1001612629836902\n" +"sf_filesystem.xhp\n" +"par_id871584113432747\n" "help.text" -msgid "Before record change" +msgid "Returns a string containing the name of the parent folder of a specified file or folder name." msgstr "" -#. Mr9ns -#: sf_form.xhp +#. 2eBgA +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id291612629836294\n" +"sf_filesystem.xhp\n" +"par_id611613061603039\n" "help.text" -msgid "No" +msgid "The method does not check if the specified file or folder exists." msgstr "" -#. DwhZn -#: sf_form.xhp +#. YUAQ3 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id62161262983683\n" +"sf_filesystem.xhp\n" +"par_id471584113432231\n" "help.text" -msgid "Fill parameters" +msgid "filename: A string with the file or folder name to be analyzed." msgstr "" -#. DrMbU -#: sf_form.xhp +#. Uc93M +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id81612629836634\n" +"sf_filesystem.xhp\n" +"par_id82158385117289\n" "help.text" -msgid "No" +msgid "Returns a randomly generated temporary file name that is useful for performing operations that require a temporary file." msgstr "" -#. eAJAN -#: sf_form.xhp +#. 7saEX +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id881612629836744\n" +"sf_filesystem.xhp\n" +"par_id391613061770924\n" "help.text" -msgid "Prior to reset" +msgid "By default, the returned file name does not have an extension. Use the extension parameter to specify the extension of the file name to be generated." msgstr "" -#. Y9d6z -#: sf_form.xhp +#. FTQwD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id591612629836830\n" +"sf_filesystem.xhp\n" +"par_id251689599133544\n" "help.text" -msgid "No" +msgid "The folder part of the returned string is the system's temporary folder." msgstr "" -#. LKxEu -#: sf_form.xhp +#. W7gF7 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id161612629836775\n" +"sf_filesystem.xhp\n" +"par_id971613061774934\n" "help.text" -msgid "Before record action" +msgid "The method does not create the temporary file." msgstr "" -#. Zyx2S -#: sf_form.xhp +#. pDA3H +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id891612629836630\n" +"sf_filesystem.xhp\n" +"par_id471584113435991\n" "help.text" -msgid "No" +msgid "extension: The extension of the temporary file name (Default = \"\")." msgstr "" -#. 2HBeC -#: sf_form.xhp +#. ch2AJ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id461612629836679\n" +"sf_filesystem.xhp\n" +"par_id58160104251423\n" "help.text" -msgid "Before submitting" +msgid "Hash functions are used by some cryptographic algorithms, in digital signatures, message authentication codes, fraud detection, fingerprints, checksums (message integrity check), hash tables, password storage and much more." msgstr "" -#. 2fJrZ -#: sf_form.xhp +#. qxDnP +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id131612629836291\n" +"sf_filesystem.xhp\n" +"par_id301601042791356\n" "help.text" -msgid "No" +msgid "The HashFile method returns the result of a hash function, applied on a given file and using a specified algorithm. The returned value is a string of lower-case hexadecimal digits." msgstr "" -#. BX4AH -#: sf_form.xhp +#. eAW33 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id151612629836151\n" +"sf_filesystem.xhp\n" +"par_id861601043268484\n" "help.text" -msgid "Confirm deletion" +msgid "The hash algorithms supported are: MD5, SHA1, SHA224, SHA256, SHA384 and SHA512." msgstr "" -#. W9izF -#: sf_form.xhp +#. s5ZiA +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id211612629836725\n" +"sf_filesystem.xhp\n" +"par_id28160104251451\n" "help.text" -msgid "No" +msgid "filename: A string representing an existing file." msgstr "" -#. pDvPB -#: sf_form.xhp +#. Eomhm +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id361612629836624\n" +"sf_filesystem.xhp\n" +"par_id71601042959846\n" "help.text" -msgid "After record change" +msgid "algorithm: One of the supported algorithms." msgstr "" -#. WprGG -#: sf_form.xhp +#. HzFs2 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id311612629836481\n" +"sf_filesystem.xhp\n" +"par_id51584791330688\n" "help.text" -msgid "No" +msgid "Moves one or more files from one location to another. Returns True if at least one file has been moved or False if an error occurred." msgstr "" -#. Xn2CS -#: sf_form.xhp +#. RFrNE +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id721612629836752\n" +"sf_filesystem.xhp\n" +"par_id631613062890648\n" "help.text" -msgid "Error occurred" +msgid "An error will also occur if the source parameter uses wildcard characters and does not match any files." msgstr "" -#. B3zCy -#: sf_form.xhp +#. ETmEP +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id981612629836116\n" +"sf_filesystem.xhp\n" +"par_id241613062902777\n" "help.text" -msgid "No" +msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." msgstr "" -#. L3Ac6 -#: sf_form.xhp +#. DbC6F +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id381612629836635\n" +"sf_filesystem.xhp\n" +"par_id721584791330406\n" "help.text" -msgid "When loading" +msgid "source: It can be a FileName or NamePattern to designate one or more files to be moved." msgstr "" -#. 9Z9vv -#: sf_form.xhp +#. BHa7Y +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id711612629836704\n" +"sf_filesystem.xhp\n" +"par_id291584791330181\n" "help.text" -msgid "No" +msgid "destination: If source is a FileName then this parameter indicates the new path and file name of the moved file." msgstr "" -#. XL4Js -#: sf_form.xhp +#. ZzA3Y +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id35161262983642\n" +"sf_filesystem.xhp\n" +"par_id31613063334246\n" "help.text" -msgid "When reloading" +msgid "If the move operation involves multiple files, then destination must be a folder name. If it does not exist, it is created." msgstr "" -#. P6DEi -#: sf_form.xhp +#. 39oR8 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id44161677878329\n" +"sf_filesystem.xhp\n" +"par_id391613063494599\n" "help.text" -msgid "No" +msgid "If source and destination have the same parent folder, the method will rename the source." msgstr "" -#. ywCsh -#: sf_form.xhp +#. 7bzK4 +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id661616778783899\n" +"sf_filesystem.xhp\n" +"par_id941613063476533\n" "help.text" -msgid "Before reloading" +msgid "Wildcard characters are not allowed in destination." msgstr "" -#. eGnRj -#: sf_form.xhp +#. Bysqd +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id651616778529764\n" +"sf_filesystem.xhp\n" +"par_id91626272612758\n" "help.text" -msgid "No" +msgid "In the following examples only files are moved, subfolders are not." msgstr "" -#. E6JUH -#: sf_form.xhp +#. iYBMe +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id311616778529570\n" +"sf_filesystem.xhp\n" +"par_id301584791330868\n" "help.text" -msgid "After resetting" +msgid "Moves one or more folders from one location to another. Returns True if at least one folder has been moved or False if an error occurred." msgstr "" -#. VDAk5 -#: sf_form.xhp +#. RHjYG +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id601616778529481\n" +"sf_filesystem.xhp\n" +"par_id411613072570664\n" "help.text" -msgid "No" +msgid "An error will also occur if the source parameter uses wildcard characters and does not match any folders." msgstr "" -#. 99FfH -#: sf_form.xhp +#. F2DaD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id351616778529352\n" +"sf_filesystem.xhp\n" +"par_id601613072595264\n" "help.text" -msgid "After record action" +msgid "The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred." msgstr "" -#. CxndA -#: sf_form.xhp +#. xVGBy +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id711616778529292\n" +"sf_filesystem.xhp\n" +"par_id541584791330777\n" "help.text" -msgid "No" +msgid "source: It can be a FolderName or NamePattern to designate one or more folders to be moved." msgstr "" -#. DTDCq -#: sf_form.xhp +#. 4Ampu +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id981616778529250\n" +"sf_filesystem.xhp\n" +"par_id551584791330279\n" "help.text" -msgid "When unloading" +msgid "destination: If the move operation involves a single folder, then destination is the name and path of the moved folder and it must not exist." msgstr "" -#. iWroa -#: sf_form.xhp +#. dD7SB +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id521616778529932\n" +"sf_filesystem.xhp\n" +"par_id11613072890641\n" "help.text" -msgid "No" +msgid "If multiple folders are being moved, then destination designates where the folders in source will be moved into. If destination does not exist, it is created." msgstr "" -#. pVPR9 -#: sf_form.xhp +#. A69QS +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id511616778529291\n" +"sf_filesystem.xhp\n" +"par_id301613072928159\n" "help.text" -msgid "Before unloading" +msgid "Wildcard characters are not allowed in destination." msgstr "" -#. GWajw -#: sf_form.xhp +#. DqpaF +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id961618181634322\n" +"sf_filesystem.xhp\n" +"par_id871583670342051\n" "help.text" -msgid "To learn more about URI strings, refer to the Scripting Framework URI Specification." +msgid "Returns a string containing the normalized path name by collapsing redundant separators and up-level references." msgstr "" -#. bkBH8 -#: sf_form.xhp +#. heCzw +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id921606472825856\n" +"sf_filesystem.xhp\n" +"par_id541658780038027\n" "help.text" -msgid "List of methods in the Form service" +msgid "For instance, the path names A//B, A/B/, A/./B and A/foo/../B are all normalized to A/B." msgstr "" -#. KwDij -#: sf_form.xhp +#. A6mAb +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id871583933076448\n" +"sf_filesystem.xhp\n" +"par_id881613074436118\n" "help.text" -msgid "Sets the focus on the current Form instance. Returns True if focusing was successful." +msgid "On Windows, forward slashes \"/\" are converted to backward slashes \"\\\"." msgstr "" -#. 9qj5F -#: sf_form.xhp +#. 56xkN +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id81616858956290\n" +"sf_filesystem.xhp\n" +"par_id381658780455018\n" "help.text" -msgid "The behavior of the Activate method depends on the type of document where the form is located:" +msgid "The current value of the property SF_FileSystem.FileNaming is used to determine the notation of the filename argument as well as the format of the returned string." msgstr "" -#. YVgyr -#: sf_form.xhp +#. G9ARW +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id761616858967361\n" +"sf_filesystem.xhp\n" +"par_id481583670340107\n" "help.text" -msgid "In Writer documents: Sets the focus on that document." +msgid "filename: a string representing a valid path name. The file or directory represented by this argument may not exist." msgstr "" -#. HKFTw -#: sf_form.xhp +#. JNTia +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id931616859010103\n" +"sf_filesystem.xhp\n" +"par_id121585320922117\n" "help.text" -msgid "In Calc documents: Sets the focus on the sheet to which the form belongs." +msgid "Opens a file and returns a TextStream object that can be used to read from, write to, or append to the file." msgstr "" -#. 6jx5G -#: sf_form.xhp +#. ePMpQ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id41616859019478\n" +"sf_filesystem.xhp\n" +"par_id591613073104711\n" "help.text" -msgid "In Base documents: Sets the focus on the FormDocument the Form refers to." +msgid "Note that the method does not check if the given file is really a text file." msgstr "" -#. J5C7y -#: sf_form.xhp +#. SGJCd +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id921618228229529\n" +"sf_filesystem.xhp\n" +"par_id951613073135036\n" "help.text" -msgid "The following example assumes you want to activate the form named FormA located in Sheet1 of the currently open Calc file. It first gets access to the document using the Document service and ThisComponent and then activates the form." +msgid "The method returns a Null object (in Basic) or None (in Python) if an error occurred." msgstr "" -#. 4EC5M -#: sf_form.xhp +#. mxuwo +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bas_id21618228468066\n" +"sf_filesystem.xhp\n" +"par_id551585320922678\n" "help.text" -msgid "'Gets hold of the form that will be activated" +msgid "filename: Identifies the file to open." msgstr "" -#. M2Wks -#: sf_form.xhp +#. tsRLR +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"bas_id201618228487565\n" +"sf_filesystem.xhp\n" +"par_id671585320922388\n" "help.text" -msgid "'Activates the form" +msgid "iomode: Indicates the input/output mode. It can be one of three constants: svc.ForReading (default), svc.ForWriting, or svc.ForAppending." msgstr "" -#. YHxMm -#: sf_form.xhp +#. z27vT +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id81618228720782\n" +"sf_filesystem.xhp\n" +"par_id21585321398586\n" "help.text" -msgid "ThisComponent applies to Calc and Writer documents. For Base documents use ThisDataBaseDocument." +msgid "create: Boolean value that indicates whether a new file can be created if the specified filename doesn't exist:" msgstr "" -#. QznyJ -#: sf_form.xhp +#. VDFAi +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id501616860541195\n" +"sf_filesystem.xhp\n" +"par_id721613073434797\n" "help.text" -msgid "Closes the form document containing the actual Form instance. The Form instance is disposed." +msgid "If True a new file and its parent folders will be created if they do not exist;" msgstr "" -#. CcCpD -#: sf_form.xhp +#. EypVC +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id611618229004669\n" +"sf_filesystem.xhp\n" +"par_id201613073469289\n" "help.text" -msgid "This method only closes form documents located in Base documents. If the form is stored in a Writer or Calc document, calling CloseFormDocument will have no effect." +msgid "If False then new files are not created (default)." msgstr "" -#. a8CxQ -#: sf_form.xhp +#. wjGYH +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id161584541257982\n" +"sf_filesystem.xhp\n" +"par_id771585321576210\n" "help.text" -msgid "The value returned by the Controls method depends on the arguments provided:" +msgid "encoding: The character set to be used. The default encoding is \"UTF-8\"." msgstr "" -#. VXWwg -#: sf_form.xhp +#. FuYwe +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id421598179770993\n" +"sf_filesystem.xhp\n" +"par_id871583670342501\n" "help.text" -msgid "If the method is called without arguments, then it returns the list of the controls contained in the form. Be aware that the returned list does not contain any subform controls." +msgid "Opens a dialog box to open or save files." msgstr "" -#. SsiUX -#: sf_form.xhp +#. SjDBv +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id81598185229301\n" +"sf_filesystem.xhp\n" +"par_id881613074436979\n" "help.text" -msgid "If the optional ControlName argument is provided, the method returns a FormControl class instance referring to the specified control." +msgid "If the SAVE mode is set and the picked file exists, a warning message will be displayed." msgstr "" -#. 7CFJU -#: sf_form.xhp +#. YgsLZ +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id1001584541257789\n" +"sf_filesystem.xhp\n" +"par_id481583670342502\n" "help.text" -msgid "controlname : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array." +msgid "defaultfile: This argument is a string composed of a folder and file name:" msgstr "" -#. PTqJ2 -#: sf_form.xhp +#. fyVCs +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id291616861407907\n" +"sf_filesystem.xhp\n" +"par_id511613074665951\n" "help.text" -msgid "Return a SFDatabases.Database instance giving access to the execution of SQL commands on the database the current form is connected to and/or that is stored in the current Base document." +msgid "The folder part indicates the folder that will be shown when the dialog opens (default = the last selected folder)." msgstr "" -#. fZRst -#: sf_form.xhp +#. xs5hU +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id991616861417207\n" +"sf_filesystem.xhp\n" +"par_id631613074685308\n" "help.text" -msgid "Each form has its own database connection, except in Base documents where they all share the same connection." +msgid "The file part designates the default file to open or save." msgstr "" -#. wFSWb -#: sf_form.xhp +#. fBHyg +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id701616861134906\n" +"sf_filesystem.xhp\n" +"par_id981583670342502\n" "help.text" -msgid "user, password: The login optional parameters (Default = \"\")." +msgid "mode: A string value that can be either \"OPEN\" (for input files) or \"SAVE\" (for output files). The default value is \"OPEN\"." msgstr "" -#. 83Jju -#: sf_form.xhp +#. uvwDP +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id771616861842867\n" +"sf_filesystem.xhp\n" +"par_id31583670342502\n" "help.text" -msgid "The form cursor is positioned on the first record. Returns True if successful." +msgid "filter: The extension of the files displayed when the dialog is opened (default = no filter)." msgstr "" -#. rapRE -#: sf_form.xhp +#. niaGR +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id331616863143187\n" +"sf_filesystem.xhp\n" +"par_id881626276134300\n" "help.text" -msgid "The form cursor is positioned on the last record. Returns True if successful." +msgid "The examples below open a file picker with the \"txt\" filter applied." msgstr "" -#. HZELb -#: sf_form.xhp +#. HkwaR +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id361616863143954\n" +"sf_filesystem.xhp\n" +"par_id521583671701777\n" "help.text" -msgid "The form cursor is positioned on the new record area. Returns True if successful." +msgid "Opens a dialog box to select a folder." msgstr "" -#. 2QwcR -#: sf_form.xhp +#. mG6QD +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id541616863143461\n" +"sf_filesystem.xhp\n" +"par_id951583671701872\n" "help.text" -msgid "The form cursor is positioned on the next record. Returns True if successful." +msgid "defaultfolder: A string containing the folder name that will be displayed when the dialog is opened (default = the last selected folder)." msgstr "" -#. a2gGn -#: sf_form.xhp +#. ymABK +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id271616863582607\n" +"sf_filesystem.xhp\n" +"par_id821583671701764\n" "help.text" -msgid "offset: The number of records to go forward (Default = 1)." +msgid "freetext: Text to display in the dialog (default = \"\")." msgstr "" -#. e6huC -#: sf_form.xhp +#. 4FFby +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id616168637945\n" +"sf_filesystem.xhp\n" +"bas_id921583671701610\n" "help.text" -msgid "The form cursor is positioned on the previous record. Returns True if successful." +msgid "aFolder = FSO.PickFolder(\"C:\\Documents\", \"Choose a folder or press Cancel\")" msgstr "" -#. tAnVw -#: sf_form.xhp +#. nW8Rx +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id751616863794125\n" +"sf_filesystem.xhp\n" +"pyc_id631626276402296\n" "help.text" -msgid "offset: The number of records to go backwards (Default = 1)." +msgid "aFolder = fs.PickFolder(r\"C:\\Documents\", \"Choose a folder or press Cancel\")" msgstr "" -#. Kp4Wo -#: sf_form.xhp +#. xdfBh +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id811616864216529\n" +"sf_filesystem.xhp\n" +"par_id431584016761996\n" "help.text" -msgid "Reloads the current data from the database and refreshes the form. The cursor is positioned on the first record. Returns True if successful." +msgid "Returns a zero-based array of strings corresponding to the folders stored in a given foldername." msgstr "" -#. 5gBGr -#: sf_form.xhp +#. LVNZq +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id891616864510614\n" +"sf_filesystem.xhp\n" +"par_id431613075267241\n" "help.text" -msgid "The value returned by the Subforms method depends on the arguments provided:" +msgid "The list may be filtered with wildcards." msgstr "" -#. 4yG2j -#: sf_form.xhp +#. 7pDiA +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id951616864510585\n" +"sf_filesystem.xhp\n" +"par_id701584016761945\n" "help.text" -msgid "If the method is called without any arguments, then it returns the list of subforms contained in the current form or subform instance." +msgid "foldername: A string representing a folder. The folder must exist. foldername must not designate a file." msgstr "" -#. AD3Q6 -#: sf_form.xhp +#. Xmg8b +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id591616864510445\n" +"sf_filesystem.xhp\n" +"par_id471585648674921\n" "help.text" -msgid "If the optional subform argument is provided, the method returns a new SFDocuments.Form instance based on the specified form/subform name or index." +msgid "filter: A string containing wildcards (\"?\" and \"*\") that will be applied to the resulting list of folders (default = \"\")." msgstr "" -#. GCRsS -#: sf_form.xhp +#. WCB4h +#: sf_filesystem.xhp msgctxt "" -"sf_form.xhp\n" -"par_id341616864510747\n" +"sf_filesystem.xhp\n" +"par_id731583944548857\n" "help.text" -msgid "subform: A subform stored in the current Form class instance given by its name or index." +msgid "includesubfolders: Set this argument to True to include the contents of subfolders (Default = False)." msgstr "" -#. uKm6R +#. XQG8t #: sf_form.xhp msgctxt "" "sf_form.xhp\n" -"par_id211618230389251\n" -"help.text" -msgid "When this argument is absent, the method returns a list of available subforms as a zero-based array. If the form has a single subform, you can set subform = 0 to get access to it." -msgstr "" - -#. CfGgB -#: sf_formcontrol.xhp -msgctxt "" -"sf_formcontrol.xhp\n" "tit\n" "help.text" -msgid "SFDocuments.FormControl service" +msgid "SFDocuments.Form service" msgstr "" -#. U4CgG -#: sf_formcontrol.xhp +#. cFDGc +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" +"sf_form.xhp\n" "bm_id781582391760253\n" "help.text" -msgid "SFDocuments.FormControl service" +msgid "SFDocuments.Form service" msgstr "" -#. XFkrG -#: sf_formcontrol.xhp +#. LDpRB +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" +"sf_form.xhp\n" "par_id931583589764919\n" "help.text" -msgid "The FormControl service provides access to the controls that belong to a form, a subform or a table control of a FormDocument. Each instance of the FormControl service refers to a single control in the form. This service allows users to:" +msgid "The Form service provides methods and properties to manage forms in %PRODUCTNAME documents. This service supports forms in Base, Calc and Writer documents and allows to:" msgstr "" -#. irNFC -#: sf_formcontrol.xhp +#. U3zGB +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id451618771561326\n" +"sf_form.xhp\n" +"par_id381618172063851\n" "help.text" -msgid "Get and set the properties of the control represented by the FormControl instance." +msgid "Open and activate forms." msgstr "" -#. S5aH9 -#: sf_formcontrol.xhp +#. SC6Yb +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id601618771565183\n" +"sf_form.xhp\n" +"par_id261618172129782\n" "help.text" -msgid "Access the current value displayed by the control." +msgid "Navigate through records shown by the form." msgstr "" -#. P5xzV -#: sf_formcontrol.xhp +#. krQfB +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id981618771567951\n" +"sf_form.xhp\n" +"par_id281618172141607\n" "help.text" -msgid "Set the focus on the desired control." +msgid "Get access to the controls inside the form." msgstr "" -#. LUDRM -#: sf_formcontrol.xhp +#. itKdZ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id301616939922857\n" +"sf_form.xhp\n" +"par_id371618172155483\n" "help.text" -msgid "To use the FormControl service in a particular form, subform or table control, all controls must have unique names." +msgid "Get access to subforms of a parent form." msgstr "" -#. JMFEb -#: sf_formcontrol.xhp +#. QcJ24 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id541618771629112\n" +"sf_form.xhp\n" +"par_id351616768789190\n" "help.text" -msgid "Radio buttons that share the same group name must also have unique control names." +msgid "The SFDocuments.Form service is available from %PRODUCTNAME 7.2 onwards." msgstr "" -#. mAwyv -#: sf_formcontrol.xhp +#. BqhwE +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id51618771641273\n" +"sf_form.xhp\n" +"par_id451616765867881\n" "help.text" -msgid "The main purpose of the FormControl service is setting and getting the properties and values displayed by the controls in a form." +msgid "Forms are usually used in %PRODUCTNAME documents to create user interfaces connected to relational databases. Hence, the Form service provides quick access to the linked database through the SFDatabases.Database service." msgstr "" -#. egjZu -#: sf_formcontrol.xhp +#. bkmyS +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id81618774023346\n" +"sf_form.xhp\n" +"par_id891598188164936\n" "help.text" -msgid "All controls have a Value property. However, its contents will vary according to the control type. For more information, read The Value Property below." +msgid "The SFDocuments.Form service is closely related to the SFDocuments.FormControl service." msgstr "" -#. kF29h -#: sf_formcontrol.xhp +#. 3HUmh +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id881618771651907\n" +"sf_form.xhp\n" +"hd_id161616766330804\n" "help.text" -msgid "It is also possible to format the controls via the XControlModel and XControlView properties." +msgid "Definitions" msgstr "" -#. SGsH8 -#: sf_formcontrol.xhp +#. GYDbT +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id891598188164936\n" +"sf_form.xhp\n" +"par_id951618172906010\n" "help.text" -msgid "The SFDocuments.FormControl service is closely related to the SFDocuments.Form service." +msgid "Forms are usually created in Base documents, but they can be added to Writer and Calc documents as well." msgstr "" -#. rUEuw -#: sf_formcontrol.xhp +#. z79tf +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"hd_id581582885621841\n" +"sf_form.xhp\n" +"par_id671618173380680\n" "help.text" -msgid "Service invocation" +msgid "In Base, each form you create using the Insert - Form functionality or through the Form Wizard is actually a FormDocument that can be handled with the Form service. Base documents can contain an unlimited number of form documents." msgstr "" -#. pzkhK -#: sf_formcontrol.xhp +#. kegBD +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id141609955500101\n" +"sf_form.xhp\n" +"par_id841618177362626\n" "help.text" -msgid "Before using the FormControl service the ScriptForge library needs to be loaded or imported:" +msgid "Below is an example showing the hierarchy of all the elements involved in accessing forms and subforms in a Base document. Suppose you have a Base file named Employees.odb and inside it you created a form document to add new employees to the database. The form document contains a main form named EmployeeData that gives access to a table. There is also a subform WorksAtPlant that allows you to associate the new employee to one of the plants of the company." msgstr "" -#. BeDqF -#: sf_formcontrol.xhp +#. izkiB +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id361598174756160\n" +"sf_form.xhp\n" +"bas_id151618176848874\n" "help.text" -msgid "The FormControl service is invoked from an existing Form service instance through its Controls method." +msgid "Employees.odb (Base document)" msgstr "" -#. 56bE7 -#: sf_formcontrol.xhp +#. cz2fJ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"pyc_id721622556808773\n" +"sf_form.xhp\n" +"bas_id941618176869485\n" "help.text" -msgid "control.Value = 'Current Time = ' + strftime(\"%a, %d %b %Y %H:%M:%S\", localtime())" +msgid "|-- EmployeeData (Main Form)" msgstr "" -#. LG9Md -#: sf_formcontrol.xhp +#. aD5yW +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id781618772761258\n" +"sf_form.xhp\n" +"par_id221618173444457\n" "help.text" -msgid "To learn more about how to open a FormDocument and get access to its forms, refer to the SFDocuments.Form service help page." +msgid "A FormDocument can be seen as a set of forms that provide access to datasets such as database tables and queries from within %PRODUCTNAME documents. The names of forms and subforms inside a FormDocument can be accessed using the Form Navigator." msgstr "" -#. qeXCN -#: sf_formcontrol.xhp +#. AMFVt +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id951598174966322\n" +"sf_form.xhp\n" +"hd_id851616767037521\n" "help.text" -msgid "Alternatively a FormControl instance can be retrieved via the SFDocuments.FormEvent service, which returns the SFDocuments.FormControl class instance that triggered the event." +msgid "Forms and Subforms" msgstr "" -#. bSfxy -#: sf_formcontrol.xhp +#. GA63u +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"bas_id801598175242937\n" +"sf_form.xhp\n" +"par_id681616767265034\n" "help.text" -msgid "' oControl now represents the instance of the FormControl class that triggered the current event" +msgid "A form document is composed of one or more forms which, in turn, may also contain any number of subforms. A Form is an abstract set of controls that are linked to a specified data source, which can be a database table, a query or a SQL SELECT statement." msgstr "" -#. EgCtB -#: sf_formcontrol.xhp +#. fDvBD +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id251598176312571\n" +"sf_form.xhp\n" +"par_id711618178831976\n" "help.text" -msgid "Note that in previous examples, the prefix \"SFDocuments.\" may be omitted." +msgid "In Calc and Writer documents, each form can be linked to datasets located in different databases. On the other hand, in Base documents the database contained in the document is common to all forms." msgstr "" -#. 7gE8Y -#: sf_formcontrol.xhp +#. GhipT +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id951618773412097\n" +"sf_form.xhp\n" +"par_id191616837111507\n" "help.text" -msgid "The FormEvent service is used exclusively to create instances of the SFDocuments.Form and SFDocuments.FormControl services when a form or control event takes place." +msgid "To invoke the SFDocuments.Form service refer to the methods Forms(), FormDocuments() and OpenFormDocument() of the SFDocuments.Document service" msgstr "" -#. AppFj -#: sf_formcontrol.xhp +#. gs4KC +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"hd_id71598455687512\n" +"sf_form.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "Control types" +msgid "Service invocation" msgstr "" -#. ezcW8 -#: sf_formcontrol.xhp +#. WyEtQ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id851598455863395\n" +"sf_form.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "The FormControl service is available for the following control types:" +msgid "Before using the Form service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. BESBv -#: sf_formcontrol.xhp +#. KfjEA +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"hd_id651583668365757\n" +"sf_form.xhp\n" +"hd_id991618179698545\n" "help.text" -msgid "Properties" +msgid "In Writer documents" msgstr "" -#. VrBfK -#: sf_formcontrol.xhp +#. 8s4VD +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id871583668386455\n" +"sf_form.xhp\n" +"par_id51616767892693\n" "help.text" -msgid "Name" +msgid "The code snippet below shows how to access the form named Form1 that is inside a Writer file:" msgstr "" -#. hDr9G -#: sf_formcontrol.xhp +#. NFikt +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id491583668386455\n" +"sf_form.xhp\n" +"par_id531618179517628\n" "help.text" -msgid "Readonly" +msgid "Forms can be accessed by their names or by their indices, as shown below:" msgstr "" -#. kWac7 -#: sf_formcontrol.xhp +#. 8PHy6 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id271583668474014\n" +"sf_form.xhp\n" +"par_id181618250546617\n" "help.text" -msgid "Type" +msgid "If you try to access a FormDocument that is currently opened in Design Mode an exception will be raised." msgstr "" -#. dXwGN -#: sf_formcontrol.xhp +#. xNr3R +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id291598538799794\n" +"sf_form.xhp\n" +"hd_id921618179792926\n" "help.text" -msgid "Applicable to" +msgid "In Calc documents" msgstr "" -#. bEQWc -#: sf_formcontrol.xhp +#. yCpnG +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id401583668386455\n" +"sf_form.xhp\n" +"par_id481618179851104\n" "help.text" -msgid "Description" +msgid "A form in a Calc file must have a unique name inside its sheet. Hence, the Forms method requires two arguments, the first indicating the sheet name and the second specifying the form name." msgstr "" -#. N3ejK -#: sf_formcontrol.xhp +#. i9Um4 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id371583668519172\n" +"sf_form.xhp\n" +"par_id51622028165429\n" "help.text" -msgid "No" +msgid "This is achieved identically using Python:" msgstr "" -#. PszFp -#: sf_formcontrol.xhp +#. 2fB94 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id771583668386455\n" +"sf_form.xhp\n" +"hd_id201618180055756\n" "help.text" -msgid "Specifies the action triggered when the button is clicked. Accepted values are: none, submitForm, resetForm, refreshForm, moveToFirst, moveToLast, moveToNext, moveToPrev, saveRecord, moveToNew, deleteRecord, undoRecord." +msgid "In Base documents" msgstr "" -#. fmzNT -#: sf_formcontrol.xhp +#. J3Btp +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id541583839708548\n" +"sf_form.xhp\n" +"par_id711616768164987\n" "help.text" -msgid "No" +msgid "A FormDocument inside a Base document is accessed by its name. The following example opens the form document named thisFormDocument and accesses the form MainForm:" msgstr "" -#. 62Bud -#: sf_formcontrol.xhp +#. pbtEM +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id731583839708412\n" +"sf_form.xhp\n" +"bas_id271598171225874\n" "help.text" -msgid "Specifies the text displayed by the control." +msgid "' The statement below is necessary only if the form hasn't been opened yet" msgstr "" -#. nFFDY -#: sf_formcontrol.xhp +#. EDADK +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id411616942306677\n" +"sf_form.xhp\n" +"bas_id51616768358888\n" "help.text" -msgid "Yes" +msgid "' Or, alternatively, to access the form by its index ..." msgstr "" -#. 8H6BR -#: sf_formcontrol.xhp -msgctxt "" -"sf_formcontrol.xhp\n" -"par_id461616942306745\n" -"help.text" -msgid "Specifies the rowset field mapped onto the current control." -msgstr "" - -#. AJUH6 -#: sf_formcontrol.xhp +#. BFQEU +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id761584027709516\n" +"sf_form.xhp\n" +"par_id991618249636036\n" "help.text" -msgid "Yes" +msgid "To perform any action on a form using the Form service, the FormDocument must have been opened either manually by the user or programmatically in a user script. The latter can be done by calling the OpenFormDocument method of the Base service." msgstr "" -#. Enqxp -#: sf_formcontrol.xhp +#. DDerZ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id261598539120502\n" +"sf_form.xhp\n" +"par_id11618180564274\n" "help.text" -msgid "All" +msgid "To access a given subform of a form use the SubForms method. Note that in the example below mySubForm is a new instance of the Form service." msgstr "" -#. FsCJK -#: sf_formcontrol.xhp +#. e7fcY +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id971584027709752\n" +"sf_form.xhp\n" +"par_id681622028653480\n" "help.text" -msgid "One of the control types listed above." +msgid "Previous examples translate in Python as:" msgstr "" -#. DH84k -#: sf_formcontrol.xhp +#. ebc4K +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id31583839767743\n" +"sf_form.xhp\n" +"pyc_id811622808499801\n" "help.text" -msgid "No" +msgid "# The statement below is necessary only if the form hasn't been opened yet" msgstr "" -#. pRrwC -#: sf_formcontrol.xhp +#. GdyX6 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id111583839767195\n" +"sf_form.xhp\n" +"pyc_id511622808538351\n" "help.text" -msgid "Specifies whether a command button is the default OK button." +msgid "# Or, alternatively, to access the form by its index ..." msgstr "" -#. 2dP2A -#: sf_formcontrol.xhp +#. QFFzk +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id241616942739459\n" +"sf_form.xhp\n" +"hd_id211618180379064\n" "help.text" -msgid "No" +msgid "In Form events" msgstr "" -#. Sukx9 -#: sf_formcontrol.xhp +#. WBzCD +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id271616942739359\n" +"sf_form.xhp\n" +"par_id421616768529754\n" "help.text" -msgid "Specifies the default value used to initialize a control in a new record." +msgid "To invoke the Form service when a form event takes place:" msgstr "" -#. nFBUQ -#: sf_formcontrol.xhp +#. k2fKf +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id771583839920487\n" +"sf_form.xhp\n" +"par_id721623150543016\n" "help.text" -msgid "No" +msgid "It is recommended to free resources after use of the Form service." msgstr "" -#. fQYqd -#: sf_formcontrol.xhp +#. pF9UQ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id891598539196786\n" +"sf_form.xhp\n" +"par_id221623150547406\n" "help.text" -msgid "All (except HiddenControl)" +msgid "This operation is done implicitly when a form document is closed with the CloseFormDocument() method described below." msgstr "" -#. MmDQ5 -#: sf_formcontrol.xhp +#. GueeT +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id451583839920858\n" +"sf_form.xhp\n" +"hd_id651583668365757\n" "help.text" -msgid "Specifies if the control is accessible with the cursor." +msgid "Properties" msgstr "" -#. VDkDh -#: sf_formcontrol.xhp +#. 9LaxS +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id571588333908716\n" +"sf_form.xhp\n" +"par_id871583668386455\n" "help.text" -msgid "No" +msgid "Name" msgstr "" -#. 8X3Ho -#: sf_formcontrol.xhp +#. SpGw6 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id721588333908708\n" +"sf_form.xhp\n" +"par_id491583668386455\n" "help.text" -msgid "Specifies the format used to display dates and times. It must be one of following strings:" +msgid "Readonly" msgstr "" -#. 6CqCN -#: sf_formcontrol.xhp +#. K7Bsy +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id891598456980194\n" +"sf_form.xhp\n" +"par_id271583668474014\n" "help.text" -msgid "For dates: \"Standard (short)\", \"Standard (short YY)\", \"Standard (short YYYY)\", \"Standard (long)\", \"DD/MM/YY\", \"MM/DD/YY\", \"YY/MM/DD\", \"DD/MM/YYYY\", \"MM/DD/YYYY\" , \"YYYY/MM/DD\", \"YY-MM-DD\", \"YYYY-MM-DD\"." +msgid "Type" msgstr "" -#. f6gni -#: sf_formcontrol.xhp +#. ekeZU +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id221598456991070\n" +"sf_form.xhp\n" +"par_id401583668386455\n" "help.text" -msgid "For times: \"24h short\", \"24h long\", \"12h short\", \"12h long\"." +msgid "Description" msgstr "" -#. RqjAh -#: sf_formcontrol.xhp +#. wSC47 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id501583774433513\n" +"sf_form.xhp\n" +"par_id371583668519172\n" "help.text" -msgid "Yes" +msgid "No" msgstr "" -#. E4aHX -#: sf_formcontrol.xhp +#. jJ2dL +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id151598177605296\n" +"sf_form.xhp\n" +"par_id771583668386455\n" "help.text" -msgid "Returns the number of rows in a ListBox or a ComboBox." +msgid "Specifies if the form allows to delete records." msgstr "" -#. ApC5v -#: sf_formcontrol.xhp +#. DBxgx +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id271588334016191\n" +"sf_form.xhp\n" +"par_id541583839708548\n" "help.text" msgid "No" msgstr "" -#. XQ3AV -#: sf_formcontrol.xhp +#. j5J3C +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id251588334016874\n" +"sf_form.xhp\n" +"par_id731583839708412\n" "help.text" -msgid "Specifies which item is selected in a ListBox or ComboBox. In case of multiple selection, the index of the first item is returned or only one item is set." +msgid "Specifies if the form allows to add records." msgstr "" -#. 5DjjX -#: sf_formcontrol.xhp +#. FCFEk +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id891616944120697\n" +"sf_form.xhp\n" +"par_id761584027709516\n" "help.text" msgid "No" msgstr "" -#. nNqW5 -#: sf_formcontrol.xhp +#. 8qCAE +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id901616944120614\n" +"sf_form.xhp\n" +"par_id971584027709752\n" "help.text" -msgid "Specifies the data contained in a ComboBox or a ListBox as a zero-based array of string values." +msgid "Specifies if the form allows to update records." msgstr "" -#. rvVZ7 -#: sf_formcontrol.xhp +#. VxAL4 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id21616944586559\n" +"sf_form.xhp\n" +"par_id31583839767743\n" "help.text" -msgid "Combined with ListSourceType, may also contain the name of a table, a query or a complete SQL statement." +msgid "Yes" msgstr "" -#. jqgF5 -#: sf_formcontrol.xhp +#. CRA7v +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id821616944631740\n" +"sf_form.xhp\n" +"par_id111583839767195\n" "help.text" -msgid "No" +msgid "Specifies the hierarchical name of the Base Form containing the actual form." msgstr "" -#. sqr2g -#: sf_formcontrol.xhp +#. FehA2 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id131616944631625\n" +"sf_form.xhp\n" +"par_id771583839920487\n" "help.text" -msgid "Specifies the type of data contained in a combobox or a listbox." +msgid "No" msgstr "" -#. GzpAN -#: sf_formcontrol.xhp +#. V8tZX +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id881616944631341\n" +"sf_form.xhp\n" +"par_id451583839920858\n" "help.text" -msgid "It must be one of the com.sun.star.form.ListSourceType.* constants." +msgid "Specifies uniquely the current record of the form's underlying table, query or SQL statement." msgstr "" -#. BQ7JE -#: sf_formcontrol.xhp +#. 3jDxi +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id961598457655506\n" +"sf_form.xhp\n" +"par_id571588333908716\n" "help.text" msgid "No" msgstr "" -#. EV4jD -#: sf_formcontrol.xhp -msgctxt "" -"sf_formcontrol.xhp\n" -"par_id2159845765568\n" +#. 7NUo8 +#: sf_form.xhp +msgctxt "" +"sf_form.xhp\n" +"par_id721588333908708\n" "help.text" -msgid "Specifies if the control is read-only." +msgid "Identifies the current record in the dataset being viewed on a form. If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. Row count starts at 1. If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. Row -1 refers to the last row in the result set." msgstr "" -#. CXDED -#: sf_formcontrol.xhp +#. FKDA7 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id621598457951781\n" +"sf_form.xhp\n" +"par_id501583774433513\n" "help.text" msgid "No" msgstr "" -#. e7HnA -#: sf_formcontrol.xhp +#. eAsdX +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id821598457951782\n" +"sf_form.xhp\n" +"par_id151598177605296\n" "help.text" -msgid "Specifies whether the user can select multiple items in a listbox." +msgid "Specifies a subset of records to be displayed as a SQL WHERE-clause without the WHERE keyword." msgstr "" -#. TZuvX -#: sf_formcontrol.xhp +#. uyje5 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id351598458170114\n" +"sf_form.xhp\n" +"par_id271588334016191\n" "help.text" msgid "Yes" msgstr "" -#. AtLKa -#: sf_formcontrol.xhp +#. FQDDW +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id151598539764402\n" +"sf_form.xhp\n" +"par_id251588334016874\n" "help.text" -msgid "All" +msgid "Specifies how records in a child subform are linked to records in its parent form." msgstr "" -#. EuBGK -#: sf_formcontrol.xhp +#. DMwPW +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id621598458170392\n" +"sf_form.xhp\n" +"par_id901616774153495\n" "help.text" -msgid "The name of the control." +msgid "Yes" msgstr "" -#. SNTgh -#: sf_formcontrol.xhp +#. 2EiCA +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id161598458580581\n" +"sf_form.xhp\n" +"par_id981616774153723\n" "help.text" -msgid "Yes" +msgid "Specifies how records in a child subform are linked to records in its parent form." msgstr "" -#. CTjAM -#: sf_formcontrol.xhp +#. ppCiD +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id181598539807426\n" +"sf_form.xhp\n" +"par_id501616774304840\n" "help.text" -msgid "All" +msgid "Yes" msgstr "" -#. z8w8o -#: sf_formcontrol.xhp +#. kPfzG +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id801598458580456\n" +"sf_form.xhp\n" +"par_id461616774304497\n" "help.text" -msgid "Depending on the parent type, a form, a subform or a tablecontrol, returns the parent SFDocuments.Form or SFDocuments.FormControl class object instance." +msgid "The name of the current form." msgstr "" -#. fyoXF -#: sf_formcontrol.xhp +#. vpBCA +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id971598458773352\n" +"sf_form.xhp\n" +"par_id751616774384451\n" "help.text" msgid "No" msgstr "" -#. RnXeR -#: sf_formcontrol.xhp +#. ppErx +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id451598458773588\n" +"sf_form.xhp\n" +"par_id321616774384489\n" "help.text" -msgid "Specifies the file name containing a bitmap or other type of graphic to be displayed on the control. The filename must comply with the FileNaming attribute of the ScriptForge.FileSystem service." +msgid "Specifies in which order the records should be displayed as a SQL ORDER BY clause without the ORDER BY keywords." msgstr "" -#. PHBtj -#: sf_formcontrol.xhp +#. AGC5s +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id251616946015886\n" +"sf_form.xhp\n" +"par_id261616774918923\n" "help.text" -msgid "No" +msgid "Yes" msgstr "" -#. oYA7V -#: sf_formcontrol.xhp +#. rjCpM +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id91616946015258\n" +"sf_form.xhp\n" +"par_id171616774918881\n" "help.text" -msgid "A control is said required when the underlying data must not contain a null value." +msgid "The parent of the current form. It can be either a SFDocuments.Form or a SFDocuments.Document object." msgstr "" -#. NbTpX -#: sf_formcontrol.xhp +#. rLS8r +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id781598516764550\n" +"sf_form.xhp\n" +"par_id501616777650751\n" "help.text" -msgid "Yes" +msgid "No" msgstr "" -#. Rv448 -#: sf_formcontrol.xhp +#. USDVC +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id11159851676440\n" +"sf_form.xhp\n" +"par_id91616777650933\n" "help.text" -msgid "Gives access to the text being displayed by the control." +msgid "Specifies the source of the data, as a table name, a query name or a SQL statement." msgstr "" -#. 7kxit -#: sf_formcontrol.xhp +#. rtCsj +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id411598517275112\n" +"sf_form.xhp\n" +"par_id451598177924437\n" "help.text" -msgid "No" +msgid "Yes" msgstr "" -#. MNqBi -#: sf_formcontrol.xhp +#. GxHLP +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id171598539985022\n" +"sf_form.xhp\n" +"par_id94159817792441\n" "help.text" -msgid "All (except HiddenControl)" +msgid "UNO
object" msgstr "" -#. VXR9Y -#: sf_formcontrol.xhp +#. 6xrep +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id651598517275384\n" +"sf_form.xhp\n" +"par_id191598177924897\n" "help.text" -msgid "Specifies the text that appears as a tooltip when you hover the mouse pointer over the control." +msgid "The UNO object representing interactions with the form. Refer to XForm and DataForm in the API documentation for detailed information." msgstr "" -#. Awzep -#: sf_formcontrol.xhp +#. cwE3k +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id821598517418463\n" +"sf_form.xhp\n" +"hd_id421612628828054\n" "help.text" -msgid "No" +msgid "Event properties" msgstr "" -#. 6S5EL -#: sf_formcontrol.xhp +#. eTuoa +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id141598517418822\n" +"sf_form.xhp\n" +"par_id41612629140856\n" "help.text" -msgid "Specifies if the checkbox control may appear dimmed (grayed) or not." +msgid "The properties below return or set URI strings that define the script triggered by the event." msgstr "" -#. mCQFz -#: sf_formcontrol.xhp +#. fdses +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id701598517671373\n" +"sf_form.xhp\n" +"par_id961612628879819\n" "help.text" -msgid "No" +msgid "Name" msgstr "" -#. vD3X4 -#: sf_formcontrol.xhp +#. DsQGQ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id1001598540024225\n" +"sf_form.xhp\n" +"par_id401612628879819\n" "help.text" -msgid "This property depends on the current control type. Refer to The Value property for more information." +msgid "ReadOnly" msgstr "" -#. ybVim -#: sf_formcontrol.xhp +#. 5FemG +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id661598517730941\n" +"sf_form.xhp\n" +"par_id281612628879819\n" "help.text" -msgid "No" +msgid "Basic IDE Description" msgstr "" -#. G52FE -#: sf_formcontrol.xhp +#. PgdP8 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id761598540042290\n" +"sf_form.xhp\n" +"par_id111612629836630\n" "help.text" -msgid "All (except HiddenControl)" +msgid "No" msgstr "" -#. 5juZG -#: sf_formcontrol.xhp +#. GAgms +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id881598517730836\n" +"sf_form.xhp\n" +"par_id1001612629836902\n" "help.text" -msgid "Specifies if the control is hidden or visible." +msgid "Before record change" msgstr "" -#. FAYCA -#: sf_formcontrol.xhp +#. Mr9ns +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id451598177924437\n" +"sf_form.xhp\n" +"par_id291612629836294\n" "help.text" -msgid "Yes" +msgid "No" msgstr "" -#. UZ7ug -#: sf_formcontrol.xhp -msgctxt "" -"sf_formcontrol.xhp\n" -"par_id94159817792441\n" -"help.text" -msgid "UNO
object" -msgstr "" - -#. 65CSA -#: sf_formcontrol.xhp +#. DwhZn +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id311598540066789\n" +"sf_form.xhp\n" +"par_id62161262983683\n" "help.text" -msgid "All" +msgid "Fill parameters" msgstr "" -#. ceFhn -#: sf_formcontrol.xhp +#. DrMbU +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id191598177924897\n" +"sf_form.xhp\n" +"par_id81612629836634\n" "help.text" -msgid "The UNO object representing the control model. Refer to XControlModel and UnoControlModel in the API documentation for more information." +msgid "No" msgstr "" -#. FzDR6 -#: sf_formcontrol.xhp +#. eAJAN +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id811598178083501\n" +"sf_form.xhp\n" +"par_id881612629836744\n" "help.text" -msgid "Yes" +msgid "Prior to reset" msgstr "" -#. Bdvyd -#: sf_formcontrol.xhp +#. Y9d6z +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id981598178083938\n" +"sf_form.xhp\n" +"par_id591612629836830\n" "help.text" -msgid "UNO
object" +msgid "No" msgstr "" -#. DFQ5P -#: sf_formcontrol.xhp +#. LKxEu +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id551598540079329\n" +"sf_form.xhp\n" +"par_id161612629836775\n" "help.text" -msgid "All" +msgid "Before record action" msgstr "" -#. fPcGS -#: sf_formcontrol.xhp +#. Zyx2S +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id731598178083442\n" +"sf_form.xhp\n" +"par_id891612629836630\n" "help.text" -msgid "The UNO object representing the control view. Refer to XControl and UnoControl in the API documentation for more information." +msgid "No" msgstr "" -#. pqsod -#: sf_formcontrol.xhp +#. 2HBeC +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"hd_id81598540704978\n" +"sf_form.xhp\n" +"par_id461612629836679\n" "help.text" -msgid "The Value property" +msgid "Before submitting" msgstr "" -#. PbEBw -#: sf_formcontrol.xhp +#. 2fJrZ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id10159854325492\n" +"sf_form.xhp\n" +"par_id131612629836291\n" "help.text" -msgid "Control type" +msgid "No" msgstr "" -#. bsmCC -#: sf_formcontrol.xhp +#. BX4AH +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id741598543254158\n" +"sf_form.xhp\n" +"par_id151612629836151\n" "help.text" -msgid "Type" +msgid "Confirm deletion" msgstr "" -#. MWgHB -#: sf_formcontrol.xhp +#. W9izF +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id961598543254444\n" +"sf_form.xhp\n" +"par_id211612629836725\n" "help.text" -msgid "Description" +msgid "No" msgstr "" -#. FLUGH -#: sf_formcontrol.xhp +#. pDvPB +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id741598543254108\n" +"sf_form.xhp\n" +"par_id361612629836624\n" "help.text" -msgid "Applicable to toggle buttons only." +msgid "After record change" msgstr "" -#. jpLCR -#: sf_formcontrol.xhp +#. WprGG +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id741598543254376\n" +"sf_form.xhp\n" +"par_id311612629836481\n" "help.text" -msgid "Boolean or Integer" +msgid "No" msgstr "" -#. ErAZY -#: sf_formcontrol.xhp +#. Xn2CS +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id521598543254630\n" +"sf_form.xhp\n" +"par_id721612629836752\n" "help.text" -msgid "0, False: not checked
1, True: checked
2: grayed out, don't know (applicable if TripleState is True)" +msgid "Error occurred" msgstr "" -#. 3frrW -#: sf_formcontrol.xhp +#. B3zCy +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id331598543254947\n" +"sf_form.xhp\n" +"par_id981612629836116\n" "help.text" -msgid "The selected value, as a String. The ListIndex property is an alternate option to access the index of the selected value." +msgid "No" msgstr "" -#. faEEm -#: sf_formcontrol.xhp +#. L3Ac6 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id5159854325443\n" +"sf_form.xhp\n" +"par_id381612629836635\n" "help.text" -msgid "Numeric" +msgid "When loading" msgstr "" -#. VyagB -#: sf_formcontrol.xhp +#. 9Z9vv +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id971598543254757\n" +"sf_form.xhp\n" +"par_id711612629836704\n" "help.text" -msgid "A file name formatted in accordance with the FileNaming property of the ScriptForge.FileSystem service" +msgid "No" msgstr "" -#. CaGtr -#: sf_formcontrol.xhp +#. XL4Js +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id221598543254760\n" +"sf_form.xhp\n" +"par_id35161262983642\n" "help.text" -msgid "String or Numeric" +msgid "When reloading" msgstr "" -#. gtxJY -#: sf_formcontrol.xhp +#. P6DEi +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id42159854325422\n" +"sf_form.xhp\n" +"par_id44161677878329\n" "help.text" -msgid "String or array of strings" +msgid "No" msgstr "" -#. kBH32 -#: sf_formcontrol.xhp +#. ywCsh +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id601598543254780\n" +"sf_form.xhp\n" +"par_id661616778783899\n" "help.text" -msgid "The selected row(s) as a single string or an array of strings. Only a single value can be set. If the box is linked to a database, this property gets or sets the underlying data. Otherwise it gets or sets the data being displayed." +msgid "Before reloading" msgstr "" -#. f7EZX -#: sf_formcontrol.xhp +#. eGnRj +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id461598543254909\n" +"sf_form.xhp\n" +"par_id651616778529764\n" "help.text" -msgid "Numeric" +msgid "No" msgstr "" -#. DrhU9 -#: sf_formcontrol.xhp +#. E6JUH +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id851598543254624\n" +"sf_form.xhp\n" +"par_id311616778529570\n" "help.text" -msgid "Each button has its own name. Multiple RadioButton controls are linked together when they share the same group name. If a RadioButton is set to True, the other related buttons are automatically set to False" +msgid "After resetting" msgstr "" -#. WEsqT -#: sf_formcontrol.xhp +#. VDAk5 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id531598543254869\n" +"sf_form.xhp\n" +"par_id601616778529481\n" "help.text" -msgid "Numeric" +msgid "No" msgstr "" -#. LxeLY -#: sf_formcontrol.xhp +#. 99FfH +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id21598543254994\n" +"sf_form.xhp\n" +"par_id351616778529352\n" "help.text" -msgid "Must be within the predefined bounds" +msgid "After record action" msgstr "" -#. mpoa7 -#: sf_formcontrol.xhp +#. CxndA +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id951616947400919\n" +"sf_form.xhp\n" +"par_id711616778529292\n" "help.text" -msgid "Numeric" +msgid "No" msgstr "" -#. x6ZLt -#: sf_formcontrol.xhp +#. DTDCq +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id48161694740085\n" +"sf_form.xhp\n" +"par_id981616778529250\n" "help.text" -msgid "Must be within the predefined bounds" +msgid "When unloading" msgstr "" -#. UZLYC -#: sf_formcontrol.xhp +#. iWroa +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id441598543254738\n" +"sf_form.xhp\n" +"par_id521616778529932\n" "help.text" -msgid "The text appearing in the field" +msgid "No" msgstr "" -#. WBHoJ -#: sf_formcontrol.xhp +#. pVPR9 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"hd_id421612628828054\n" +"sf_form.xhp\n" +"par_id511616778529291\n" "help.text" -msgid "Event properties" +msgid "Before unloading" msgstr "" -#. tqnsA -#: sf_formcontrol.xhp +#. GWajw +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id41612629140856\n" +"sf_form.xhp\n" +"par_id961618181634322\n" "help.text" -msgid "The properties below return or set URI strings that define the script triggered by the event." +msgid "To learn more about URI strings, refer to the Scripting Framework URI Specification." msgstr "" -#. 7Azyz -#: sf_formcontrol.xhp +#. bkBH8 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id961612628879819\n" +"sf_form.xhp\n" +"par_id921606472825856\n" "help.text" -msgid "Name" +msgid "List of methods in the Form service" msgstr "" -#. N4btE -#: sf_formcontrol.xhp +#. KwDij +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id401612628879819\n" +"sf_form.xhp\n" +"par_id871583933076448\n" "help.text" -msgid "ReadOnly" +msgid "Sets the focus on the current Form instance. Returns True if focusing was successful." msgstr "" -#. RXoDM -#: sf_formcontrol.xhp +#. 9qj5F +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id281612628879819\n" +"sf_form.xhp\n" +"par_id81616858956290\n" "help.text" -msgid "Description as labeled in the Basic IDE" +msgid "The behavior of the Activate method depends on the type of document where the form is located:" msgstr "" -#. yhjPA -#: sf_formcontrol.xhp +#. YVgyr +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id91612707166532\n" +"sf_form.xhp\n" +"par_id761616858967361\n" "help.text" -msgid "No" +msgid "In Writer documents: Sets the focus on that document." msgstr "" -#. HVTKN -#: sf_formcontrol.xhp +#. HKFTw +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id291612707166258\n" +"sf_form.xhp\n" +"par_id931616859010103\n" "help.text" -msgid "Execute action" +msgid "In Calc documents: Sets the focus on the sheet to which the form belongs." msgstr "" -#. T5CTw -#: sf_formcontrol.xhp +#. 6jx5G +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id79161270716675\n" +"sf_form.xhp\n" +"par_id41616859019478\n" "help.text" -msgid "No" +msgid "In Base documents: Sets the focus on the FormDocument the Form refers to." msgstr "" -#. qs3LA -#: sf_formcontrol.xhp +#. J5C7y +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id831612707166731\n" +"sf_form.xhp\n" +"par_id921618228229529\n" "help.text" -msgid "While adjusting" +msgid "The following example assumes you want to activate the form named FormA located in Sheet1 of the currently open Calc file. It first gets access to the document using the Document service and ThisComponent and then activates the form." msgstr "" -#. vUbN6 -#: sf_formcontrol.xhp +#. 4EC5M +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id301616948330694\n" +"sf_form.xhp\n" +"bas_id21618228468066\n" "help.text" -msgid "No" +msgid "'Gets hold of the form that will be activated" msgstr "" -#. PopWN -#: sf_formcontrol.xhp +#. M2Wks +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id901616948330305\n" +"sf_form.xhp\n" +"bas_id201618228487565\n" "help.text" -msgid "Approve action" +msgid "'Activates the form" msgstr "" -#. PmE7k -#: sf_formcontrol.xhp +#. YHxMm +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id821616948330888\n" +"sf_form.xhp\n" +"par_id81618228720782\n" "help.text" -msgid "No" +msgid "ThisComponent applies to Calc and Writer documents. For Base documents use ThisDataBaseDocument." msgstr "" -#. rjQCJ -#: sf_formcontrol.xhp +#. QznyJ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id111616948330257\n" +"sf_form.xhp\n" +"par_id501616860541195\n" "help.text" -msgid "Prior to reset" +msgid "Closes the form document containing the actual Form instance. The Form instance is disposed." msgstr "" -#. octLi -#: sf_formcontrol.xhp +#. CcCpD +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id271616948330553\n" +"sf_form.xhp\n" +"par_id611618229004669\n" "help.text" -msgid "No" +msgid "This method only closes form documents located in Base documents. If the form is stored in a Writer or Calc document, calling CloseFormDocument will have no effect." msgstr "" -#. D7yir -#: sf_formcontrol.xhp +#. a8CxQ +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id451616948330759\n" +"sf_form.xhp\n" +"par_id161584541257982\n" "help.text" -msgid "Before updating" +msgid "The value returned by the Controls method depends on the arguments provided:" msgstr "" -#. YM7Nt -#: sf_formcontrol.xhp +#. VXWwg +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id71616948330769\n" +"sf_form.xhp\n" +"par_id421598179770993\n" "help.text" -msgid "No" +msgid "If the method is called without arguments, then it returns the list of the controls contained in the form. Be aware that the returned list does not contain any subform controls." msgstr "" -#. pHG54 -#: sf_formcontrol.xhp +#. SsiUX +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id211616948330895\n" +"sf_form.xhp\n" +"par_id81598185229301\n" "help.text" -msgid "Changed" +msgid "If the optional ControlName argument is provided, the method returns a FormControl class instance referring to the specified control." msgstr "" -#. UaRoN -#: sf_formcontrol.xhp +#. 7CFJU +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id121616948330654\n" +"sf_form.xhp\n" +"par_id1001584541257789\n" "help.text" -msgid "No" +msgid "controlname : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array." msgstr "" -#. tfW7M -#: sf_formcontrol.xhp +#. PTqJ2 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id2216169483303\n" +"sf_form.xhp\n" +"par_id291616861407907\n" "help.text" -msgid "Error occurred" +msgid "Return a SFDatabases.Database instance giving access to the execution of SQL commands on the database the current form is connected to and/or that is stored in the current Base document." msgstr "" -#. vDFhJ -#: sf_formcontrol.xhp +#. fZRst +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id111612629836630\n" +"sf_form.xhp\n" +"par_id991616861417207\n" "help.text" -msgid "No" +msgid "Each form has its own database connection, except in Base documents where they all share the same connection." msgstr "" -#. NN9FK -#: sf_formcontrol.xhp +#. wFSWb +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id1001612629836902\n" +"sf_form.xhp\n" +"par_id701616861134906\n" "help.text" -msgid "When receiving focus" +msgid "user, password: The login optional parameters (Default = \"\")." msgstr "" -#. tLp7Y -#: sf_formcontrol.xhp +#. 83Jju +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id291612629836294\n" +"sf_form.xhp\n" +"par_id771616861842867\n" "help.text" -msgid "No" +msgid "The form cursor is positioned on the first record. Returns True if successful." msgstr "" -#. DDcCF -#: sf_formcontrol.xhp +#. rapRE +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id62161262983683\n" +"sf_form.xhp\n" +"par_id331616863143187\n" "help.text" -msgid "When losing focus" +msgid "The form cursor is positioned on the last record. Returns True if successful." msgstr "" -#. EBVQM -#: sf_formcontrol.xhp +#. HZELb +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id51612707354544\n" +"sf_form.xhp\n" +"par_id361616863143954\n" "help.text" -msgid "No" +msgid "The form cursor is positioned on the new record area. Returns True if successful." msgstr "" -#. PLPUr -#: sf_formcontrol.xhp +#. 2QwcR +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id211612707354899\n" +"sf_form.xhp\n" +"par_id541616863143461\n" "help.text" -msgid "Item status changed" +msgid "The form cursor is positioned on the next record. Returns True if successful." msgstr "" -#. zBci2 -#: sf_formcontrol.xhp +#. a2gGn +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id81612629836634\n" +"sf_form.xhp\n" +"par_id271616863582607\n" "help.text" -msgid "No" +msgid "offset: The number of records to go forward (Default = 1)." msgstr "" -#. vPrAA -#: sf_formcontrol.xhp +#. e6huC +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id881612629836744\n" +"sf_form.xhp\n" +"par_id616168637945\n" "help.text" -msgid "Key pressed" +msgid "The form cursor is positioned on the previous record. Returns True if successful." msgstr "" -#. 8cFqR -#: sf_formcontrol.xhp +#. tAnVw +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id591612629836830\n" +"sf_form.xhp\n" +"par_id751616863794125\n" "help.text" -msgid "No" +msgid "offset: The number of records to go backwards (Default = 1)." msgstr "" -#. 6rrBt -#: sf_formcontrol.xhp +#. Kp4Wo +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id161612629836775\n" +"sf_form.xhp\n" +"par_id811616864216529\n" "help.text" -msgid "Key released" +msgid "Reloads the current data from the database and refreshes the form. The cursor is positioned on the first record. Returns True if successful." msgstr "" -#. 7Pzmy -#: sf_formcontrol.xhp +#. 5gBGr +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id891612629836630\n" +"sf_form.xhp\n" +"par_id891616864510614\n" "help.text" -msgid "No" +msgid "The value returned by the Subforms method depends on the arguments provided:" msgstr "" -#. 2pMWG -#: sf_formcontrol.xhp +#. 4yG2j +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id461612629836679\n" +"sf_form.xhp\n" +"par_id951616864510585\n" "help.text" -msgid "Mouse moved while key presses" +msgid "If the method is called without any arguments, then it returns the list of subforms contained in the current form or subform instance." msgstr "" -#. SGYBr -#: sf_formcontrol.xhp +#. AD3Q6 +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id131612629836291\n" +"sf_form.xhp\n" +"par_id591616864510445\n" "help.text" -msgid "No" +msgid "If the optional subform argument is provided, the method returns a new SFDocuments.Form instance based on the specified form/subform name or index." msgstr "" -#. AJGQd -#: sf_formcontrol.xhp +#. GCRsS +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id151612629836151\n" +"sf_form.xhp\n" +"par_id341616864510747\n" "help.text" -msgid "Mouse inside" +msgid "subform: A subform stored in the current Form class instance given by its name or index." msgstr "" -#. 6cFkB -#: sf_formcontrol.xhp +#. uKm6R +#: sf_form.xhp msgctxt "" -"sf_formcontrol.xhp\n" -"par_id211612629836725\n" +"sf_form.xhp\n" +"par_id211618230389251\n" "help.text" -msgid "No" +msgid "When this argument is absent, the method returns a list of available subforms as a zero-based array. If the form has a single subform, you can set subform = 0 to get access to it." msgstr "" -#. tfmtf +#. CfGgB #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id361612629836624\n" +"tit\n" "help.text" -msgid "Mouse outside" +msgid "SFDocuments.FormControl service" msgstr "" -#. 6E7WA +#. U4CgG #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id311612629836481\n" +"bm_id781582391760253\n" "help.text" -msgid "No" +msgid "SFDocuments.FormControl service" msgstr "" -#. CeNku +#. XFkrG #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id721612629836752\n" +"par_id931583589764919\n" "help.text" -msgid "Mouse moved" +msgid "The FormControl service provides access to the controls that belong to a form, a subform or a table control of a FormDocument. Each instance of the FormControl service refers to a single control in the form. This service allows users to:" msgstr "" -#. iSxsS +#. irNFC #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id981612629836116\n" +"par_id451618771561326\n" "help.text" -msgid "No" +msgid "Get and set the properties of the control represented by the FormControl instance." msgstr "" -#. 9yirD +#. S5aH9 #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id381612629836635\n" +"par_id601618771565183\n" "help.text" -msgid "Mouse button pressed" +msgid "Access the current value displayed by the control." msgstr "" -#. b6pFV +#. P5xzV #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id711612629836704\n" +"par_id981618771567951\n" "help.text" -msgid "No" +msgid "Set the focus on the desired control." msgstr "" -#. D5vXU +#. LUDRM #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id35161262983642\n" +"par_id301616939922857\n" "help.text" -msgid "Mouse button released" +msgid "To use the FormControl service in a particular form, subform or table control, all controls must have unique names." msgstr "" -#. 9Ui2H +#. JMFEb #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id31616948666215\n" +"par_id541618771629112\n" "help.text" -msgid "No" +msgid "Radio buttons that share the same group name must also have unique control names." msgstr "" -#. mdLSp +#. mAwyv #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id951616948666674\n" +"par_id51618771641273\n" "help.text" -msgid "After resetting" +msgid "The main purpose of the FormControl service is setting and getting the properties and values displayed by the controls in a form." msgstr "" -#. jb4at +#. egjZu #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id811612707606330\n" +"par_id81618774023346\n" "help.text" -msgid "No" +msgid "All controls have a Value property. However, its contents will vary according to the control type. For more information, read The Value Property below." msgstr "" -#. m3Rb7 +#. kF29h #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id621612707606219\n" +"par_id881618771651907\n" "help.text" -msgid "Text modified" +msgid "It is also possible to format the controls via the XControlModel and XControlView properties." msgstr "" -#. bfgkG +#. SGsH8 #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id41616948721642\n" +"par_id891598188164936\n" "help.text" -msgid "No" +msgid "The SFDocuments.FormControl service is closely related to the SFDocuments.Form service." msgstr "" -#. imn6B +#. rUEuw #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id311616948721872\n" +"hd_id581582885621841\n" "help.text" -msgid "After updating" +msgid "Service invocation" msgstr "" -#. PuSPh +#. pzkhK #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id961618181634181\n" +"par_id141609955500101\n" "help.text" -msgid "To learn more about URI strings, refer to the Scripting Framework URI Specification." +msgid "Before using the FormControl service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. RpNkd +#. BeDqF #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id891611613601554\n" +"par_id361598174756160\n" "help.text" -msgid "List of Methods in the FormControl Service" +msgid "The FormControl service is invoked from an existing Form service instance through its Controls method." msgstr "" -#. CKZDf +#. 56bE7 #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id161584541257982\n" +"pyc_id721622556808773\n" "help.text" -msgid "This method is applicable only to controls of the TableControl type. The returned value depends on the arguments provided." +msgid "control.Value = 'Current Time = ' + strftime(\"%a, %d %b %Y %H:%M:%S\", localtime())" msgstr "" -#. DB3PG +#. LG9Md #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id701618777636827\n" +"par_id781618772761258\n" "help.text" -msgid "If the optional argument controlname is absent, then a zero-based Array containing the names of all controls is returned." +msgid "To learn more about how to open a FormDocument and get access to its forms, refer to the SFDocuments.Form service help page." msgstr "" -#. GgAeu +#. qeXCN #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id851618777715892\n" +"par_id951598174966322\n" "help.text" -msgid "On the other hand, if a controlname is provided, the method returns a FormControl class instance corresponding to the specified control." +msgid "Alternatively a FormControl instance can be retrieved via the SFDocuments.FormEvent service, which returns the SFDocuments.FormControl class instance that triggered the event." msgstr "" -#. eoLJG +#. bSfxy #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id1001584541257789\n" +"bas_id801598175242937\n" "help.text" -msgid "controlname: A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array." +msgid "' oControl now represents the instance of the FormControl class that triggered the current event" msgstr "" -#. F4Sdy +#. EgCtB #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"bas_id471618778075117\n" +"par_id251598176312571\n" "help.text" -msgid "' Returns an Array with the names of all controls in \"myTableControl\"" +msgid "Note that in previous examples, the prefix \"SFDocuments.\" may be omitted." msgstr "" -#. YoHSo +#. 7gE8Y #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id931618778110273\n" +"par_id951618773412097\n" "help.text" -msgid "' Returns a FormControl class instance corresponding to \"myCheckBox\"" +msgid "The FormEvent service is used exclusively to create instances of the SFDocuments.Form and SFDocuments.FormControl services when a form or control event takes place." msgstr "" -#. AGA7Z +#. AppFj #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id391622559441530\n" +"hd_id71598455687512\n" "help.text" -msgid "Using Python:" +msgid "Control types" msgstr "" -#. CprjV +#. ezcW8 #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id871583933076448\n" +"par_id851598455863395\n" "help.text" -msgid "Sets the focus on the control. Returns True if focusing was successful." +msgid "The FormControl service is available for the following control types:" msgstr "" -#. LuxFE +#. BESBv #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id151598178880227\n" +"hd_id651583668365757\n" "help.text" -msgid "This method is often called from a form or control event." +msgid "Properties" msgstr "" -#. haAXC +#. VrBfK #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"hd_id141618777179310\n" +"par_id871583668386455\n" "help.text" -msgid "Additional examples" +msgid "Name" msgstr "" -#. JopFS +#. hDr9G #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id331618777195723\n" +"par_id491583668386455\n" "help.text" -msgid "Below are two examples that illustrate the use of the FormControl service." +msgid "Readonly" msgstr "" -#. 5iGmg +#. kWac7 #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id371618776324489\n" +"par_id271583668474014\n" "help.text" -msgid "The first example reads the current value in a ComboBox containing city names and writes it to a FixedTest control in a Form:" +msgid "Type" msgstr "" -#. 3eh6E +#. dXwGN #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"pyc_id991622562833004\n" +"par_id291598538799794\n" "help.text" -msgid "bas = CreateScriptService('ScriptForge.Basic') # Basic-like methods" +msgid "Applicable to" msgstr "" -#. 8jneo +#. bEQWc #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"pyc_id781622561048794\n" +"par_id401583668386455\n" "help.text" -msgid "lbl_city.Caption = \"Selected city: \" + combo_city.Value" +msgid "Description" msgstr "" -#. kz9SK +#. N3ejK #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"par_id251618776614814\n" +"par_id371583668519172\n" "help.text" -msgid "The following code snippet can be used to process RadioButton controls that share the same group name. In this example, suppose there are three radio buttons with names optA, optB and optC and we wish to display the caption of the selected control." +msgid "No" msgstr "" -#. hRhNC +#. PszFp #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"bas_id251618776933304\n" +"par_id771583668386455\n" "help.text" -msgid "MsgBox \"Selected option: \" & optControl.Caption" +msgid "Specifies the action triggered when the button is clicked. Accepted values are: none, submitForm, resetForm, refreshForm, moveToFirst, moveToLast, moveToNext, moveToPrev, saveRecord, moveToNew, deleteRecord, undoRecord." msgstr "" -#. YnBgM +#. fmzNT #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"pyc_id991622562822004\n" +"par_id541583839708548\n" "help.text" -msgid "bas = CreateScriptService('ScriptForge.Basic') # Basic-like methods" +msgid "No" msgstr "" -#. TNTT9 +#. 62Bud #: sf_formcontrol.xhp msgctxt "" "sf_formcontrol.xhp\n" -"pyc_id441622562080419\n" +"par_id731583839708412\n" "help.text" -msgid "bas.MsgBox('Selected option: ' + control.Caption)" +msgid "Specifies the text displayed by the control." msgstr "" -#. evuZx -#: sf_formdocument.xhp +#. nFFDY +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"tit\n" +"sf_formcontrol.xhp\n" +"par_id411616942306677\n" "help.text" -msgid "SFDocuments.FormDocument service" +msgid "Yes" msgstr "" -#. AQWCM -#: sf_formdocument.xhp +#. 8H6BR +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"bm_id781582391760253\n" +"sf_formcontrol.xhp\n" +"par_id461616942306745\n" "help.text" -msgid "SFDocuments.FormDocument service" +msgid "Specifies the rowset field mapped onto the current control." msgstr "" -#. hQ3hK -#: sf_formdocument.xhp +#. AJUH6 +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id321692486382326\n" +"sf_formcontrol.xhp\n" +"par_id761584027709516\n" "help.text" -msgid "The FormDocument service allows to access form documents stored in %PRODUCTNAME Base documents." +msgid "Yes" msgstr "" -#. zQHTF -#: sf_formdocument.xhp +#. Enqxp +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id621692487292145\n" +"sf_formcontrol.xhp\n" +"par_id261598539120502\n" "help.text" -msgid "In a Base document, existing form documents can be viewed by selecting View - Forms in the user interface. Each form document may be composed of one or more forms, including the main form and other sub-forms." +msgid "All" msgstr "" -#. uNbgU -#: sf_formdocument.xhp +#. FsCJK +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id891692486448415\n" +"sf_formcontrol.xhp\n" +"par_id971584027709752\n" "help.text" -msgid "This service inherits methods and properties from the Document service and is often used alongside the Base and Database services." +msgid "One of the control types listed above." msgstr "" -#. gGFFZ -#: sf_formdocument.xhp +#. DH84k +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id241619032941497\n" +"sf_formcontrol.xhp\n" +"par_id31583839767743\n" "help.text" -msgid "Refer to the Document service to learn more about methods and properties that can be used to manage %PRODUCTNAME documents." +msgid "No" msgstr "" -#. 3jTab -#: sf_formdocument.xhp +#. pRrwC +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"hd_id581582885621841\n" +"sf_formcontrol.xhp\n" +"par_id111583839767195\n" "help.text" -msgid "Service invocation" +msgid "Specifies whether a command button is the default OK button." msgstr "" -#. KxGkv -#: sf_formdocument.xhp +#. 2dP2A +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id141609955500101\n" +"sf_formcontrol.xhp\n" +"par_id241616942739459\n" "help.text" -msgid "Before using the FormDocument service the ScriptForge library needs to be loaded or imported:" +msgid "No" msgstr "" -#. 99UBC -#: sf_formdocument.xhp +#. Sukx9 +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id991692486784449\n" +"sf_formcontrol.xhp\n" +"par_id271616942739359\n" "help.text" -msgid "A FormDocument service instance can be created by calling the method OpenFormDocument that exists both in the Base and Database services." +msgid "Specifies the default value used to initialize a control in a new record." msgstr "" -#. txPPF -#: sf_formdocument.xhp +#. nFBUQ +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id381692486890118\n" +"sf_formcontrol.xhp\n" +"par_id771583839920487\n" "help.text" -msgid "The example below uses the UI service to open a Base document and then retrieve a form document. Note that in this example both the Base document and the form document will be opened and displayed on the screen." +msgid "No" msgstr "" -#. qkQZ7 -#: sf_formdocument.xhp +#. fQYqd +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id151692489140384\n" +"sf_formcontrol.xhp\n" +"par_id891598539196786\n" "help.text" -msgid "Calling OpenFormDocument for a form document that is already open will activate the document window and bring it to focus." +msgid "All (except HiddenControl)" msgstr "" -#. vEFGV -#: sf_formdocument.xhp +#. MmDQ5 +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id871623102536956\n" +"sf_formcontrol.xhp\n" +"par_id451583839920858\n" "help.text" -msgid "The examples above can be translated to Python as follows:" +msgid "Specifies if the control is accessible with the cursor." msgstr "" -#. wxdh6 -#: sf_formdocument.xhp +#. VDkDh +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id451619034669263\n" +"sf_formcontrol.xhp\n" +"par_id571588333908716\n" "help.text" -msgid "List of Methods in the FormDocument Service" +msgid "No" msgstr "" -#. jY8vp -#: sf_formdocument.xhp +#. 8X3Ho +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id801916099743199\n" +"sf_formcontrol.xhp\n" +"par_id721588333908708\n" "help.text" -msgid "Closes the form document referred to by the FormDocument instance. Returns True if the form document was successfully closed." +msgid "Specifies the format used to display dates and times. It must be one of following strings:" msgstr "" -#. wN7iT -#: sf_formdocument.xhp +#. 6CqCN +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id481619036833610\n" +"sf_formcontrol.xhp\n" +"par_id891598456980194\n" "help.text" -msgid "Returns either an array with the names of the main forms contained in the form document or a Form service instance referring to a specific form." +msgid "For dates: \"Standard (short)\", \"Standard (short YY)\", \"Standard (short YYYY)\", \"Standard (long)\", \"DD/MM/YY\", \"MM/DD/YY\", \"YY/MM/DD\", \"DD/MM/YYYY\", \"MM/DD/YYYY\" , \"YYYY/MM/DD\", \"YY-MM-DD\", \"YYYY-MM-DD\"." msgstr "" -#. RuFja -#: sf_formdocument.xhp +#. f6gni +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id311692532433990\n" +"sf_formcontrol.xhp\n" +"par_id221598456991070\n" "help.text" -msgid "Call this method without arguments to obtain a zero-based string array with the names of all forms contained in the form document." +msgid "For times: \"24h short\", \"24h long\", \"12h short\", \"12h long\"." msgstr "" -#. qg4FH -#: sf_formdocument.xhp +#. RqjAh +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id491692532525080\n" +"sf_formcontrol.xhp\n" +"par_id501583774433513\n" "help.text" -msgid "Provide a form name or index as argument to obtain a Form service instance corresponding to the specified form." +msgid "Yes" msgstr "" -#. GbkH9 -#: sf_formdocument.xhp +#. E4aHX +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id281692532725116\n" +"sf_formcontrol.xhp\n" +"par_id151598177605296\n" "help.text" -msgid "A form document has at least one main form. More complex form documents may be composed of more than one form and sub-forms." +msgid "Returns the number of rows in a ListBox or a ComboBox." msgstr "" -#. Au3TH -#: sf_formdocument.xhp +#. ApC5v +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id91692538279673\n" +"sf_formcontrol.xhp\n" +"par_id271588334016191\n" "help.text" -msgid "svc.Forms(form: str): svc" +msgid "No" msgstr "" -#. TKZq2 -#: sf_formdocument.xhp +#. XQ3AV +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id91692538279664\n" +"sf_formcontrol.xhp\n" +"par_id251588334016874\n" "help.text" -msgid "svc.Forms(form: int): svc" +msgid "Specifies which item is selected in a ListBox or ComboBox. In case of multiple selection, the index of the first item is returned or only one item is set." msgstr "" -#. 23Cgd -#: sf_formdocument.xhp +#. 5DjjX +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id211692538352686\n" +"sf_formcontrol.xhp\n" +"par_id891616944120697\n" "help.text" -msgid "form: This argument can be either a string with the name of a form that exists in the form document or the zero-based index of the form that shall be returned. If this argument is not specific, then an array with the name of all available forms is returned." +msgid "No" msgstr "" -#. wktWB -#: sf_formdocument.xhp +#. nNqW5 +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id151692537703209\n" +"sf_formcontrol.xhp\n" +"par_id901616944120614\n" "help.text" -msgid "The following example checks if the form document contains a form named \"MainForm\":" +msgid "Specifies the data contained in a ComboBox or a ListBox as a zero-based array of string values." msgstr "" -#. nNdtW -#: sf_formdocument.xhp +#. rvVZ7 +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id661692537831637\n" +"sf_formcontrol.xhp\n" +"par_id21616944586559\n" "help.text" -msgid "The example below retrieves the form named \"MainForm\" and moves it to the last record:" +msgid "Combined with ListSourceType, may also contain the name of a table, a query or a complete SQL statement." msgstr "" -#. Nw4c6 -#: sf_formdocument.xhp +#. jqgF5 +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id921619036922844\n" +"sf_formcontrol.xhp\n" +"par_id821616944631740\n" "help.text" -msgid "To learn more about form methods and properties, refer to the Form service help page." +msgid "No" msgstr "" -#. 5SoGW -#: sf_formdocument.xhp +#. sqr2g +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id156589200121138\n" +"sf_formcontrol.xhp\n" +"par_id131616944631625\n" "help.text" -msgid "This method sends the contents form document to the default printer or to the printer defined by the SetPrinter() method." +msgid "Specifies the type of data contained in a combobox or a listbox." msgstr "" -#. hQ6GC -#: sf_formdocument.xhp +#. GzpAN +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id981611169416934\n" +"sf_formcontrol.xhp\n" +"par_id881616944631341\n" "help.text" -msgid "Returns True if the document was successfully sent to the printer." +msgid "It must be one of the com.sun.star.form.ListSourceType.* constants." msgstr "" -#. 2qnYG -#: sf_formdocument.xhp +#. BQ7JE +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id211635436910093\n" +"sf_formcontrol.xhp\n" +"par_id961598457655506\n" "help.text" -msgid "pages: The pages to print as a string. This argument should be specified in the same manner as in the user interface (see File - Print dialog). Example: \"1-4;10;15-18\". The default value is an empty string \"\" which will cause all pages to be printed." +msgid "No" msgstr "" -#. mxFXk -#: sf_formdocument.xhp +#. EV4jD +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id141635436912146\n" +"sf_formcontrol.xhp\n" +"par_id2159845765568\n" "help.text" -msgid "copies: The number of copies to be printed (Default = 1)." +msgid "Specifies if the control is read-only." msgstr "" -#. nr7DR -#: sf_formdocument.xhp +#. CXDED +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id871692539875337\n" +"sf_formcontrol.xhp\n" +"par_id621598457951781\n" "help.text" -msgid "printbackground: specifies whether the background image should be printed (Default = True)." +msgid "No" msgstr "" -#. dDtPU -#: sf_formdocument.xhp +#. e7HnA +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id661692539947123\n" +"sf_formcontrol.xhp\n" +"par_id821598457951782\n" "help.text" -msgid "printblankpages: specifies whether blank pages should be printed (Default = False)." +msgid "Specifies whether the user can select multiple items in a listbox." msgstr "" -#. hJvtc -#: sf_formdocument.xhp +#. TZuvX +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id661692539947144\n" +"sf_formcontrol.xhp\n" +"par_id351598458170114\n" "help.text" -msgid "printevenpages: specifies whether even pages should be printed (Default = True)." +msgid "Yes" msgstr "" -#. 7tyim -#: sf_formdocument.xhp +#. AtLKa +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id661692539947875\n" +"sf_formcontrol.xhp\n" +"par_id151598539764402\n" "help.text" -msgid "printoddpages: specifies whether odd pages should be printed (Default = True)." +msgid "All" msgstr "" -#. BxCRK -#: sf_formdocument.xhp +#. EuBGK +#: sf_formcontrol.xhp msgctxt "" -"sf_formdocument.xhp\n" -"par_id661692539947323\n" +"sf_formcontrol.xhp\n" +"par_id621598458170392\n" "help.text" -msgid "printimages: specifies whether images should be printed (Default = True)." +msgid "The name of the control." msgstr "" -#. czP76 -#: sf_intro.xhp +#. SNTgh +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"tit\n" +"sf_formcontrol.xhp\n" +"par_id161598458580581\n" "help.text" -msgid "Creating Python Scripts with ScriptForge" -msgstr "ScriptForgeを利用したPythonスクリプトの作成" +msgid "Yes" +msgstr "" -#. QFG5C -#: sf_intro.xhp +#. CTjAM +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id461623364876507\n" +"sf_formcontrol.xhp\n" +"par_id181598539807426\n" "help.text" -msgid "Creating Python Scripts with ScriptForge" -msgstr "ScriptForgeを利用したPythonスクリプトの作成" +msgid "All" +msgstr "" -#. 6JuA3 -#: sf_intro.xhp +#. z8w8o +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id361623410405420\n" +"sf_formcontrol.xhp\n" +"par_id801598458580456\n" "help.text" -msgid "Differences between Basic and Python" -msgstr "BasicとPythonの違い" +msgid "Depending on the parent type, a form, a subform or a tablecontrol, returns the parent SFDocuments.Form or SFDocuments.FormControl class object instance." +msgstr "" -#. GwT9x -#: sf_intro.xhp +#. fyoXF +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id41623410443946\n" +"sf_formcontrol.xhp\n" +"par_id971598458773352\n" "help.text" -msgid "The ScriptForge library is available both for Basic and Python. Most services, methods and properties work identically in both programming languages. However, due to differences in how each language works, ScriptForge users must be aware of some characteristics of the library when using Python:" -msgstr "ScriptForgeライブラリは、BasicとPython両方に対応しており、ほとんどのサービス、メソッド、プロパティは、どちらのプラグラミング言語でも同じように動作します。ですが、言語により動作が異なるのでPythonからScriptForgeを使う場合、ライブラリの特性に注意する必要があります。" +msgid "No" +msgstr "" -#. HsKzK -#: sf_intro.xhp +#. RnXeR +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id551623410718241\n" +"sf_formcontrol.xhp\n" +"par_id451598458773588\n" "help.text" -msgid "Methods and Property names: In Python, all methods and properties can be used in lowercased, ProperCased or camelCased formats." -msgstr "メソッドとプロパティ名: Pythonでは、すべてのメソッドとプロパティの名前に小文字のみ、先頭の文字を大文字、キャメルケースの形式が使えます。" +msgid "Specifies the file name containing a bitmap or other type of graphic to be displayed on the control. The filename must comply with the FileNaming attribute of the ScriptForge.FileSystem service." +msgstr "" -#. Rg29x -#: sf_intro.xhp +#. PHBtj +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id741623411104297\n" +"sf_formcontrol.xhp\n" +"par_id251616946015886\n" "help.text" -msgid "Arguments: All keyword arguments passed on to methods are lowercased." -msgstr "引数: メソッドに渡されるすべてのキーワード引数は小文字です。" +msgid "No" +msgstr "" -#. C6VCu -#: sf_intro.xhp +#. oYA7V +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id441623411216354\n" +"sf_formcontrol.xhp\n" +"par_id91616946015258\n" "help.text" -msgid "Dates: All date objects are passed and returned as datetime.datetime native Python objects." -msgstr "日付: すべての日付オブジェクトは、Pythonネイティブのdatetime.datetimeオブジェクトとして渡され、返されます。" +msgid "A control is said required when the underlying data must not contain a null value." +msgstr "" -#. FcX93 -#: sf_intro.xhp +#. NbTpX +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id891623411367669\n" +"sf_formcontrol.xhp\n" +"par_id781598516764550\n" "help.text" -msgid "Arrays: One-dimensional arrays are passed and returned as tuples (which is an immutable object). Two-dimensional arrays are passed and returned as tuples of tuples." -msgstr "配列: 1次元配列はタプル(Immutableオブジェクト)として渡され、返されます。2次元配列は、タプルのタプルとして渡され、返されます。" +msgid "Yes" +msgstr "" -#. S6wwX -#: sf_intro.xhp +#. Rv448 +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id981623411507442\n" +"sf_formcontrol.xhp\n" +"par_id11159851676440\n" "help.text" -msgid "None: Python's None keyword is equivalent to Basic's Null, Empty or Nothing." -msgstr "None: PythonのNoneキーワードは、BasicのNullEmptyNothingと同じです。" +msgid "Gives access to the text being displayed by the control." +msgstr "" -#. 2G2uk -#: sf_intro.xhp +#. 7kxit +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id21623411611447\n" +"sf_formcontrol.xhp\n" +"par_id411598517275112\n" "help.text" -msgid "UNO objects: All UNO structures are exchanged between Basic and Python without any changes." -msgstr "UNOオブジェクト: すべてのUNO構造体は、BasicとPythonの間で変更なく交換されます。" +msgid "No" +msgstr "" -#. WFDrN -#: sf_intro.xhp +#. MNqBi +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id651623412069496\n" +"sf_formcontrol.xhp\n" +"par_id171598539985022\n" "help.text" -msgid "Debugging: Whenever an error occurs in Python scripts that use ScriptForge, the error message provided by the Python execution stack displays the line of code that triggered the error. In Basic error messages do not display this information." -msgstr "デバッグ: ScriptForgeを使用したPythonスクリプトでエラーが発生した場合、Python実行スタックからのエラーメッセージは、エラーの原因となったコードの行を表示します。Basicのエラーメッセージでは、このメッセージは表示されません。" +msgid "All (except HiddenControl)" +msgstr "" -#. 9zGtM -#: sf_intro.xhp +#. VXR9Y +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id31623411828158\n" +"sf_formcontrol.xhp\n" +"par_id651598517275384\n" "help.text" -msgid "Visit %PRODUCTNAME Python Scripts Help for more information on Python scripting using %PRODUCTNAME." -msgstr "%PRODUCTNAMEで利用するPythonスクリプトの詳細については、 %PRODUCTNAME Pythonスクリプトヘルプをご覧ください。" +msgid "Specifies the text that appears as a tooltip when you hover the mouse pointer over the control." +msgstr "" -#. CZiTF -#: sf_intro.xhp +#. Awzep +#: sf_formcontrol.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id391623411150080\n" +"sf_formcontrol.xhp\n" +"par_id821598517418463\n" +"help.text" +msgid "No" +msgstr "" + +#. 6S5EL +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id141598517418822\n" +"help.text" +msgid "Specifies if the checkbox control may appear dimmed (grayed) or not." +msgstr "" + +#. mCQFz +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id701598517671373\n" +"help.text" +msgid "No" +msgstr "" + +#. vD3X4 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id1001598540024225\n" +"help.text" +msgid "This property depends on the current control type. Refer to The Value property for more information." +msgstr "" + +#. ybVim +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id661598517730941\n" +"help.text" +msgid "No" +msgstr "" + +#. G52FE +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id761598540042290\n" +"help.text" +msgid "All (except HiddenControl)" +msgstr "" + +#. 5juZG +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id881598517730836\n" +"help.text" +msgid "Specifies if the control is hidden or visible." +msgstr "" + +#. FAYCA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id451598177924437\n" +"help.text" +msgid "Yes" +msgstr "" + +#. UZ7ug +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id94159817792441\n" +"help.text" +msgid "UNO
object" +msgstr "" + +#. 65CSA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id311598540066789\n" +"help.text" +msgid "All" +msgstr "" + +#. ceFhn +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id191598177924897\n" +"help.text" +msgid "The UNO object representing the control model. Refer to XControlModel and UnoControlModel in the API documentation for more information." +msgstr "" + +#. FzDR6 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id811598178083501\n" +"help.text" +msgid "Yes" +msgstr "" + +#. Bdvyd +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id981598178083938\n" +"help.text" +msgid "UNO
object" +msgstr "" + +#. DFQ5P +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id551598540079329\n" +"help.text" +msgid "All" +msgstr "" + +#. fPcGS +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id731598178083442\n" +"help.text" +msgid "The UNO object representing the control view. Refer to XControl and UnoControl in the API documentation for more information." +msgstr "" + +#. pqsod +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"hd_id81598540704978\n" +"help.text" +msgid "The Value property" +msgstr "" + +#. PbEBw +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id10159854325492\n" +"help.text" +msgid "Control type" +msgstr "" + +#. bsmCC +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id741598543254158\n" +"help.text" +msgid "Type" +msgstr "" + +#. MWgHB +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id961598543254444\n" +"help.text" +msgid "Description" +msgstr "" + +#. FLUGH +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id741598543254108\n" +"help.text" +msgid "Applicable to toggle buttons only." +msgstr "" + +#. jpLCR +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id741598543254376\n" +"help.text" +msgid "Boolean or Integer" +msgstr "" + +#. ErAZY +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id521598543254630\n" +"help.text" +msgid "0, False: not checked
1, True: checked
2: grayed out, don't know (applicable if TripleState is True)" +msgstr "" + +#. 3frrW +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id331598543254947\n" +"help.text" +msgid "The selected value, as a String. The ListIndex property is an alternate option to access the index of the selected value." +msgstr "" + +#. faEEm +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id5159854325443\n" +"help.text" +msgid "Numeric" +msgstr "" + +#. VyagB +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id971598543254757\n" +"help.text" +msgid "A file name formatted in accordance with the FileNaming property of the ScriptForge.FileSystem service" +msgstr "" + +#. CaGtr +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id221598543254760\n" +"help.text" +msgid "String or Numeric" +msgstr "" + +#. gtxJY +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id42159854325422\n" +"help.text" +msgid "String or array of strings" +msgstr "" + +#. kBH32 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id601598543254780\n" +"help.text" +msgid "The selected row(s) as a single string or an array of strings. Only a single value can be set. If the box is linked to a database, this property gets or sets the underlying data. Otherwise it gets or sets the data being displayed." +msgstr "" + +#. f7EZX +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id461598543254909\n" +"help.text" +msgid "Numeric" +msgstr "" + +#. DrhU9 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id851598543254624\n" +"help.text" +msgid "Each button has its own name. Multiple RadioButton controls are linked together when they share the same group name. If a RadioButton is set to True, the other related buttons are automatically set to False" +msgstr "" + +#. WEsqT +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id531598543254869\n" +"help.text" +msgid "Numeric" +msgstr "" + +#. LxeLY +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id21598543254994\n" +"help.text" +msgid "Must be within the predefined bounds" +msgstr "" + +#. mpoa7 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id951616947400919\n" +"help.text" +msgid "Numeric" +msgstr "" + +#. x6ZLt +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id48161694740085\n" +"help.text" +msgid "Must be within the predefined bounds" +msgstr "" + +#. UZLYC +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id441598543254738\n" +"help.text" +msgid "The text appearing in the field" +msgstr "" + +#. WBHoJ +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"hd_id421612628828054\n" +"help.text" +msgid "Event properties" +msgstr "" + +#. tqnsA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id41612629140856\n" +"help.text" +msgid "The properties below return or set URI strings that define the script triggered by the event." +msgstr "" + +#. 7Azyz +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id961612628879819\n" +"help.text" +msgid "Name" +msgstr "" + +#. N4btE +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id401612628879819\n" +"help.text" +msgid "ReadOnly" +msgstr "" + +#. RXoDM +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id281612628879819\n" +"help.text" +msgid "Description as labeled in the Basic IDE" +msgstr "" + +#. yhjPA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id91612707166532\n" +"help.text" +msgid "No" +msgstr "" + +#. HVTKN +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id291612707166258\n" +"help.text" +msgid "Execute action" +msgstr "" + +#. T5CTw +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id79161270716675\n" +"help.text" +msgid "No" +msgstr "" + +#. qs3LA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id831612707166731\n" +"help.text" +msgid "While adjusting" +msgstr "" + +#. vUbN6 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id301616948330694\n" +"help.text" +msgid "No" +msgstr "" + +#. PopWN +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id901616948330305\n" +"help.text" +msgid "Approve action" +msgstr "" + +#. PmE7k +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id821616948330888\n" +"help.text" +msgid "No" +msgstr "" + +#. rjQCJ +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id111616948330257\n" +"help.text" +msgid "Prior to reset" +msgstr "" + +#. octLi +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id271616948330553\n" +"help.text" +msgid "No" +msgstr "" + +#. D7yir +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id451616948330759\n" +"help.text" +msgid "Before updating" +msgstr "" + +#. YM7Nt +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id71616948330769\n" +"help.text" +msgid "No" +msgstr "" + +#. pHG54 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id211616948330895\n" +"help.text" +msgid "Changed" +msgstr "" + +#. UaRoN +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id121616948330654\n" +"help.text" +msgid "No" +msgstr "" + +#. tfW7M +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id2216169483303\n" +"help.text" +msgid "Error occurred" +msgstr "" + +#. vDFhJ +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id111612629836630\n" +"help.text" +msgid "No" +msgstr "" + +#. NN9FK +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id1001612629836902\n" +"help.text" +msgid "When receiving focus" +msgstr "" + +#. tLp7Y +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id291612629836294\n" +"help.text" +msgid "No" +msgstr "" + +#. DDcCF +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id62161262983683\n" +"help.text" +msgid "When losing focus" +msgstr "" + +#. EBVQM +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id51612707354544\n" +"help.text" +msgid "No" +msgstr "" + +#. PLPUr +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id211612707354899\n" +"help.text" +msgid "Item status changed" +msgstr "" + +#. zBci2 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id81612629836634\n" +"help.text" +msgid "No" +msgstr "" + +#. vPrAA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id881612629836744\n" +"help.text" +msgid "Key pressed" +msgstr "" + +#. 8cFqR +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id591612629836830\n" +"help.text" +msgid "No" +msgstr "" + +#. 6rrBt +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id161612629836775\n" +"help.text" +msgid "Key released" +msgstr "" + +#. 7Pzmy +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id891612629836630\n" +"help.text" +msgid "No" +msgstr "" + +#. 2pMWG +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id461612629836679\n" +"help.text" +msgid "Mouse moved while key presses" +msgstr "" + +#. SGYBr +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id131612629836291\n" +"help.text" +msgid "No" +msgstr "" + +#. AJGQd +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id151612629836151\n" +"help.text" +msgid "Mouse inside" +msgstr "" + +#. 6cFkB +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id211612629836725\n" +"help.text" +msgid "No" +msgstr "" + +#. tfmtf +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id361612629836624\n" +"help.text" +msgid "Mouse outside" +msgstr "" + +#. 6E7WA +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id311612629836481\n" +"help.text" +msgid "No" +msgstr "" + +#. CeNku +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id721612629836752\n" +"help.text" +msgid "Mouse moved" +msgstr "" + +#. iSxsS +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id981612629836116\n" +"help.text" +msgid "No" +msgstr "" + +#. 9yirD +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id381612629836635\n" +"help.text" +msgid "Mouse button pressed" +msgstr "" + +#. b6pFV +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id711612629836704\n" +"help.text" +msgid "No" +msgstr "" + +#. D5vXU +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id35161262983642\n" +"help.text" +msgid "Mouse button released" +msgstr "" + +#. 9Ui2H +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id31616948666215\n" +"help.text" +msgid "No" +msgstr "" + +#. mdLSp +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id951616948666674\n" +"help.text" +msgid "After resetting" +msgstr "" + +#. jb4at +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id811612707606330\n" +"help.text" +msgid "No" +msgstr "" + +#. m3Rb7 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id621612707606219\n" +"help.text" +msgid "Text modified" +msgstr "" + +#. bfgkG +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id41616948721642\n" +"help.text" +msgid "No" +msgstr "" + +#. imn6B +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id311616948721872\n" +"help.text" +msgid "After updating" +msgstr "" + +#. PuSPh +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id961618181634181\n" +"help.text" +msgid "To learn more about URI strings, refer to the Scripting Framework URI Specification." +msgstr "" + +#. RpNkd +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id891611613601554\n" +"help.text" +msgid "List of Methods in the FormControl Service" +msgstr "" + +#. CKZDf +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id161584541257982\n" +"help.text" +msgid "This method is applicable only to controls of the TableControl type. The returned value depends on the arguments provided." +msgstr "" + +#. DB3PG +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id701618777636827\n" +"help.text" +msgid "If the optional argument controlname is absent, then a zero-based Array containing the names of all controls is returned." +msgstr "" + +#. GgAeu +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id851618777715892\n" +"help.text" +msgid "On the other hand, if a controlname is provided, the method returns a FormControl class instance corresponding to the specified control." +msgstr "" + +#. eoLJG +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id1001584541257789\n" +"help.text" +msgid "controlname: A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array." +msgstr "" + +#. F4Sdy +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"bas_id471618778075117\n" +"help.text" +msgid "' Returns an Array with the names of all controls in \"myTableControl\"" +msgstr "" + +#. YoHSo +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id931618778110273\n" +"help.text" +msgid "' Returns a FormControl class instance corresponding to \"myCheckBox\"" +msgstr "" + +#. AGA7Z +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id391622559441530\n" +"help.text" +msgid "Using Python:" +msgstr "" + +#. CprjV +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id871583933076448\n" +"help.text" +msgid "Sets the focus on the control. Returns True if focusing was successful." +msgstr "" + +#. LuxFE +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id151598178880227\n" +"help.text" +msgid "This method is often called from a form or control event." +msgstr "" + +#. haAXC +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"hd_id141618777179310\n" +"help.text" +msgid "Additional examples" +msgstr "" + +#. JopFS +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id331618777195723\n" +"help.text" +msgid "Below are two examples that illustrate the use of the FormControl service." +msgstr "" + +#. 5iGmg +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id371618776324489\n" +"help.text" +msgid "The first example reads the current value in a ComboBox containing city names and writes it to a FixedTest control in a Form:" +msgstr "" + +#. 3eh6E +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"pyc_id991622562833004\n" +"help.text" +msgid "bas = CreateScriptService('ScriptForge.Basic') # Basic-like methods" +msgstr "" + +#. 8jneo +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"pyc_id781622561048794\n" +"help.text" +msgid "lbl_city.Caption = \"Selected city: \" + combo_city.Value" +msgstr "" + +#. kz9SK +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"par_id251618776614814\n" +"help.text" +msgid "The following code snippet can be used to process RadioButton controls that share the same group name. In this example, suppose there are three radio buttons with names optA, optB and optC and we wish to display the caption of the selected control." +msgstr "" + +#. hRhNC +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"bas_id251618776933304\n" +"help.text" +msgid "MsgBox \"Selected option: \" & optControl.Caption" +msgstr "" + +#. YnBgM +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"pyc_id991622562822004\n" +"help.text" +msgid "bas = CreateScriptService('ScriptForge.Basic') # Basic-like methods" +msgstr "" + +#. TNTT9 +#: sf_formcontrol.xhp +msgctxt "" +"sf_formcontrol.xhp\n" +"pyc_id441622562080419\n" +"help.text" +msgid "bas.MsgBox('Selected option: ' + control.Caption)" +msgstr "" + +#. evuZx +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"tit\n" +"help.text" +msgid "SFDocuments.FormDocument service" +msgstr "" + +#. Y2ddY +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"bm_id41582391760252\n" +"help.text" +msgid "FormDocument service" +msgstr "" + +#. AQWCM +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"bm_id781582391760253\n" +"help.text" +msgid "SFDocuments.FormDocument service" +msgstr "" + +#. hQ3hK +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id321692486382326\n" +"help.text" +msgid "The FormDocument service allows to access form documents stored in %PRODUCTNAME Base documents." +msgstr "" + +#. zQHTF +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id621692487292145\n" +"help.text" +msgid "In a Base document, existing form documents can be viewed by selecting View - Forms in the user interface. Each form document may be composed of one or more forms, including the main form and other sub-forms." +msgstr "" + +#. uNbgU +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id891692486448415\n" +"help.text" +msgid "This service inherits methods and properties from the Document service and is often used alongside the Base and Database services." +msgstr "" + +#. gGFFZ +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id241619032941497\n" +"help.text" +msgid "Refer to the Document service to learn more about methods and properties that can be used to manage %PRODUCTNAME documents." +msgstr "" + +#. 3jTab +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"hd_id581582885621841\n" +"help.text" +msgid "Service invocation" +msgstr "" + +#. KxGkv +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id141609955500101\n" +"help.text" +msgid "Before using the FormDocument service the ScriptForge library needs to be loaded or imported:" +msgstr "" + +#. 99UBC +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id991692486784449\n" +"help.text" +msgid "A FormDocument service instance can be created by calling the method OpenFormDocument that exists both in the Base and Database services." +msgstr "" + +#. txPPF +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id381692486890118\n" +"help.text" +msgid "The example below uses the UI service to open a Base document and then retrieve a form document. Note that in this example both the Base document and the form document will be opened and displayed on the screen." +msgstr "" + +#. ZRxCq +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id591692487747857\n" +"help.text" +msgid "The following example uses the Database service to open the form document. In this case, the Base file will not be opened and only the form document will be shown." +msgstr "" + +#. qkQZ7 +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id151692489140384\n" +"help.text" +msgid "Calling OpenFormDocument for a form document that is already open will activate the document window and bring it to focus." +msgstr "" + +#. vEFGV +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id871623102536956\n" +"help.text" +msgid "The examples above can be translated to Python as follows:" +msgstr "" + +#. wxdh6 +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id451619034669263\n" +"help.text" +msgid "List of Methods in the FormDocument Service" +msgstr "" + +#. jY8vp +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id801916099743199\n" +"help.text" +msgid "Closes the form document referred to by the FormDocument instance. Returns True if the form document was successfully closed." +msgstr "" + +#. wN7iT +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id481619036833610\n" +"help.text" +msgid "Returns either an array with the names of the main forms contained in the form document or a Form service instance referring to a specific form." +msgstr "" + +#. RuFja +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id311692532433990\n" +"help.text" +msgid "Call this method without arguments to obtain a zero-based string array with the names of all forms contained in the form document." +msgstr "" + +#. qg4FH +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id491692532525080\n" +"help.text" +msgid "Provide a form name or index as argument to obtain a Form service instance corresponding to the specified form." +msgstr "" + +#. GbkH9 +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id281692532725116\n" +"help.text" +msgid "A form document has at least one main form. More complex form documents may be composed of more than one form and sub-forms." +msgstr "" + +#. 23Cgd +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id211692538352686\n" +"help.text" +msgid "form: This argument can be either a string with the name of a form that exists in the form document or the zero-based index of the form that shall be returned. If this argument is not specific, then an array with the name of all available forms is returned." +msgstr "" + +#. wktWB +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id151692537703209\n" +"help.text" +msgid "The following example checks if the form document contains a form named \"MainForm\":" +msgstr "" + +#. nNdtW +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id661692537831637\n" +"help.text" +msgid "The example below retrieves the form named \"MainForm\" and moves it to the last record:" +msgstr "" + +#. Nw4c6 +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id921619036922844\n" +"help.text" +msgid "To learn more about form methods and properties, refer to the Form service help page." +msgstr "" + +#. 5SoGW +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id156589200121138\n" +"help.text" +msgid "This method sends the contents form document to the default printer or to the printer defined by the SetPrinter() method." +msgstr "" + +#. hQ6GC +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id981611169416934\n" +"help.text" +msgid "Returns True if the document was successfully sent to the printer." +msgstr "" + +#. 2qnYG +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id211635436910093\n" +"help.text" +msgid "pages: The pages to print as a string. This argument should be specified in the same manner as in the user interface (see File - Print dialog). Example: \"1-4;10;15-18\". The default value is an empty string \"\" which will cause all pages to be printed." +msgstr "" + +#. mxFXk +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id141635436912146\n" +"help.text" +msgid "copies: The number of copies to be printed (Default = 1)." +msgstr "" + +#. nr7DR +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id871692539875337\n" +"help.text" +msgid "printbackground: specifies whether the background image should be printed (Default = True)." +msgstr "" + +#. dDtPU +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id661692539947123\n" +"help.text" +msgid "printblankpages: specifies whether blank pages should be printed (Default = False)." +msgstr "" + +#. hJvtc +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id661692539947144\n" +"help.text" +msgid "printevenpages: specifies whether even pages should be printed (Default = True)." +msgstr "" + +#. 7tyim +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id661692539947875\n" +"help.text" +msgid "printoddpages: specifies whether odd pages should be printed (Default = True)." +msgstr "" + +#. BxCRK +#: sf_formdocument.xhp +msgctxt "" +"sf_formdocument.xhp\n" +"par_id661692539947323\n" +"help.text" +msgid "printimages: specifies whether images should be printed (Default = True)." +msgstr "" + +#. czP76 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"tit\n" +"help.text" +msgid "Creating Python Scripts with ScriptForge" +msgstr "ScriptForgeを利用したPythonスクリプトの作成" + +#. QFG5C +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id461623364876507\n" +"help.text" +msgid "Creating Python Scripts with ScriptForge" +msgstr "ScriptForgeを利用したPythonスクリプトの作成" + +#. 6JuA3 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id361623410405420\n" +"help.text" +msgid "Differences between Basic and Python" +msgstr "BasicとPythonの違い" + +#. GwT9x +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id41623410443946\n" +"help.text" +msgid "The ScriptForge library is available both for Basic and Python. Most services, methods and properties work identically in both programming languages. However, due to differences in how each language works, ScriptForge users must be aware of some characteristics of the library when using Python:" +msgstr "ScriptForgeライブラリは、BasicとPython両方に対応しており、ほとんどのサービス、メソッド、プロパティは、どちらのプラグラミング言語でも同じように動作します。ですが、言語により動作が異なるのでPythonからScriptForgeを使う場合、ライブラリの特性に注意する必要があります。" + +#. HsKzK +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id551623410718241\n" +"help.text" +msgid "Methods and Property names: In Python, all methods and properties can be used in lowercased, ProperCased or camelCased formats." +msgstr "メソッドとプロパティ名: Pythonでは、すべてのメソッドとプロパティの名前に小文字のみ、先頭の文字を大文字、キャメルケースの形式が使えます。" + +#. Rg29x +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id741623411104297\n" +"help.text" +msgid "Arguments: All keyword arguments passed on to methods are lowercased." +msgstr "引数: メソッドに渡されるすべてのキーワード引数は小文字です。" + +#. C6VCu +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id441623411216354\n" +"help.text" +msgid "Dates: All date objects are passed and returned as datetime.datetime native Python objects." +msgstr "日付: すべての日付オブジェクトは、Pythonネイティブのdatetime.datetimeオブジェクトとして渡され、返されます。" + +#. FcX93 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id891623411367669\n" +"help.text" +msgid "Arrays: One-dimensional arrays are passed and returned as tuples (which is an immutable object). Two-dimensional arrays are passed and returned as tuples of tuples." +msgstr "配列: 1次元配列はタプル(Immutableオブジェクト)として渡され、返されます。2次元配列は、タプルのタプルとして渡され、返されます。" + +#. S6wwX +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id981623411507442\n" +"help.text" +msgid "None: Python's None keyword is equivalent to Basic's Null, Empty or Nothing." +msgstr "None: PythonのNoneキーワードは、BasicのNullEmptyNothingと同じです。" + +#. 2G2uk +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id21623411611447\n" +"help.text" +msgid "UNO objects: All UNO structures are exchanged between Basic and Python without any changes." +msgstr "UNOオブジェクト: すべてのUNO構造体は、BasicとPythonの間で変更なく交換されます。" + +#. WFDrN +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id651623412069496\n" +"help.text" +msgid "Debugging: Whenever an error occurs in Python scripts that use ScriptForge, the error message provided by the Python execution stack displays the line of code that triggered the error. In Basic error messages do not display this information." +msgstr "デバッグ: ScriptForgeを使用したPythonスクリプトでエラーが発生した場合、Python実行スタックからのエラーメッセージは、エラーの原因となったコードの行を表示します。Basicのエラーメッセージでは、このメッセージは表示されません。" + +#. 9zGtM +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id31623411828158\n" +"help.text" +msgid "Visit %PRODUCTNAME Python Scripts Help for more information on Python scripting using %PRODUCTNAME." +msgstr "%PRODUCTNAMEで利用するPythonスクリプトの詳細については、 %PRODUCTNAME Pythonスクリプトヘルプをご覧ください。" + +#. CZiTF +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id391623411150080\n" "help.text" msgid "Running Python scripts on %PRODUCTNAME" msgstr "%PRODUCTNAMEでPythonスクリプトを実行する" -#. 2j29F -#: sf_intro.xhp +#. 2j29F +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id411623364895100\n" +"help.text" +msgid "Depending on what you intend to achieve, you may choose one of the following approaches to running Python scripts in %PRODUCTNAME:" +msgstr "%PRODUCTNAMEでPythonスクリプトを実行するには、目的に応じて以下のどちらかの方法で実行します。" + +#. XHP4Z +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id681623365274024\n" +"help.text" +msgid "Run Scripts inside the current %PRODUCTNAME process: Python scripts are executed from within the %PRODUCTNAME process by using the Tools - Macros - Run Macro menu or the APSO extension to call user scripts stored in the Python scripts folder. You can also use the APSO Python shell to interactively run Python scripts." +msgstr "現在の%PRODUCTNAMEプロセス内で実行する: LibreOfficeプロセス内からPythonスクリプトを実行するには、メニューの[ツール] - [マクロ] - [マクロの実行]を選ぶか、拡張機能APSOからPythonスクリプトフォルダにあるユーザースクリプトを呼び出して実行します。また、APSOのPythonシェルを使ってインタラクティブにPythonスクリプトを実行できます。" + +#. pnXQT +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id761623365278133\n" +"help.text" +msgid "Run Scripts separately from the %PRODUCTNAME process: Python scripts are executed from an external process that connects to an ongoing %PRODUCTNAME process using a socket." +msgstr "%PRODUCTNAMEプロセスとは別にスクリプトを実行する: Pythonスクリプトをソケットを使って実行中の%PRODUCTNAMEプロセスに接続して外部プロセスとして実行します。" + +#. DzGf6 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id631623365667011\n" +"help.text" +msgid "If you plan to run scripts from inside the %PRODUCTNAME process, it is recommended to install the APSO (Alternative Script Organizer for Python) extension. However, to develop Python scripts from outside %PRODUCTNAME, you can choose your preferred Python IDE." +msgstr "%PRODUCTNAMEプロセス内でスクリプトを実行する場合は、APSO(Alternative Script Organizer for Python)拡張機能のインストールをお勧めします。APSOを使ったPythonスクリプトの開発は、%PRODUCTNAMEの外部から好みのPython IDEを使い、開発します。" + +#. R4Rfk +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id431623365836802\n" +"help.text" +msgid "Running Scripts from inside the %PRODUCTNAME process" +msgstr "%PRODUCTNAMEプロセス内でスクリプトを実行する" + +#. UFGaA +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id111623365861568\n" +"help.text" +msgid "Using the APSO extension" +msgstr "APSO拡張機能を使う" + +#. GAQwg +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id681623365892513\n" +"help.text" +msgid "The easiest way to get started with Python scripting in %PRODUCTNAME is by installing the APSO extension. After installing it, open any %PRODUCTNAME component and go to Tools - Macros - Organize Python Scripts." +msgstr "" + +#. iXiDt +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id111623366334727\n" +"help.text" +msgid "In APSO's main window go to Menu - Python Shell." +msgstr "" + +#. JBFa3 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id931623366329927\n" +"help.text" +msgid "Alternatively you can open APSO using the default shortcut Alt + Shift + F11." +msgstr "" + +#. TKAXE +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id661623366478092\n" +"help.text" +msgid "Now you can start typing Python commands and the shell will print the corresponding output after each line of code is executed." +msgstr "" + +#. zGCxS +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id581623366559478\n" +"help.text" +msgid "To start using the ScriptForge library, you need to import the CreateScriptService method, with which you will be able to access the services provided by the library. The example below uses the Basic service to display a message box." +msgstr "" + +#. F7c8N +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id701623366829587\n" +"help.text" +msgid "To run the example above, enter each line in the Python shell, one by one, pressing the Enter key after you type each line of code." +msgstr "" + +#. 4PS26 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id471623366906045\n" +"help.text" +msgid "Now you can start executing Python commands using any of the ScriptForge services. For example, the code snippet below uses the UI service to create a blank Writer document." +msgstr "" + +#. N5A9E +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id961623367376768\n" +"help.text" +msgid "Creating Python script files" +msgstr "" + +#. xqmvY +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id821623367433650\n" +"help.text" +msgid "You can create your own Python files and edit them with your preferred text editor. Later you can call them from within any %PRODUCTNAME component." +msgstr "" + +#. AkXUk +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id51623367560321\n" +"help.text" +msgid "The first step is to locate where your user scripts are stored. For that, refer to Python Scripts Organization and Location help page." +msgstr "" + +#. NdM4Y +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id821623367773032\n" +"help.text" +msgid "Now you can create a text file inside your Python user scripts folder, for instance sf_test.py, and start typing your scripts." +msgstr "" + +#. rFyBp +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id271623367917630\n" +"help.text" +msgid "Next is a simple example that gets the numeric value from a Calc cell and increments it by 1. Simply type the following code into the sf_test.py file." +msgstr "" + +#. EQxF2 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id171623368511426\n" +"help.text" +msgid "This example creates the increment_cell function. Note that g_exportedScripts is a tuple that tells which functions will be displayed in %PRODUCTNAME as user scripts." +msgstr "" + +#. UUnv4 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id471623368615244\n" +"help.text" +msgid "To run this script from within a Calc document:" +msgstr "" + +#. FynYm +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id811623368677444\n" +"help.text" +msgid "Create or open a Calc file." +msgstr "" + +#. qdWEL +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id281623368679141\n" +"help.text" +msgid "Enter some numeric value into cell \"A1\" in the current sheet." +msgstr "" + +#. bFQSh +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id111623368679893\n" +"help.text" +msgid "Go to Tools - Macros - Run Macros ." +msgstr "" + +#. HkBwz +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id421623368680565\n" +"help.text" +msgid "Choose My Macros - sf_test in the library selector. Then choose the increment_cell function under the Macro Name list." +msgstr "" + +#. FPZD6 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id131623368875763\n" +"help.text" +msgid "Click Run. Note that the value in cell \"A1\" was incremented by 1." +msgstr "" + +#. 9FozC +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id781623368934689\n" +"help.text" +msgid "You can also use APSO to run Python scripts in a similar manner:" +msgstr "" + +#. Lyyxc +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id501623369002537\n" +"help.text" +msgid "First open APSO by going to Tools - Macros - Organize Python Scripts." +msgstr "" + +#. ayPs5 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id521623369004825\n" +"help.text" +msgid "In the macro list, navigate to My Macros - sf_test - increment_cell." +msgstr "" + +#. WaGHv +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id101623369005929\n" +"help.text" +msgid "Click Execute." +msgstr "" + +#. ujB4e +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id531623369208159\n" +"help.text" +msgid "Running Scripts separately from the %PRODUCTNAME process" +msgstr "" + +#. 9yG9z +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id261623370168228\n" +"help.text" +msgid "Determining the Installation Path" +msgstr "" + +#. 2ijCM +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id261623369722023\n" +"help.text" +msgid "The first step to run scripts from a separate process is to find the folder where %PRODUCTNAME is installed. There are several ways to do that, but ScriptForge provides a quick way to identify your installation path. For that, open APSO's Python shell and type:" +msgstr "" + +#. UEwkB +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id81623370150730\n" +"help.text" +msgid "The output from the code above is the base directory where %PRODUCTNAME is installed. Now you need to add the \"program\" subfolder to the resulting path. This is the base folder from which you will run Python scripts from a separate process." +msgstr "" + +#. EvDcx +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id451623370201479\n" +"help.text" +msgid "For example, suppose you get /usr/lib/libreoffice/ as the result from running the Python code above. Then you need to consider /usr/lib/libreoffice/program as the path to run your Python scripts." +msgstr "" + +#. 6EYGe +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id231623370501084\n" +"help.text" +msgid "Start %PRODUCTNAME with socket settings" +msgstr "" + +#. F94mp +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id721623369245475\n" +"help.text" +msgid "To run Python scripts from a separate process, you need to start %PRODUCTNAME with a few additional options that specify the hostname and port through which the external process will communicate with the %PRODUCTNAME component process." +msgstr "" + +#. mfbEM +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id221623369584132\n" +"help.text" +msgid "Open the your operating system's command prompt, navigate to the program folder of your %PRODUCTNAME installation directory and type:" +msgstr "" + +#. 6hDm4 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id981623370706743\n" +"help.text" +msgid "The command above will start %PRODUCTNAME with a communication channel open so that other processes can exchange messages with it." +msgstr "" + +#. SB5LE +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id621623370871360\n" +"help.text" +msgid "Note that the previous example opens %PRODUCTNAME start center. If you want to open a specific component, for instance Writer, you can add the --writer flag to the command, as follows." +msgstr "" + +#. cVRuV +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id431623373618951\n" +"help.text" +msgid "Take note of the host and port parameters, which in this example are localhost and 2021, respectively." +msgstr "" + +#. Z7z5C +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id861623370468356\n" +"help.text" +msgid "Running an External Python Shell" +msgstr "" + +#. NuNqn +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id621623371253647\n" +"help.text" +msgid "Start the Python shell from within the program folder inside your %PRODUCTNAME installation path. Follow the steps above to learn how to find your installation path." +msgstr "" + +#. 69F7S +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id11623373098602\n" +"help.text" +msgid "On Linux / Mac OS:" +msgstr "" + +#. PFWiq +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id311623373151552\n" +"help.text" +msgid "On Windows:" +msgstr "" + +#. HGBuK +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id791623373520018\n" +"help.text" +msgid "This will open the Python shell and now you can start typing commands that will be executed by %PRODUCTNAME. But first you need to set up the socket connection." +msgstr "" + +#. NGS3a +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id761689720152565\n" +"help.text" +msgid "Read the section Setting PYTHONPATH below in case of errors importing scriptforge.py or uno.py." +msgstr "" + +#. s54tE +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id351623373686414\n" +"help.text" +msgid "The second line of code above defines the host and port settings so that the Python shell can communicate with an ongoing %PRODUCTNAME process opened with the same socket settings." +msgstr "" + +#. RiXDx +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id721623373769471\n" +"help.text" +msgid "Now you can run other Python commands and they will be able to communicate with the %PRODUCTNAME process. For example:" +msgstr "" + +#. oiPx9 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"bm_id631689720744160\n" +"help.text" +msgid "Python interpreter;PYTHONPATH" +msgstr "" + +#. FPh6P +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"hd_id341689720315095\n" +"help.text" +msgid "Setting PYTHONPATH" +msgstr "" + +#. XCiS5 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id811689720328559\n" +"help.text" +msgid "Depending on your operating system's configuration you will need to set the environment variable PYTHONPATH in order to import the scriptforge.py library, which in turn requires importing the uno.py library." +msgstr "" + +#. AtNfv +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id781689720489355\n" +"help.text" +msgid "Use your operating system's file search tool to determine the directory where both these files are located." +msgstr "" + +#. uLiYM +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id431689720583565\n" +"help.text" +msgid "For instance, on a default Ubuntu installation both files may be located at:" +msgstr "" + +#. nxQGQ +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id791689720632086\n" +"help.text" +msgid "scriptforge.py: Located in /usr/lib/libreoffice/program" +msgstr "" + +#. Dzfaq +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id881689720632438\n" +"help.text" +msgid "uno.py: Located in /usr/lib/python3/dist-packages" +msgstr "" + +#. 2vEpX +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id701689720782180\n" +"help.text" +msgid "In this case, set the environment variable PYTHONPATH as follows before starting the Python interpreter:" +msgstr "" + +#. 9BRx3 +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id601689720825610\n" +"help.text" +msgid "export PYTHONPATH=/usr/lib/libreoffice/program:/usr/lib/python3/dist-packages" +msgstr "" + +#. UDLem +#: sf_intro.xhp +msgctxt "" +"sf_intro.xhp\n" +"par_id971689720909044\n" +"help.text" +msgid "The location of these files will be different for each operating system and %PRODUCTNAME installation method." +msgstr "" + +#. VCRTD +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"tit\n" +"help.text" +msgid "ScriptForge.L10N service" +msgstr "" + +#. 5kFM4 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"hd_id521585843652750\n" +"help.text" +msgid "ScriptForge.L10N service" +msgstr "" + +#. FRAiJ +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id411585843652556\n" +"help.text" +msgid "This service provides a number of methods related to the translation of strings with minimal impact on the program's source code. The methods provided by the L10N service can be used mainly to:" +msgstr "" + +#. gw2rW +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id601614351922212\n" +"help.text" +msgid "Create POT files that can be used as templates for translation of all strings in the program." +msgstr "" + +#. sbVQL +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id131614352196513\n" +"help.text" +msgid "Get translated strings at runtime for the language defined in the Locale property." +msgstr "" + +#. kCrgU +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id971614966420419\n" +"help.text" +msgid "The acronym L10N stands for Localization and refers to a set of procedures for translating software to a specific country or region." +msgstr "" + +#. supr5 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id291585843652438\n" +"help.text" +msgid "PO files have long been promoted in the free software community as a means to providing multilingual user interfaces. This is accomplished through the use of human-readable text files with a well defined structure that specifies, for any given language, the source language string and the localized string." +msgstr "" + +#. j6xsd +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id181585843652814\n" +"help.text" +msgid "The main advantage of the PO format is dissociation of the programmer and the translator. PO files are independent text files, so the programmer can send POT template files to translators, who will then translate their contents and return the translated PO files for each supported language." +msgstr "" + +#. vdQwG +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id811614352321187\n" +"help.text" +msgid "The L10N service is based on the GNU implementation of PO (portable object) files. To learn more about this file format, visit GNU gettext Utilities: PO Files." +msgstr "" + +#. DGiG9 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id91585843652832\n" +"help.text" +msgid "This service implements the methods listed below:" +msgstr "" + +#. fBXDW +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id1158584365237\n" +"help.text" +msgid "AddText: Used by the programmer to build a set of strings that will be translated later." +msgstr "" + +#. BtuQ3 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id81637866601151\n" +"help.text" +msgid "AddTextsFromDialog: Extracts all strings from a Dialog service instance." +msgstr "" + +#. cm7fq +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id681585843652331\n" +"help.text" +msgid "ExportToPOTFile: Exports the strings added by the AddText method to a POT file." +msgstr "" + +#. Z7dU5 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id531585843652697\n" +"help.text" +msgid "GetText: Gets the translated strings at runtime." +msgstr "" + +#. D4Fyf +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id361614361362393\n" +"help.text" +msgid "Note that the first two methods are used to build a set of translatable strings and export them to a POT file. However, it is not mandatory to create POT files using these methods. Since they are text files, the programmer could have created them using any text editor." +msgstr "" + +#. Rn7FL +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"hd_id351585843652312\n" +"help.text" +msgid "Service invocation" +msgstr "" + +#. 2WXAQ +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id141609955500101\n" +"help.text" +msgid "Before using the L10N service the ScriptForge library needs to be loaded or imported:" +msgstr "" + +#. 9xE8t +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id421614353247163\n" +"help.text" +msgid "There are several ways to invoke the L10N service using up to five optional arguments that specify the folder where PO files are stored, the locale and encoding to be used, as well as a fallback PO file and its encoding." +msgstr "" + +#. cCwBS +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id331585843652877\n" +"help.text" +msgid "foldername: The folder containing the PO files. It must be expressed in the FileSystem.FileNaming notation." +msgstr "" + +#. oQD4m +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id581585843652789\n" +"help.text" +msgid "locale: A string in the form \"la-CO\" (language-COUNTRY) or in the form \"la\" (language) only." +msgstr "" + +#. gswGR +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id591646219881864\n" +"help.text" +msgid "encoding: The character set to be used. The default encoding is \"UTF-8\"." +msgstr "" + +#. CXd3e +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id281646219882464\n" +"help.text" +msgid "locale2: A string specifying the fallback locale to be used in case the PO file corresponding to the locale defined the locale parameter does not exist. This parameter is expressed in the form \"la-CO\" (language-COUNTRY) or \"la\" (language) only." +msgstr "" + +#. TaFFX +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id881646219882951\n" +"help.text" +msgid "encoding2: The character set of the fallback PO file corresponding to the locale2 argument. The default encoding is \"UTF-8\"." +msgstr "" + +#. 6cmQr +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id141613001281573\n" +"help.text" +msgid "To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets." +msgstr "" + +#. 3ApdD +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id891614358528334\n" +"help.text" +msgid "The following example instantiates the L10N service without any optional arguments. This will only enable the AddText and ExportToPOTFile methods, which is useful for creating POT files." +msgstr "" + +#. FaDSa +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id611614358672609\n" +"help.text" +msgid "The example below specifies the folder containing the PO files. Because the locale is not defined, the service instance will use the locale defined for the %PRODUCTNAME user interface, which is the same locale defined in the OfficeLocale property of the Platform service." +msgstr "" + +#. FewYJ +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id391625855630975\n" +"help.text" +msgid "The example above will result in an runtime error if the PO file corresponding to the OfficeLocale locale does not exist in the specified folder." +msgstr "" + +#. gSzLN +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id321614358809763\n" +"help.text" +msgid "In the example below, the locale is explicitly defined to be Belgian French (\"fr-BE\"), hence the service will load the file \"fr-BE.po\" from the folder \"C:\\myPOFiles\". If the file does not exist, an error will occur." +msgstr "" + +#. WpYLF +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id271646220649616\n" +"help.text" +msgid "To avoid errors, it is possible to specify a preferred and a fallback locale and encoding. The following example will first try to load the file \"fr-BE.po\" from the specified folder and if it does not exist, the file \"en-US.po\" will be loaded." +msgstr "" + +#. UGFWB +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id411585843652496\n" +"help.text" +msgid "PO files must be named in the form \"la-CO.po\" or \"la.po\", where \"la\" refers to the language and \"CO\" is the country. Some examples are: \"en-US.po\", \"fr-BE.po\" or \"fr.po\"." +msgstr "" + +#. zQhHX +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id171585843652545\n" +"help.text" +msgid "It is recommended to free resources after use:" +msgstr "" + +#. CmhnJ +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id281625854773330\n" +"help.text" +msgid "The examples above can be translated to Python as follows:" +msgstr "" + +#. Z5Pb3 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id301614358956087\n" +"help.text" +msgid "Several instances of the L10N service may coexist. However, each instance must use a separate directory for its PO files." +msgstr "" + +#. 6mcLb +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id411623364895100\n" +"sf_l10n.xhp\n" +"hd_id561585843652465\n" "help.text" -msgid "Depending on what you intend to achieve, you may choose one of the following approaches to running Python scripts in %PRODUCTNAME:" -msgstr "%PRODUCTNAMEでPythonスクリプトを実行するには、目的に応じて以下のどちらかの方法で実行します。" +msgid "Properties" +msgstr "" -#. XHP4Z -#: sf_intro.xhp +#. mJaFd +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id681623365274024\n" +"sf_l10n.xhp\n" +"par_id181585843652958\n" "help.text" -msgid "Run Scripts inside the current %PRODUCTNAME process: Python scripts are executed from within the %PRODUCTNAME process by using the Tools - Macros - Run Macro menu or the APSO extension to call user scripts stored in the Python scripts folder. You can also use the APSO Python shell to interactively run Python scripts." -msgstr "現在の%PRODUCTNAMEプロセス内で実行する: LibreOfficeプロセス内からPythonスクリプトを実行するには、メニューの[ツール] - [マクロ] - [マクロの実行]を選ぶか、拡張機能APSOからPythonスクリプトフォルダにあるユーザースクリプトを呼び出して実行します。また、APSOのPythonシェルを使ってインタラクティブにPythonスクリプトを実行できます。" +msgid "Name" +msgstr "" -#. pnXQT -#: sf_intro.xhp +#. FFbDK +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id761623365278133\n" +"sf_l10n.xhp\n" +"par_id741585843652162\n" "help.text" -msgid "Run Scripts separately from the %PRODUCTNAME process: Python scripts are executed from an external process that connects to an ongoing %PRODUCTNAME process using a socket." -msgstr "%PRODUCTNAMEプロセスとは別にスクリプトを実行する: Pythonスクリプトをソケットを使って実行中の%PRODUCTNAMEプロセスに接続して外部プロセスとして実行します。" +msgid "Readonly" +msgstr "" -#. DzGf6 -#: sf_intro.xhp +#. X3tJK +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id631623365667011\n" +"sf_l10n.xhp\n" +"par_id291585843652823\n" "help.text" -msgid "If you plan to run scripts from inside the %PRODUCTNAME process, it is recommended to install the APSO (Alternative Script Organizer for Python) extension. However, to develop Python scripts from outside %PRODUCTNAME, you can choose your preferred Python IDE." -msgstr "%PRODUCTNAMEプロセス内でスクリプトを実行する場合は、APSO(Alternative Script Organizer for Python)拡張機能のインストールをお勧めします。APSOを使ったPythonスクリプトの開発は、%PRODUCTNAMEの外部から好みのPython IDEを使い、開発します。" +msgid "Type" +msgstr "" -#. R4Rfk -#: sf_intro.xhp +#. 8ECBX +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id431623365836802\n" +"sf_l10n.xhp\n" +"par_id351585843652638\n" "help.text" -msgid "Running Scripts from inside the %PRODUCTNAME process" -msgstr "%PRODUCTNAMEプロセス内でスクリプトを実行する" +msgid "Description" +msgstr "" -#. UFGaA -#: sf_intro.xhp +#. j3wEj +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id111623365861568\n" +"sf_l10n.xhp\n" +"par_id451585843652928\n" "help.text" -msgid "Using the APSO extension" -msgstr "APSO拡張機能を使う" +msgid "Yes" +msgstr "" -#. GAQwg -#: sf_intro.xhp +#. EMof8 +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id681623365892513\n" +"sf_l10n.xhp\n" +"par_id751585843652642\n" "help.text" -msgid "The easiest way to get started with Python scripting in %PRODUCTNAME is by installing the APSO extension. After installing it, open any %PRODUCTNAME component and go to Tools - Macros - Organize Python Scripts." +msgid "The folder containing the PO files (see the FileSystem.FileNaming property to learn about the notation used)." msgstr "" -#. iXiDt -#: sf_intro.xhp +#. Zsp7p +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id111623366334727\n" +"sf_l10n.xhp\n" +"par_id96158584365279\n" "help.text" -msgid "In APSO's main window go to Menu - Python Shell." +msgid "Yes" msgstr "" -#. JBFa3 -#: sf_intro.xhp +#. vdfiw +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id931623366329927\n" +"sf_l10n.xhp\n" +"par_id331585843652912\n" "help.text" -msgid "Alternatively you can open APSO using the default shortcut Alt + Shift + F11." +msgid "A zero-based array listing all the base names (without the \".po\" extension) of the PO-files found in the specified Folder." msgstr "" -#. TKAXE -#: sf_intro.xhp +#. NWxhu +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id661623366478092\n" +"sf_l10n.xhp\n" +"par_id961585843652589\n" "help.text" -msgid "Now you can start typing Python commands and the shell will print the corresponding output after each line of code is executed." +msgid "Yes" msgstr "" -#. zGCxS -#: sf_intro.xhp +#. LSNA3 +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id581623366559478\n" +"sf_l10n.xhp\n" +"par_id561585843652947\n" "help.text" -msgid "To start using the ScriptForge library, you need to import the CreateScriptService method, with which you will be able to access the services provided by the library. The example below uses the Basic service to display a message box." +msgid "The currently active language-COUNTRY combination. This property will be initially empty if the service was instantiated without any of the optional arguments." msgstr "" -#. F7c8N -#: sf_intro.xhp +#. 5cs7h +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id701623366829587\n" +"sf_l10n.xhp\n" +"par_id231614360519973\n" "help.text" -msgid "To run the example above, enter each line in the Python shell, one by one, pressing the Enter key after you type each line of code." +msgid "List of Methods in the L10N Service" msgstr "" -#. 4PS26 -#: sf_intro.xhp +#. Q24j9 +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id471623366906045\n" +"sf_l10n.xhp\n" +"par_id1001585843652271\n" +"help.text" +msgid "Adds a new entry in the list of localizable strings. It must not exist yet." +msgstr "" + +#. 5Fs5v +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id641625855725050\n" +"help.text" +msgid "The method returns True if successful." +msgstr "" + +#. gyUYQ +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id391585843652753\n" +"help.text" +msgid "context: The key to retrieve the translated string with the GetText method. This parameter has a default value of \"\"." +msgstr "" + +#. YVUWx +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id581585844419114\n" +"help.text" +msgid "msgid: The untranslated string, which is the text appearing in the program code. It must not be empty. The msgid becomes the key to retrieve the translated string via GetText method when context is empty." +msgstr "" + +#. 7FDE9 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id311614361926844\n" +"help.text" +msgid "The msgid string may contain any number of placeholders (%1 %2 %3 ...) for dynamically modifying the string at runtime." +msgstr "" + +#. ioGmP +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id541585844475331\n" +"help.text" +msgid "comment: Optional comment to be added alongside the string to help translators." +msgstr "" + +#. TAyPG +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id461614364298440\n" +"help.text" +msgid "The example below creates a set of strings in English:" +msgstr "" + +#. rWt7U +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id1001585843659821\n" +"help.text" +msgid "Automatically extracts strings from a dialog and adds them to the list of localizable text strings. The following strings are extracted:" +msgstr "" + +#. bS7ZL +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id621637863440015\n" +"help.text" +msgid "The title of the dialog." +msgstr "" + +#. EBFAC +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id61637863440399\n" +"help.text" +msgid "The caption of the following control types: Button, CheckBox, FixedLine, FixedText, GroupBox and RadioButton." +msgstr "" + +#. uCL85 +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id251637863440626\n" +"help.text" +msgid "Static strings in ListBoxes and ComboBoxes." +msgstr "" + +#. HWkAU +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id811637863596791\n" +"help.text" +msgid "The tooltip or help text displayed when the mouse hovers over the control." +msgstr "" + +#. gKbEN +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id641625855723650\n" +"help.text" +msgid "The method returns True if successful." +msgstr "" + +#. Kcowa +#: sf_l10n.xhp +msgctxt "" +"sf_l10n.xhp\n" +"par_id731637863894577\n" "help.text" -msgid "Now you can start executing Python commands using any of the ScriptForge services. For example, the code snippet below uses the UI service to create a blank Writer document." +msgid "The dialog from which strings will be extracted must not be open when the method is called." msgstr "" -#. N5A9E -#: sf_intro.xhp +#. Aj4gB +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id961623367376768\n" +"sf_l10n.xhp\n" +"par_id911637864050221\n" "help.text" -msgid "Creating Python script files" +msgid "When a L10N service instance is created from an existing PO file, use the GetTextsFromL10N method from the Dialog service to automatically load all translated strings into the dialog." msgstr "" -#. xqmvY -#: sf_intro.xhp +#. ejhbN +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id821623367433650\n" +"sf_l10n.xhp\n" +"par_id391585843652113\n" "help.text" -msgid "You can create your own Python files and edit them with your preferred text editor. Later you can call them from within any %PRODUCTNAME component." +msgid "dialog: a Dialog service instance corresponding to the dialog from which strings will be extracted." msgstr "" -#. AkXUk -#: sf_intro.xhp +#. QzWzG +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id51623367560321\n" +"sf_l10n.xhp\n" +"par_id461614364298983\n" "help.text" -msgid "The first step is to locate where your user scripts are stored. For that, refer to Python Scripts Organization and Location help page." +msgid "The following example extracts all strings from the dialog \"MyDialog\" stored in the \"Standard\" library and exports them to a POT file:" msgstr "" -#. NdM4Y -#: sf_intro.xhp +#. DqFBf +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id821623367773032\n" +"sf_l10n.xhp\n" +"par_id281586102707242\n" "help.text" -msgid "Now you can create a text file inside your Python user scripts folder, for instance sf_test.py, and start typing your scripts." +msgid "Exports a set of untranslated strings as a POT file." msgstr "" -#. rFyBp -#: sf_intro.xhp +#. NABBq +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id271623367917630\n" +"sf_l10n.xhp\n" +"par_id711586102939257\n" "help.text" -msgid "Next is a simple example that gets the numeric value from a Calc cell and increments it by 1. Simply type the following code into the sf_test.py file." +msgid "To build a set of strings you can use either a succession of AddText method calls, or by a successful invocation of the L10N service with the foldername argument present. It is also possible to use a combination of both techniques." msgstr "" -#. EQxF2 -#: sf_intro.xhp +#. Pb4VF +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id171623368511426\n" +"sf_l10n.xhp\n" +"par_id641625855725141\n" "help.text" -msgid "This example creates the increment_cell function. Note that g_exportedScripts is a tuple that tells which functions will be displayed in %PRODUCTNAME as user scripts." +msgid "The method returns True if successful." msgstr "" -#. UUnv4 -#: sf_intro.xhp +#. 9ewFc +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id471623368615244\n" +"sf_l10n.xhp\n" +"par_id31586102707537\n" "help.text" -msgid "To run this script from within a Calc document:" +msgid "filename: The full output file name in FileSystem.FileNaming notation." msgstr "" -#. FynYm -#: sf_intro.xhp +#. jQV77 +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id811623368677444\n" +"sf_l10n.xhp\n" +"par_id851586102707579\n" "help.text" -msgid "Create or open a Calc file." +msgid "header: Comments that will be added on top of the generated POT file." msgstr "" -#. qdWEL -#: sf_intro.xhp +#. YhYbQ +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id281623368679141\n" +"sf_l10n.xhp\n" +"par_id111614364686973\n" "help.text" -msgid "Enter some numeric value into cell \"A1\" in the current sheet." +msgid "Do not include any leading \"#\" characters. If you want the header to be broken into multiple lines, insert escape sequences (\\n) where relevant. A standard header will be added alongside the text specified in the header argument." msgstr "" -#. bFQSh -#: sf_intro.xhp +#. E2Loj +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id111623368679893\n" +"sf_l10n.xhp\n" +"par_id5158610270728\n" "help.text" -msgid "Go to Tools - Macros - Run Macros ." +msgid "encoding: The character set to be used (Default = \"UTF-8\")." msgstr "" -#. HkBwz -#: sf_intro.xhp +#. uDu7z +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id421623368680565\n" +"sf_l10n.xhp\n" +"par_id581614364494235\n" "help.text" -msgid "Choose My Macros - sf_test in the library selector. Then choose the increment_cell function under the Macro Name list." +msgid "The generated file should successfully pass the msgfmt --check GNU command." msgstr "" -#. FPZD6 -#: sf_intro.xhp +#. 32fPj +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id131623368875763\n" +"sf_l10n.xhp\n" +"par_id891586165768715\n" "help.text" -msgid "Click Run. Note that the value in cell \"A1\" was incremented by 1." +msgid "Gets the translated string corresponding to the given msgid argument." msgstr "" -#. 9FozC -#: sf_intro.xhp +#. NzGZC +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id781623368934689\n" +"sf_l10n.xhp\n" +"par_id291614365296959\n" "help.text" -msgid "You can also use APSO to run Python scripts in a similar manner:" +msgid "A list of arguments may be specified to replace the placeholders (%1, %2, ...) in the string." msgstr "" -#. Lyyxc -#: sf_intro.xhp +#. 9DBFa +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id501623369002537\n" +"sf_l10n.xhp\n" +"par_id231586166181909\n" "help.text" -msgid "First open APSO by going to Tools - Macros - Organize Python Scripts." +msgid "If no translated string is found, the method returns the untranslated string after replacing the placeholders with the specified arguments." msgstr "" -#. ayPs5 -#: sf_intro.xhp +#. bAcmJ +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id521623369004825\n" +"sf_l10n.xhp\n" +"par_id871586352505927\n" "help.text" -msgid "In the macro list, navigate to My Macros - sf_test - increment_cell." +msgid "This method can be called either by the full name GetText or by the shortcut _ (a single underscore):" msgstr "" -#. WaGHv -#: sf_intro.xhp +#. mvB66 +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id101623369005929\n" +"sf_l10n.xhp\n" +"par_id421614967136502\n" "help.text" -msgid "Click Execute." +msgid "In the ScriptForge library, all methods starting with the \"_\" character are reserved for internal use only. However, the shortcut _ used for GetText is the only exception to this rule, hence it can be safely used in Basic and Python scripts." msgstr "" -#. ujB4e -#: sf_intro.xhp +#. 2ZVAQ +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id531623369208159\n" +"sf_l10n.xhp\n" +"par_id51586165768525\n" "help.text" -msgid "Running Scripts separately from the %PRODUCTNAME process" +msgid "msgid: The untranslated string, which is the text appearing in the program code. It must not be empty. It may contain any number of placeholders (%1 %2 %3 ...) that can be used to dynamically insert text at runtime." msgstr "" -#. 9yG9z -#: sf_intro.xhp +#. dALxK +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id261623370168228\n" +"sf_l10n.xhp\n" +"par_id11614365537450\n" "help.text" -msgid "Determining the Installation Path" +msgid "Besides using a single msgid string, this method also accepts the following formats:" msgstr "" -#. 2ijCM -#: sf_intro.xhp +#. Q7Bbm +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id261623369722023\n" +"sf_l10n.xhp\n" +"par_id961614365557277\n" "help.text" -msgid "The first step to run scripts from a separate process is to find the folder where %PRODUCTNAME is installed. There are several ways to do that, but ScriptForge provides a quick way to identify your installation path. For that, open APSO's Python shell and type:" +msgid "The context string with which the method will retrieve the msgid in the PO file, or;" msgstr "" -#. UEwkB -#: sf_intro.xhp +#. rTDrq +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id81623370150730\n" +"sf_l10n.xhp\n" +"par_id981614365589866\n" "help.text" -msgid "The output from the code above is the base directory where %PRODUCTNAME is installed. Now you need to add the \"program\" subfolder to the resulting path. This is the base folder from which you will run Python scripts from a separate process." +msgid "A combination context|msgid, instructing the method to retrieve the msgid using specified context value. The second part of the argument is used to improve code readability." msgstr "" -#. EvDcx -#: sf_intro.xhp +#. dW6RE +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id451623370201479\n" +"sf_l10n.xhp\n" +"par_id571586165768106\n" "help.text" -msgid "For example, suppose you get /usr/lib/libreoffice/ as the result from running the Python code above. Then you need to consider /usr/lib/libreoffice/program as the path to run your Python scripts." +msgid "args: Values to be inserted into the placeholders. Any variable type is allowed, however only strings, numbers and dates will be considered." msgstr "" -#. 6EYGe -#: sf_intro.xhp +#. cCZDK +#: sf_l10n.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id231623370501084\n" +"sf_l10n.xhp\n" +"par_id701614365961454\n" "help.text" -msgid "Start %PRODUCTNAME with socket settings" +msgid "Consider the following code is running on a %PRODUCTNAME installation with locale set to \"es-ES\". Additionally, there is a file \"es-ES.po\" inside the specified folder that translates the string passed to the GetText method:" msgstr "" -#. F94mp -#: sf_intro.xhp +#. yD78g +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id721623369245475\n" +"sf_menu.xhp\n" +"tit\n" "help.text" -msgid "To run Python scripts from a separate process, you need to start %PRODUCTNAME with a few additional options that specify the hostname and port through which the external process will communicate with the %PRODUCTNAME component process." +msgid "SFWidgets.Menu service" msgstr "" -#. mfbEM -#: sf_intro.xhp +#. mZUG7 +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id221623369584132\n" +"sf_menu.xhp\n" +"bm_id681600788076499\n" "help.text" -msgid "Open the your operating system's command prompt, navigate to the program folder of your %PRODUCTNAME installation directory and type:" +msgid "SFWidgets.Menu service" msgstr "" -#. 6hDm4 -#: sf_intro.xhp +#. FqGPg +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id981623370706743\n" +"sf_menu.xhp\n" +"par_id181600788076612\n" "help.text" -msgid "The command above will start %PRODUCTNAME with a communication channel open so that other processes can exchange messages with it." +msgid "The Menu service can be used to create and remove menus from the menubar of a %PRODUCTNAME document window. Each menu entry can be associated with a script or with a UNO command. This service provides the following capabilities:" msgstr "" -#. SB5LE -#: sf_intro.xhp +#. UYDdv +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id621623370871360\n" +"sf_menu.xhp\n" +"par_id301600788076785\n" "help.text" -msgid "Note that the previous example opens %PRODUCTNAME start center. If you want to open a specific component, for instance Writer, you can add the --writer flag to the command, as follows." +msgid "Creation of menus with custom entries, checkboxes, radio buttons and separators." msgstr "" -#. cVRuV -#: sf_intro.xhp +#. KB9XF +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id431623373618951\n" +"sf_menu.xhp\n" +"par_id1001600788076848\n" "help.text" -msgid "Take note of the host and port parameters, which in this example are localhost and 2021, respectively." +msgid "Decoration of menu items with icons and tooltips." msgstr "" -#. Z7z5C -#: sf_intro.xhp +#. JSwJW +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id861623370468356\n" +"sf_menu.xhp\n" +"par_id581643133675012\n" "help.text" -msgid "Running an External Python Shell" +msgid "Menus created with this service are available only for a specified document window. They are not saved into the document or as application settings. Closing and opening the document will restore the default menubar settings." msgstr "" -#. NuNqn -#: sf_intro.xhp +#. FEfWE +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id621623371253647\n" +"sf_menu.xhp\n" +"par_id291643224925643\n" "help.text" -msgid "Start the Python shell from within the program folder inside your %PRODUCTNAME installation path. Follow the steps above to learn how to find your installation path." +msgid "When OLE objects such as Math formulas or Calc charts are edited from within a document, %PRODUCTNAME reconfigures the menubar according to the object. When this happens, the menus created with the Menu service are removed and are not be restored after editing the OLE object." msgstr "" -#. 69F7S -#: sf_intro.xhp +#. GftK9 +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id11623373098602\n" +"sf_menu.xhp\n" +"hd_id281600788076359\n" "help.text" -msgid "On Linux / Mac OS:" +msgid "Service invocation" msgstr "" -#. PFWiq -#: sf_intro.xhp +#. o7QCg +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id311623373151552\n" +"sf_menu.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "On Windows:" +msgid "Before using the Menu service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. HGBuK -#: sf_intro.xhp +#. EYjA8 +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id791623373520018\n" +"sf_menu.xhp\n" +"par_id321614902851541\n" "help.text" -msgid "This will open the Python shell and now you can start typing commands that will be executed by %PRODUCTNAME. But first you need to set up the socket connection." +msgid "The Menu service is instantiated by calling the CreateMenu method from the Document service. The code snippet below creates a menu named My Menu in the current document window with two entries Item A and Item B." msgstr "" -#. NGS3a -#: sf_intro.xhp +#. pf7FV +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id761689720152565\n" +"sf_menu.xhp\n" +"bas_id261643134374056\n" "help.text" -msgid "Read the section Setting PYTHONPATH below in case of errors importing scriptforge.py or uno.py." +msgid "Set oMenu = oDoc.CreateMenu(\"My Menu\")" msgstr "" -#. s54tE -#: sf_intro.xhp +#. Hoh4Q +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id351623373686414\n" +"sf_menu.xhp\n" +"bas_id431643134582213\n" "help.text" -msgid "The second line of code above defines the host and port settings so that the Python shell can communicate with an ongoing %PRODUCTNAME process opened with the same socket settings." +msgid ".AddItem(\"Item A\", Command := \"About\")" msgstr "" -#. RiXDx -#: sf_intro.xhp +#. u52BY +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id721623373769471\n" +"sf_menu.xhp\n" +"bas_id571643134582396\n" "help.text" -msgid "Now you can run other Python commands and they will be able to communicate with the %PRODUCTNAME process. For example:" +msgid ".AddItem(\"Item B\", Script := \"vnd.sun.star.script:Standard.Module1.ItemB_Listener?language=Basic&location=application\")" msgstr "" -#. oiPx9 -#: sf_intro.xhp +#. nd5od +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"bm_id631689720744160\n" +"sf_menu.xhp\n" +"par_id371643135157996\n" "help.text" -msgid "Python interpreter;PYTHONPATH" +msgid "After creating the menu, it is recommended to call the Dispose method to free the resources used by the Menu service instance." msgstr "" -#. FPh6P -#: sf_intro.xhp +#. 2VDkD +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"hd_id341689720315095\n" +"sf_menu.xhp\n" +"par_id341636718182262\n" "help.text" -msgid "Setting PYTHONPATH" +msgid "In the example above, Item A is associated with the UNO command .uno:About whereas Item B is associated with the script ItemB_Listener defined in Module1 of the Standard library of the My Macros container." msgstr "" -#. XCiS5 -#: sf_intro.xhp +#. 9G7de +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id811689720328559\n" +"sf_menu.xhp\n" +"par_id851635274721129\n" "help.text" -msgid "Depending on your operating system's configuration you will need to set the environment variable PYTHONPATH in order to import the scriptforge.py library, which in turn requires importing the uno.py library." +msgid "The following example defines ItemB_Listener that will be called when Item B is clicked. This listener simply splits the argument string passed to the Sub and shows them in a message box." msgstr "" -#. AtNfv -#: sf_intro.xhp +#. AFHBG +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id781689720489355\n" +"sf_menu.xhp\n" +"bas_id716431354225603\n" "help.text" -msgid "Use your operating system's file search tool to determine the directory where both these files are located." +msgid "' Process the argument string passed to the listener" msgstr "" -#. uLiYM -#: sf_intro.xhp +#. GzLwF +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id431689720583565\n" +"sf_menu.xhp\n" +"bas_id901643135423012\n" "help.text" -msgid "For instance, on a default Ubuntu installation both files may be located at:" +msgid "MsgBox \"Menu name: \" & sArgs(0) & Chr(13) & _" msgstr "" -#. nxQGQ -#: sf_intro.xhp +#. qGB7L +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id791689720632086\n" +"sf_menu.xhp\n" +"bas_id301643136028263\n" "help.text" -msgid "scriptforge.py: Located in /usr/lib/libreoffice/program" +msgid "\"Menu item: \" & sArgs(1) & Chr(13) & _" msgstr "" -#. Dzfaq -#: sf_intro.xhp +#. wFTww +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id881689720632438\n" +"sf_menu.xhp\n" +"bas_id181643136028557\n" "help.text" -msgid "uno.py: Located in /usr/lib/python3/dist-packages" +msgid "\"Item ID: \" & sArgs(2) & Chr(13) & _" msgstr "" -#. 2vEpX -#: sf_intro.xhp +#. 9SGVd +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id701689720782180\n" +"sf_menu.xhp\n" +"bas_id561643136028710\n" "help.text" -msgid "In this case, set the environment variable PYTHONPATH as follows before starting the Python interpreter:" +msgid "\"Item status: \" & sArgs(3)" msgstr "" -#. 9BRx3 -#: sf_intro.xhp +#. MQJ7M +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id601689720825610\n" +"sf_menu.xhp\n" +"par_id531636493797707\n" "help.text" -msgid "export PYTHONPATH=/usr/lib/libreoffice/program:/usr/lib/python3/dist-packages" +msgid "As shown in the example above, menu entries associated with a script receive a comma-separated string argument with the following values:" msgstr "" -#. UDLem -#: sf_intro.xhp +#. uprfo +#: sf_menu.xhp msgctxt "" -"sf_intro.xhp\n" -"par_id971689720909044\n" +"sf_menu.xhp\n" +"par_id921643136489994\n" "help.text" -msgid "The location of these files will be different for each operating system and %PRODUCTNAME installation method." +msgid "The toplevel name of the menu." msgstr "" -#. VCRTD -#: sf_l10n.xhp +#. 7Jxz9 +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"tit\n" +"sf_menu.xhp\n" +"par_id611643136491059\n" "help.text" -msgid "ScriptForge.L10N service" +msgid "The string ID of the selected menu entry." msgstr "" -#. 5kFM4 -#: sf_l10n.xhp +#. hENoG +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"hd_id521585843652750\n" +"sf_menu.xhp\n" +"par_id961643136491491\n" "help.text" -msgid "ScriptForge.L10N service" +msgid "The numeric ID of the selected menu entry." msgstr "" -#. FRAiJ -#: sf_l10n.xhp +#. nYABy +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id411585843652556\n" +"sf_menu.xhp\n" +"par_id381643136494580\n" "help.text" -msgid "This service provides a number of methods related to the translation of strings with minimal impact on the program's source code. The methods provided by the L10N service can be used mainly to:" +msgid "The current state of the menu item. This is useful for checkboxes and radio buttons. If the item is checked, the value \"1\" is returned, otherwise \"0\" is returned." msgstr "" -#. gw2rW -#: sf_l10n.xhp +#. HHjiV +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id601614351922212\n" +"sf_menu.xhp\n" +"par_id131635275172617\n" "help.text" -msgid "Create POT files that can be used as templates for translation of all strings in the program." +msgid "The examples above can be written in Python as follows:" msgstr "" -#. sbVQL -#: sf_l10n.xhp +#. 6LQF4 +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id131614352196513\n" +"sf_menu.xhp\n" +"pyc_id981636717957632\n" "help.text" -msgid "Get translated strings at runtime for the language defined in the Locale property." +msgid "msg = f\"Menu name: {s_args[0]}\\n\"" msgstr "" -#. kCrgU -#: sf_l10n.xhp +#. GPKGe +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id971614966420419\n" +"sf_menu.xhp\n" +"pyc_id851636718008427\n" "help.text" -msgid "The acronym L10N stands for Localization and refers to a set of procedures for translating software to a specific country or region." +msgid "msg += f\"Menu item: {s_args[1]}\\n\"" msgstr "" -#. supr5 -#: sf_l10n.xhp +#. EfEaE +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id291585843652438\n" +"sf_menu.xhp\n" +"pyc_id331636727047102\n" "help.text" -msgid "PO files have long been promoted in the free software community as a means to providing multilingual user interfaces. This is accomplished through the use of human-readable text files with a well defined structure that specifies, for any given language, the source language string and the localized string." +msgid "msg += f\"Item ID: {s_args[2]}\\n\"" msgstr "" -#. j6xsd -#: sf_l10n.xhp +#. FPzcf +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id181585843652814\n" +"sf_menu.xhp\n" +"pyc_id71643137333404\n" "help.text" -msgid "The main advantage of the PO format is dissociation of the programmer and the translator. PO files are independent text files, so the programmer can send POT template files to translators, who will then translate their contents and return the translated PO files for each supported language." +msgid "msg += f\"Item status: {s_args[3]}\"" msgstr "" -#. vdQwG -#: sf_l10n.xhp +#. XxChZ +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id811614352321187\n" +"sf_menu.xhp\n" +"hd_id711600788076834\n" "help.text" -msgid "The L10N service is based on the GNU implementation of PO (portable object) files. To learn more about this file format, visit GNU gettext Utilities: PO Files." +msgid "Properties" msgstr "" -#. DGiG9 -#: sf_l10n.xhp +#. 98USM +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id91585843652832\n" +"sf_menu.xhp\n" +"par_id461600788076917\n" "help.text" -msgid "This service implements the methods listed below:" +msgid "Name" msgstr "" -#. fBXDW -#: sf_l10n.xhp +#. fT8mQ +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id1158584365237\n" +"sf_menu.xhp\n" +"par_id221600788076591\n" "help.text" -msgid "AddText: Used by the programmer to build a set of strings that will be translated later." +msgid "Readonly" msgstr "" -#. BtuQ3 -#: sf_l10n.xhp +#. DGBgA +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id81637866601151\n" +"sf_menu.xhp\n" +"par_id761600788076328\n" "help.text" -msgid "AddTextsFromDialog: Extracts all strings from a Dialog service instance." +msgid "Type" msgstr "" -#. cm7fq -#: sf_l10n.xhp +#. 2EE9k +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id681585843652331\n" +"sf_menu.xhp\n" +"par_id67160078807636\n" "help.text" -msgid "ExportToPOTFile: Exports the strings added by the AddText method to a POT file." +msgid "Description" msgstr "" -#. Z7dU5 -#: sf_l10n.xhp +#. qnRDA +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id531585843652697\n" +"sf_menu.xhp\n" +"par_id49160078807654\n" "help.text" -msgid "GetText: Gets the translated strings at runtime." +msgid "No" msgstr "" -#. D4Fyf -#: sf_l10n.xhp +#. LE27e +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id361614361362393\n" +"sf_menu.xhp\n" +"par_id81600788076419\n" "help.text" -msgid "Note that the first two methods are used to build a set of translatable strings and export them to a POT file. However, it is not mandatory to create POT files using these methods. Since they are text files, the programmer could have created them using any text editor." +msgid "Character used to define the access key of a menu item. The default character is \"~\"." msgstr "" -#. Rn7FL -#: sf_l10n.xhp +#. GSJAG +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"hd_id351585843652312\n" +"sf_menu.xhp\n" +"par_id311600788076756\n" "help.text" -msgid "Service invocation" +msgid "No" msgstr "" -#. 2WXAQ -#: sf_l10n.xhp +#. fb3iG +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id141609955500101\n" +"sf_menu.xhp\n" +"par_id441600788076826\n" "help.text" -msgid "Before using the L10N service the ScriptForge library needs to be loaded or imported:" +msgid "Character or string that defines how menu items are nested. The default character is \">\"." msgstr "" -#. 9xE8t -#: sf_l10n.xhp +#. bDCZ8 +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id421614353247163\n" +"sf_menu.xhp\n" +"hd_id181636719707892\n" "help.text" -msgid "There are several ways to invoke the L10N service using up to five optional arguments that specify the folder where PO files are stored, the locale and encoding to be used, as well as a fallback PO file and its encoding." +msgid "Menu and Submenus" msgstr "" -#. cCwBS -#: sf_l10n.xhp +#. YE5FL +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id331585843652877\n" +"sf_menu.xhp\n" +"par_id741636719725402\n" "help.text" -msgid "foldername: The folder containing the PO files. It must be expressed in the FileSystem.FileNaming notation." +msgid "To create a menu with submenus, use the character defined in the SubmenuCharacter property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy." msgstr "" -#. oQD4m -#: sf_l10n.xhp +#. Y4ETY +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id581585843652789\n" +"sf_menu.xhp\n" +"par_id211636720111489\n" "help.text" -msgid "locale: A string in the form \"la-CO\" (language-COUNTRY) or in the form \"la\" (language) only." +msgid "The code below uses the default submenu character \">\" to create the menu/submenu hierarchy defined above:" msgstr "" -#. gswGR -#: sf_l10n.xhp +#. P8NHo +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id591646219881864\n" +"sf_menu.xhp\n" +"par_id121636721243578\n" "help.text" -msgid "encoding: The character set to be used. The default encoding is \"UTF-8\"." +msgid "The string --- is used to define separator lines in menus or submenus." msgstr "" -#. CXd3e -#: sf_l10n.xhp +#. CYbLC +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id281646219882464\n" +"sf_menu.xhp\n" +"hd_id501582887473754\n" "help.text" -msgid "locale2: A string specifying the fallback locale to be used in case the PO file corresponding to the locale defined the locale parameter does not exist. This parameter is expressed in the form \"la-CO\" (language-COUNTRY) or \"la\" (language) only." +msgid "Methods" msgstr "" -#. TaFFX -#: sf_l10n.xhp +#. Lofgb +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id881646219882951\n" +"sf_menu.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "encoding2: The character set of the fallback PO file corresponding to the locale2 argument. The default encoding is \"UTF-8\"." +msgid "List of Methods in the Menu Service" msgstr "" -#. 6cmQr -#: sf_l10n.xhp +#. aDqJH +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id141613001281573\n" +"sf_menu.xhp\n" +"par_id93158919969864\n" "help.text" -msgid "To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets." +msgid "Inserts a check box in the menu. Returns an integer value that identifies the inserted item." msgstr "" -#. 3ApdD -#: sf_l10n.xhp +#. T8Fkq +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id891614358528334\n" +"sf_menu.xhp\n" +"par_id821591631203996\n" "help.text" -msgid "The following example instantiates the L10N service without any optional arguments. This will only enable the AddText and ExportToPOTFile methods, which is useful for creating POT files." +msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." msgstr "" -#. FaDSa -#: sf_l10n.xhp +#. SkMmC +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id611614358672609\n" +"sf_menu.xhp\n" +"par_id821591631203116\n" "help.text" -msgid "The example below specifies the folder containing the PO files. Because the locale is not defined, the service instance will use the locale defined for the %PRODUCTNAME user interface, which is the same locale defined in the OfficeLocale property of the Platform service." +msgid "name: String value used to identify the menu item. By default, the last component of the menu hierarchy is used." msgstr "" -#. FewYJ -#: sf_l10n.xhp +#. 7zhpM +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id391625855630975\n" +"sf_menu.xhp\n" +"par_id821591631203133\n" "help.text" -msgid "The example above will result in an runtime error if the PO file corresponding to the OfficeLocale locale does not exist in the specified folder." +msgid "status: Defines whether the item is selected when the menu is created (Default = False)." msgstr "" -#. gSzLN -#: sf_l10n.xhp +#. JPboo +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id321614358809763\n" +"sf_menu.xhp\n" +"par_id11636721653313\n" "help.text" -msgid "In the example below, the locale is explicitly defined to be Belgian French (\"fr-BE\"), hence the service will load the file \"fr-BE.po\" from the folder \"C:\\myPOFiles\". If the file does not exist, an error will occur." +msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." msgstr "" -#. WpYLF -#: sf_l10n.xhp +#. YzJwB +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id271646220649616\n" +"sf_menu.xhp\n" +"par_id11636721653208\n" "help.text" -msgid "To avoid errors, it is possible to specify a preferred and a fallback locale and encoding. The following example will first try to load the file \"fr-BE.po\" from the specified folder and if it does not exist, the file \"en-US.po\" will be loaded." +msgid "tooltip: Text to be displayed as tooltip." msgstr "" -#. UGFWB -#: sf_l10n.xhp +#. 3WPXT +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id411585843652496\n" +"sf_menu.xhp\n" +"par_id11636721653328\n" "help.text" -msgid "PO files must be named in the form \"la-CO.po\" or \"la.po\", where \"la\" refers to the language and \"CO\" is the country. Some examples are: \"en-US.po\", \"fr-BE.po\" or \"fr.po\"." +msgid "command: The name of a UNO command without the .uno: prefix. If the command name does not exist, nothing happens." msgstr "" -#. zQhHX -#: sf_l10n.xhp +#. LaF26 +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id171585843652545\n" +"sf_menu.xhp\n" +"par_id11636721653107\n" "help.text" -msgid "It is recommended to free resources after use:" +msgid "script: The URI for a Basic or Python script that will be executed when the item is clicked." msgstr "" -#. CmhnJ -#: sf_l10n.xhp +#. PTXhK +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id281625854773330\n" +"sf_menu.xhp\n" +"par_id31643198954204\n" "help.text" -msgid "The examples above can be translated to Python as follows:" +msgid "The arguments command and script are mutually exclusive, hence only one of them can be set for each menu item." msgstr "" -#. Z5Pb3 -#: sf_l10n.xhp +#. iodMg +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id301614358956087\n" +"sf_menu.xhp\n" +"par_id31643148484084\n" "help.text" -msgid "Several instances of the L10N service may coexist. However, each instance must use a separate directory for its PO files." +msgid "Read Scripting Framework URI Specification to learn more about the URI syntax used in the script argument." msgstr "" -#. 6mcLb -#: sf_l10n.xhp +#. Aj8cF +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"hd_id561585843652465\n" +"sf_menu.xhp\n" +"bas_id191643306748853\n" "help.text" -msgid "Properties" +msgid "' Menu entry associated with the .uno:Paste command" msgstr "" -#. mJaFd -#: sf_l10n.xhp +#. gQCkK +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id181585843652958\n" +"sf_menu.xhp\n" +"bas_id271643147793320\n" "help.text" -msgid "Name" +msgid "' Runs the Basic script Standard.Module1.MyListener stored in the document" msgstr "" -#. FFbDK -#: sf_l10n.xhp +#. 5fxEG +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id741585843652162\n" +"sf_menu.xhp\n" +"bas_id801643306742620\n" "help.text" -msgid "Readonly" +msgid "' Runs the Python script MyListener located in file myScripts.py in the user scripts folder" msgstr "" -#. X3tJK -#: sf_l10n.xhp +#. uAbp9 +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id291585843652823\n" +"sf_menu.xhp\n" +"par_id93158919963364\n" "help.text" -msgid "Type" +msgid "Inserts a label entry in the menu. Returns an integer value that identifies the inserted item." msgstr "" -#. 8ECBX -#: sf_l10n.xhp +#. tCHcD +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id351585843652638\n" +"sf_menu.xhp\n" +"par_id821591631203021\n" "help.text" -msgid "Description" +msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." msgstr "" -#. j3wEj -#: sf_l10n.xhp +#. yFQns +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id451585843652928\n" +"sf_menu.xhp\n" +"par_id821591631203026\n" "help.text" -msgid "Yes" +msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." msgstr "" -#. EMof8 -#: sf_l10n.xhp +#. DMEeJ +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id751585843652642\n" +"sf_menu.xhp\n" +"par_id11636721652886\n" "help.text" -msgid "The folder containing the PO files (see the FileSystem.FileNaming property to learn about the notation used)." +msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." msgstr "" -#. Zsp7p -#: sf_l10n.xhp +#. aZPNP +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id96158584365279\n" +"sf_menu.xhp\n" +"par_id11636721653118\n" "help.text" -msgid "Yes" +msgid "tooltip: Text to be displayed as tooltip." msgstr "" -#. vdfiw -#: sf_l10n.xhp +#. 23fax +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id331585843652912\n" +"sf_menu.xhp\n" +"par_id11636721653314\n" "help.text" -msgid "A zero-based array listing all the base names (without the \".po\" extension) of the PO-files found in the specified Folder." +msgid "command: The name of a UNO command without the .uno: prefix. If the command name does not exist, nothing happens." msgstr "" -#. NWxhu -#: sf_l10n.xhp +#. wysyV +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id961585843652589\n" +"sf_menu.xhp\n" +"par_id11636721652057\n" "help.text" -msgid "Yes" +msgid "script: The URI for a Basic or Python script that will be executed when the item is clicked." msgstr "" -#. LSNA3 -#: sf_l10n.xhp +#. QYzCL +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id561585843652947\n" +"sf_menu.xhp\n" +"bas_id41158919969106\n" "help.text" -msgid "The currently active language-COUNTRY combination. This property will be initially empty if the service was instantiated without any of the optional arguments." +msgid "oMenu.AddItem(\"Item A\", Tooltip := \"A descriptive message\")" msgstr "" -#. 5cs7h -#: sf_l10n.xhp +#. dxYAv +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id231614360519973\n" +"sf_menu.xhp\n" +"pyc_id321621534170554\n" "help.text" -msgid "List of Methods in the L10N Service" +msgid "oMenu.AddItem(\"Item A\", tooltip = \"A descriptive message\")" msgstr "" -#. Q24j9 -#: sf_l10n.xhp +#. qB7zU +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id1001585843652271\n" +"sf_menu.xhp\n" +"par_id93158919969399\n" "help.text" -msgid "Adds a new entry in the list of localizable strings. It must not exist yet." +msgid "Inserts a radio button entry in the menu. Returns an integer value that identifies the inserted item." msgstr "" -#. 5Fs5v -#: sf_l10n.xhp +#. FTrvY +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id641625855725050\n" +"sf_menu.xhp\n" +"par_id821591631203501\n" "help.text" -msgid "The method returns True if successful." +msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." msgstr "" -#. gyUYQ -#: sf_l10n.xhp +#. syjtC +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id391585843652753\n" +"sf_menu.xhp\n" +"par_id821591631228716\n" "help.text" -msgid "context: The key to retrieve the translated string with the GetText method. This parameter has a default value of \"\"." +msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." msgstr "" -#. YVUWx -#: sf_l10n.xhp +#. 7WBgE +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id581585844419114\n" +"sf_menu.xhp\n" +"par_id821591631203643\n" "help.text" -msgid "msgid: The untranslated string, which is the text appearing in the program code. It must not be empty. The msgid becomes the key to retrieve the translated string via GetText method when context is empty." +msgid "status: Defines whether the item is selected when the menu is created (Default = False)." msgstr "" -#. 7FDE9 -#: sf_l10n.xhp +#. 4uxXA +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id311614361926844\n" +"sf_menu.xhp\n" +"par_id11636721653228\n" "help.text" -msgid "The msgid string may contain any number of placeholders (%1 %2 %3 ...) for dynamically modifying the string at runtime." +msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." msgstr "" -#. ioGmP -#: sf_l10n.xhp +#. ZfFDR +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id541585844475331\n" +"sf_menu.xhp\n" +"par_id11636721653114\n" "help.text" -msgid "comment: Optional comment to be added alongside the string to help translators." +msgid "tooltip: Text to be displayed as tooltip." msgstr "" -#. TAyPG -#: sf_l10n.xhp +#. Sx9Bm +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id461614364298440\n" +"sf_menu.xhp\n" +"par_id11636721653447\n" "help.text" -msgid "The example below creates a set of strings in English:" +msgid "command: The name of a UNO command without the .uno: prefix. If the command name does not exist, nothing happens." msgstr "" -#. rWt7U -#: sf_l10n.xhp +#. AEnA6 +#: sf_menu.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id1001585843659821\n" +"sf_menu.xhp\n" +"par_id11636721652598\n" "help.text" -msgid "Automatically extracts strings from a dialog and adds them to the list of localizable text strings. The following strings are extracted:" +msgid "script: The URI for a Basic or Python script that will be executed when the item is clicked." msgstr "" -#. bS7ZL -#: sf_l10n.xhp +#. yYNtX +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id621637863440015\n" +"sf_methods.xhp\n" +"tit\n" "help.text" -msgid "The title of the dialog." +msgid "ScriptForge Method Signatures" msgstr "" -#. EBFAC -#: sf_l10n.xhp +#. GQoqb +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id61637863440399\n" +"sf_methods.xhp\n" +"hd_id31529004750471\n" "help.text" -msgid "The caption of the following control types: Button, CheckBox, FixedLine, FixedText, GroupBox and RadioButton." +msgid "ScriptForge Method Signatures" msgstr "" -#. uCL85 -#: sf_l10n.xhp +#. gEAos +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id251637863440626\n" +"sf_methods.xhp\n" +"bm_id491529070339774\n" "help.text" -msgid "Static strings in ListBoxes and ComboBoxes." +msgid "ScriptForge; Method signatures" msgstr "" -#. HWkAU -#: sf_l10n.xhp +#. Xq2N5 +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id811637863596791\n" +"sf_methods.xhp\n" +"par_id681619700336879\n" "help.text" -msgid "The tooltip or help text displayed when the mouse hovers over the control." +msgid "ScriptForge libraries aggregate macro scripting resources for %PRODUCTNAME to be invoked from Basic macros or Python scripts. Its modules and classes are invoked from user scripts as \"Services\" that expose properties, methods and events." msgstr "" -#. gKbEN -#: sf_l10n.xhp +#. paARG +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id641625855723650\n" +"sf_methods.xhp\n" +"par_id681623415196030\n" "help.text" -msgid "The method returns True if successful." +msgid "Whenever service methods are proposed solely for %PRODUCTNAME Basic, their syntax presentation matches that of Basic subroutines, functions or properties." msgstr "" -#. Kcowa -#: sf_l10n.xhp +#. 4dWnv +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id731637863894577\n" +"sf_methods.xhp\n" +"par_id401623415235965\n" "help.text" -msgid "The dialog from which strings will be extracted must not be open when the method is called." +msgid "Whenever service methods are proposed for Python and Basic, or solely for Python, their syntax and arguments use a specific textual layout." msgstr "" -#. Aj4gB -#: sf_l10n.xhp +#. McY36 +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id911637864050221\n" +"sf_methods.xhp\n" +"hd_id1001623415980365\n" "help.text" -msgid "When a L10N service instance is created from an existing PO file, use the GetTextsFromL10N method from the Dialog service to automatically load all translated strings into the dialog." +msgid "Basic only service method" msgstr "" -#. ejhbN -#: sf_l10n.xhp +#. tCvuL +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id391585843652113\n" +"sf_methods.xhp\n" +"par_id791623418737799\n" "help.text" -msgid "dialog: a Dialog service instance corresponding to the dialog from which strings will be extracted." +msgid "Typographical characters such as brackets, ellipsis or curly braces denote optional, repetitive or compulsory arguments:" msgstr "" -#. QzWzG -#: sf_l10n.xhp +#. FkDFy +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id461614364298983\n" +"sf_methods.xhp\n" +"hd_id711623416000470\n" "help.text" -msgid "The following example extracts all strings from the dialog \"MyDialog\" stored in the \"Standard\" library and exports them to a POT file:" +msgid "Python or Basic service methods" msgstr "" -#. DqFBf -#: sf_l10n.xhp +#. 8C6EM +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id281586102707242\n" +"sf_methods.xhp\n" +"par_id221623415475781\n" "help.text" -msgid "Exports a set of untranslated strings as a POT file." +msgid "The following typographical rules are mixing the UML notation, the API documentation layout and the UNO object inspector user interface:" msgstr "" -#. NABBq -#: sf_l10n.xhp +#. aSSDq +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id711586102939257\n" +"sf_methods.xhp\n" +"par_id661623417427142\n" "help.text" -msgid "To build a set of strings you can use either a succession of AddText method calls, or by a successful invocation of the L10N service with the foldername argument present. It is also possible to use a combination of both techniques." +msgid "Optional parameters are indicated with either opt, '=' accompanying a default value, or '[ ]' brackets." msgstr "" -#. Pb4VF -#: sf_l10n.xhp +#. 534sD +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id641625855725141\n" +"sf_methods.xhp\n" +"par_id351623417430814\n" "help.text" -msgid "The method returns True if successful." +msgid "arguments are lowercased, in order to comply with Python PEP 8 while Basic is case-agnostic." msgstr "" -#. BsmCX -#: sf_l10n.xhp +#. kFDAg +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id31586102707537\n" +"sf_methods.xhp\n" +"par_id781623417432494\n" "help.text" -msgid "filename: The output file in FileSystem.FileNaming notation." +msgid "Collections arguments or API sequences are denoted using UML multiplicity. That applies also to return values." msgstr "" -#. jQV77 -#: sf_l10n.xhp +#. bmVjq +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id851586102707579\n" +"sf_methods.xhp\n" +"par_id741623417433319\n" "help.text" -msgid "header: Comments that will be added on top of the generated POT file." +msgid "Basic data types and Python annotations are syntactically transposed as:" msgstr "" -#. YhYbQ -#: sf_l10n.xhp +#. GGeNU +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id111614364686973\n" +"sf_methods.xhp\n" +"par_id441613838858931\n" "help.text" -msgid "Do not include any leading \"#\" characters. If you want the header to be broken into multiple lines, insert escape sequences (\\n) where relevant. A standard header will be added alongside the text specified in the header argument." +msgid "Syntax" msgstr "" -#. E2Loj -#: sf_l10n.xhp +#. ENqPg +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id5158610270728\n" +"sf_methods.xhp\n" +"par_id851613847558931\n" "help.text" -msgid "encoding: The character set to be used (Default = \"UTF-8\")." +msgid "Boolean" msgstr "" -#. uDu7z -#: sf_l10n.xhp +#. vWABe +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id581614364494235\n" +"sf_methods.xhp\n" +"par_id931623419595424\n" "help.text" -msgid "The generated file should successfully pass the msgfmt --check GNU command." +msgid "UNO Object" msgstr "" -#. 32fPj -#: sf_l10n.xhp +#. 2q5Bk +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id891586165768715\n" +"sf_methods.xhp\n" +"par_id951623419595631\n" "help.text" -msgid "Gets the translated string corresponding to the given msgid argument." +msgid "User Defined
Type (UDT)" msgstr "" -#. NzGZC -#: sf_l10n.xhp +#. h4Tu4 +#: sf_methods.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id291614365296959\n" +"sf_methods.xhp\n" +"par_id451623419793734\n" "help.text" -msgid "A list of arguments may be specified to replace the placeholders (%1, %2, ...) in the string." +msgid "ScriptForge
service" msgstr "" -#. 9DBFa -#: sf_l10n.xhp +#. Ah5Gj +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id231586166181909\n" +"sf_platform.xhp\n" +"tit\n" "help.text" -msgid "If no translated string is found, the method returns the untranslated string after replacing the placeholders with the specified arguments." +msgid "ScriptForge.Platform service" msgstr "" -#. bAcmJ -#: sf_l10n.xhp +#. GKXoF +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id871586352505927\n" +"sf_platform.xhp\n" +"bm_id681600788076499\n" "help.text" -msgid "This method can be called either by the full name GetText or by the shortcut _ (a single underscore):" +msgid "ScriptForge.Platform service" msgstr "" -#. mvB66 -#: sf_l10n.xhp +#. 7D6Dx +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id421614967136502\n" +"sf_platform.xhp\n" +"par_id181600788076612\n" "help.text" -msgid "In the ScriptForge library, all methods starting with the \"_\" character are reserved for internal use only. However, the shortcut _ used for GetText is the only exception to this rule, hence it can be safely used in Basic and Python scripts." +msgid "The Platform service provides a collection of properties about the current execution environment and context, such as:" msgstr "" -#. 2ZVAQ -#: sf_l10n.xhp +#. FDJFB +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id51586165768525\n" +"sf_platform.xhp\n" +"par_id301600788076785\n" "help.text" -msgid "msgid: The untranslated string, which is the text appearing in the program code. It must not be empty. It may contain any number of placeholders (%1 %2 %3 ...) that can be used to dynamically insert text at runtime." +msgid "The hardware platform (architecture, CPU count, machine type, etc)" msgstr "" -#. dALxK -#: sf_l10n.xhp +#. i9FbJ +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id11614365537450\n" +"sf_platform.xhp\n" +"par_id1001600788076848\n" "help.text" -msgid "Besides using a single msgid string, this method also accepts the following formats:" +msgid "Operating system information (OS type, release, version, etc)" msgstr "" -#. Q7Bbm -#: sf_l10n.xhp +#. 6sN8Q +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id961614365557277\n" +"sf_platform.xhp\n" +"par_id67160078807676\n" "help.text" -msgid "The context string with which the method will retrieve the msgid in the PO file, or;" +msgid "The %PRODUCTNAME version" msgstr "" -#. rTDrq -#: sf_l10n.xhp +#. BrEr7 +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id981614365589866\n" +"sf_platform.xhp\n" +"par_id671600788076855\n" "help.text" -msgid "A combination context|msgid, instructing the method to retrieve the msgid using specified context value. The second part of the argument is used to improve code readability." +msgid "The current user name" msgstr "" -#. dW6RE -#: sf_l10n.xhp +#. ZvBqs +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id571586165768106\n" +"sf_platform.xhp\n" +"par_id951614903258253\n" "help.text" -msgid "args: Values to be inserted into the placeholders. Any variable type is allowed, however only strings, numbers and dates will be considered." +msgid "All properties of the Platform service are read-only." msgstr "" -#. cCZDK -#: sf_l10n.xhp +#. iK4Gv +#: sf_platform.xhp msgctxt "" -"sf_l10n.xhp\n" -"par_id701614365961454\n" +"sf_platform.xhp\n" +"hd_id281600788076359\n" "help.text" -msgid "Consider the following code is running on a %PRODUCTNAME installation with locale set to \"es-ES\". Additionally, there is a file \"es-ES.po\" inside the specified folder that translates the string passed to the GetText method:" +msgid "Service invocation" msgstr "" -#. yD78g -#: sf_menu.xhp +#. dogmo +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"tit\n" +"sf_platform.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "SFWidgets.Menu service" +msgid "Before using the Platform service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. mZUG7 -#: sf_menu.xhp +#. mHGZk +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bm_id681600788076499\n" +"sf_platform.xhp\n" +"par_id321614902851541\n" "help.text" -msgid "SFWidgets.Menu service" +msgid "The examples below in Basic and Python instantiate the Platform service and access the Architecture property." msgstr "" -#. FqGPg -#: sf_menu.xhp +#. KC5eN +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id181600788076612\n" +"sf_platform.xhp\n" +"hd_id711600788076834\n" "help.text" -msgid "The Menu service can be used to create and remove menus from the menubar of a %PRODUCTNAME document window. Each menu entry can be associated with a script or with a UNO command. This service provides the following capabilities:" +msgid "Properties" msgstr "" -#. UYDdv -#: sf_menu.xhp +#. VXJ8a +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id301600788076785\n" +"sf_platform.xhp\n" +"par_id461600788076917\n" "help.text" -msgid "Creation of menus with custom entries, checkboxes, radio buttons and separators." +msgid "Name" msgstr "" -#. KB9XF -#: sf_menu.xhp +#. JN68D +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id1001600788076848\n" +"sf_platform.xhp\n" +"par_id221600788076591\n" "help.text" -msgid "Decoration of menu items with icons and tooltips." +msgid "Readonly" msgstr "" -#. JSwJW -#: sf_menu.xhp +#. ZndAt +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id581643133675012\n" +"sf_platform.xhp\n" +"par_id761600788076328\n" "help.text" -msgid "Menus created with this service are available only for a specified document window. They are not saved into the document or as application settings. Closing and opening the document will restore the default menubar settings." +msgid "Type" msgstr "" -#. FEfWE -#: sf_menu.xhp +#. dAoKA +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id291643224925643\n" +"sf_platform.xhp\n" +"par_id67160078807636\n" "help.text" -msgid "When OLE objects such as Math formulas or Calc charts are edited from within a document, %PRODUCTNAME reconfigures the menubar according to the object. When this happens, the menus created with the Menu service are removed and are not be restored after editing the OLE object." +msgid "Description" msgstr "" -#. GftK9 -#: sf_menu.xhp +#. XdLGG +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"hd_id281600788076359\n" +"sf_platform.xhp\n" +"par_id311600788076756\n" "help.text" -msgid "Service invocation" +msgid "Yes" msgstr "" -#. o7QCg -#: sf_menu.xhp +#. EEWuL +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id141609955500101\n" +"sf_platform.xhp\n" +"par_id441600788076826\n" "help.text" -msgid "Before using the Menu service the ScriptForge library needs to be loaded or imported:" +msgid "The hardware bit architecture. Example: '32bit' or '64bit'" msgstr "" -#. EYjA8 -#: sf_menu.xhp +#. 8EZ8A +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id321614902851541\n" +"sf_platform.xhp\n" +"par_id49160078807654\n" "help.text" -msgid "The Menu service is instantiated by calling the CreateMenu method from the Document service. The code snippet below creates a menu named My Menu in the current document window with two entries Item A and Item B." +msgid "Yes" msgstr "" -#. pf7FV -#: sf_menu.xhp +#. iG4iH +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id261643134374056\n" +"sf_platform.xhp\n" +"par_id81600788076419\n" "help.text" -msgid "Set oMenu = oDoc.CreateMenu(\"My Menu\")" +msgid "The computer's network name." msgstr "" -#. Hoh4Q -#: sf_menu.xhp +#. hvAeY +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id431643134582213\n" +"sf_platform.xhp\n" +"par_id711600788076534\n" "help.text" -msgid ".AddItem(\"Item A\", Command := \"About\")" +msgid "Yes" msgstr "" -#. u52BY -#: sf_menu.xhp +#. v3N6U +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id571643134582396\n" +"sf_platform.xhp\n" +"par_id541600788076645\n" "help.text" -msgid ".AddItem(\"Item B\", Script := \"vnd.sun.star.script:Standard.Module1.ItemB_Listener?language=Basic&location=application\")" +msgid "The number of central processing units." msgstr "" -#. nd5od -#: sf_menu.xhp +#. 89Lo8 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id371643135157996\n" +"sf_platform.xhp\n" +"par_id891600788076190\n" "help.text" -msgid "After creating the menu, it is recommended to call the Dispose method to free the resources used by the Menu service instance." +msgid "Yes" msgstr "" -#. 2VDkD -#: sf_menu.xhp +#. rmGRV +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id341636718182262\n" +"sf_platform.xhp\n" +"par_id91600788076674\n" "help.text" -msgid "In the example above, Item A is associated with the UNO command .uno:About whereas Item B is associated with the script ItemB_Listener defined in Module1 of the Standard library of the My Macros container." +msgid "The name of the currently logged user." msgstr "" -#. 9G7de -#: sf_menu.xhp +#. rCN2h +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id851635274721129\n" +"sf_platform.xhp\n" +"par_id561633021747014\n" "help.text" -msgid "The following example defines ItemB_Listener that will be called when Item B is clicked. This listener simply splits the argument string passed to the Sub and shows them in a message box." +msgid "Yes" msgstr "" -#. AFHBG -#: sf_menu.xhp +#. T2MVx +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id716431354225603\n" +"sf_platform.xhp\n" +"par_id201633021748566\n" "help.text" -msgid "' Process the argument string passed to the listener" +msgid "String array" msgstr "" -#. GzLwF -#: sf_menu.xhp +#. 5Fkqe +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id901643135423012\n" +"sf_platform.xhp\n" +"par_id831633021749125\n" "help.text" -msgid "MsgBox \"Menu name: \" & sArgs(0) & Chr(13) & _" +msgid "Returns a zero-based array of strings containing the internal IDs of all installed extensions." msgstr "" -#. qGB7L -#: sf_menu.xhp +#. HE2VZ +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id301643136028263\n" +"sf_platform.xhp\n" +"par_id561633021747209\n" "help.text" -msgid "\"Menu item: \" & sArgs(1) & Chr(13) & _" +msgid "Yes" msgstr "" -#. wFTww -#: sf_menu.xhp +#. MgENM +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id181643136028557\n" +"sf_platform.xhp\n" +"par_id201633021748322\n" "help.text" -msgid "\"Item ID: \" & sArgs(2) & Chr(13) & _" +msgid "String array" msgstr "" -#. 9SGVd -#: sf_menu.xhp +#. bhBD2 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id561643136028710\n" +"sf_platform.xhp\n" +"par_id831633021749118\n" "help.text" -msgid "\"Item status: \" & sArgs(3)" +msgid "Returns a zero-based unsorted array of strings containing the available document import and export filter names." msgstr "" -#. MQJ7M -#: sf_menu.xhp +#. 9aGdF +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id531636493797707\n" +"sf_platform.xhp\n" +"par_id561633021747903\n" "help.text" -msgid "As shown in the example above, menu entries associated with a script receive a comma-separated string argument with the following values:" +msgid "Yes" msgstr "" -#. uprfo -#: sf_menu.xhp +#. yuuvA +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id921643136489994\n" +"sf_platform.xhp\n" +"par_id201633021748455\n" "help.text" -msgid "The toplevel name of the menu." +msgid "String array" msgstr "" -#. 7Jxz9 -#: sf_menu.xhp +#. BvYt3 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id611643136491059\n" +"sf_platform.xhp\n" +"par_id831633021749007\n" "help.text" -msgid "The string ID of the selected menu entry." +msgid "Returns a zero-based array of strings containing the names of all available fonts." msgstr "" -#. hENoG -#: sf_menu.xhp +#. 86VFG +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id961643136491491\n" +"sf_platform.xhp\n" +"par_id561633021748013\n" "help.text" -msgid "The numeric ID of the selected menu entry." +msgid "Yes" msgstr "" -#. nYABy -#: sf_menu.xhp +#. 9qBZR +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id381643136494580\n" +"sf_platform.xhp\n" +"par_id831633021749297\n" "help.text" -msgid "The current state of the menu item. This is useful for checkboxes and radio buttons. If the item is checked, the value \"1\" is returned, otherwise \"0\" is returned." +msgid "Returns the locale used for numbers and dates as a string in the format \"la-CO\" (language-COUNTRY)." msgstr "" -#. HHjiV -#: sf_menu.xhp +#. Av85C +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id131635275172617\n" +"sf_platform.xhp\n" +"par_id561633021743188\n" "help.text" -msgid "The examples above can be written in Python as follows:" +msgid "Yes" msgstr "" -#. 6LQF4 -#: sf_menu.xhp +#. sYrDn +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"pyc_id981636717957632\n" +"sf_platform.xhp\n" +"par_id831633021749018\n" "help.text" -msgid "msg = f\"Menu name: {s_args[0]}\\n\"" +msgid "Returns the locale of the operating system as a string in the format \"la-CO\" (language-COUNTRY). This is equivalent to the SystemLocale property." msgstr "" -#. GPKGe -#: sf_menu.xhp +#. Dt7J5 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"pyc_id851636718008427\n" +"sf_platform.xhp\n" +"par_id391600788076253\n" "help.text" -msgid "msg += f\"Menu item: {s_args[1]}\\n\"" +msgid "Yes" msgstr "" -#. EfEaE -#: sf_menu.xhp +#. LA6EN +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"pyc_id331636727047102\n" +"sf_platform.xhp\n" +"par_id21600788076541\n" "help.text" -msgid "msg += f\"Item ID: {s_args[2]}\\n\"" +msgid "The machine type. Examples are: 'i386' or 'x86_64'." msgstr "" -#. FPzcf -#: sf_menu.xhp +#. LbQr2 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"pyc_id71643137333404\n" +"sf_platform.xhp\n" +"par_id561633021706513\n" "help.text" -msgid "msg += f\"Item status: {s_args[3]}\"" +msgid "Yes" msgstr "" -#. XxChZ -#: sf_menu.xhp +#. ZZcSc +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"hd_id711600788076834\n" +"sf_platform.xhp\n" +"par_id831633021741117\n" "help.text" -msgid "Properties" +msgid "Returns the locale of the user interface as a string in the format \"la-CO\" (language-COUNTRY)." msgstr "" -#. 98USM -#: sf_menu.xhp +#. tqwyD +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id461600788076917\n" +"sf_platform.xhp\n" +"par_id211600788076138\n" "help.text" -msgid "Name" +msgid "Yes" msgstr "" -#. fT8mQ -#: sf_menu.xhp +#. WLRju +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id221600788076591\n" +"sf_platform.xhp\n" +"par_id521600788076371\n" "help.text" -msgid "Readonly" +msgid "The actual %PRODUCTNAME version expressed as
' %PRODUCTNAME w.x.y.z (The Document Foundation)'." msgstr "" -#. DGBgA -#: sf_menu.xhp +#. 2q29b +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id761600788076328\n" +"sf_platform.xhp\n" +"par_id621614902220807\n" "help.text" -msgid "Type" +msgid "Example: 'LibreOffice 7.4.1.2 (The Document Foundation, Debian and Ubuntu)'" msgstr "" -#. 2EE9k -#: sf_menu.xhp +#. 7WDer +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id67160078807636\n" +"sf_platform.xhp\n" +"par_id21600788076758\n" "help.text" -msgid "Description" +msgid "Yes" msgstr "" -#. qnRDA -#: sf_menu.xhp +#. NUSby +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id49160078807654\n" +"sf_platform.xhp\n" +"par_id781600788076694\n" "help.text" -msgid "No" +msgid "The operating system type. Example: 'Darwin, Linux' or 'Windows'." msgstr "" -#. LE27e -#: sf_menu.xhp +#. cLiaw +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id81600788076419\n" +"sf_platform.xhp\n" +"par_id261600788076841\n" "help.text" -msgid "Character used to define the access key of a menu item. The default character is \"~\"." +msgid "Yes" msgstr "" -#. GSJAG -#: sf_menu.xhp +#. nepQ6 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id311600788076756\n" +"sf_platform.xhp\n" +"par_id11600788076757\n" "help.text" -msgid "No" +msgid "A single string identifying the underlying platform with as much useful and human-readable information as possible." msgstr "" -#. fb3iG -#: sf_menu.xhp +#. EH36m +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id441600788076826\n" +"sf_platform.xhp\n" +"par_id501614902381381\n" "help.text" -msgid "Character or string that defines how menu items are nested. The default character is \">\"." +msgid "Example: 'Linux-5.8.0-44-generic-x86_64-with-glibc2.32'" msgstr "" -#. bDCZ8 -#: sf_menu.xhp +#. hbyth +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"hd_id181636719707892\n" +"sf_platform.xhp\n" +"par_id531600789141795\n" "help.text" -msgid "Menu and Submenus" +msgid "Yes" msgstr "" -#. YE5FL -#: sf_menu.xhp +#. 4iEvV +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id741636719725402\n" +"sf_platform.xhp\n" +"par_id301600789141619\n" "help.text" -msgid "To create a menu with submenus, use the character defined in the SubmenuCharacter property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy." +msgid "The operating system's release. Example: '5.8.0-44-generic'" msgstr "" -#. Y4ETY -#: sf_menu.xhp +#. 2fBtD +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id211636720111489\n" +"sf_platform.xhp\n" +"par_id541600789286532\n" "help.text" -msgid "The code below uses the default submenu character \">\" to create the menu/submenu hierarchy defined above:" +msgid "Yes" msgstr "" -#. P8NHo -#: sf_menu.xhp +#. iukPq +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id121636721243578\n" +"sf_platform.xhp\n" +"par_id701600789286280\n" "help.text" -msgid "The string --- is used to define separator lines in menus or submenus." +msgid "The operating system's build or version." msgstr "" -#. CYbLC -#: sf_menu.xhp +#. DWQNA +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"hd_id501582887473754\n" +"sf_platform.xhp\n" +"par_id351614902520555\n" "help.text" -msgid "Methods" +msgid "Example: '#50-Ubuntu SMP Tue Feb 9 06:29:41 UTC 2021'" msgstr "" -#. Lofgb -#: sf_menu.xhp +#. E8DzK +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id891611613601554\n" +"sf_platform.xhp\n" +"par_id941608709527698\n" "help.text" -msgid "List of Methods in the Menu Service" +msgid "Yes" msgstr "" -#. aDqJH -#: sf_menu.xhp +#. ArFcn +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id93158919969864\n" +"sf_platform.xhp\n" +"par_id661300789527859\n" "help.text" -msgid "Inserts a check box in the menu. Returns an integer value that identifies the inserted item." +msgid "The list of available printers as a zero-based array." msgstr "" -#. T8Fkq -#: sf_menu.xhp +#. nN5EG +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203996\n" +"sf_platform.xhp\n" +"par_id111614952098396\n" "help.text" -msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." +msgid "The default printer is put in the first position of the list (index = 0)." msgstr "" -#. SkMmC -#: sf_menu.xhp +#. fCdYi +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203116\n" +"sf_platform.xhp\n" +"par_id941600789527698\n" "help.text" -msgid "name: String value used to identify the menu item. By default, the last component of the menu hierarchy is used." +msgid "Yes" msgstr "" -#. 7zhpM -#: sf_menu.xhp +#. wkthE +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203133\n" +"sf_platform.xhp\n" +"par_id631600789527859\n" "help.text" -msgid "status: Defines whether the item is selected when the menu is created (Default = False)." +msgid "The real processor name. Example: 'amdk6'." msgstr "" -#. JPboo -#: sf_menu.xhp +#. MYY9M +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653313\n" +"sf_platform.xhp\n" +"par_id111614902598396\n" "help.text" -msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." +msgid "This property may return the same value as the Machine property." msgstr "" -#. YzJwB -#: sf_menu.xhp +#. yWwgE +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653208\n" +"sf_platform.xhp\n" +"par_id941608709527036\n" "help.text" -msgid "tooltip: Text to be displayed as tooltip." +msgid "Yes" msgstr "" -#. 3WPXT -#: sf_menu.xhp +#. Rw373 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653328\n" +"sf_platform.xhp\n" +"par_id661300789527994\n" "help.text" -msgid "command: The name of a UNO command without the .uno: prefix. If the command name does not exist, nothing happens." +msgid "Returns the version of the Python interpreter being used as a string in the format \"Python major.minor.patchlevel\" (ex: \"Python 3.9.7\")." msgstr "" -#. LaF26 -#: sf_menu.xhp +#. Ad9Cw +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653107\n" +"sf_platform.xhp\n" +"par_id561633021708547\n" "help.text" -msgid "script: The URI for a Basic or Python script that will be executed when the item is clicked." +msgid "Yes" msgstr "" -#. PTXhK -#: sf_menu.xhp +#. Aue6E +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id31643198954204\n" +"sf_platform.xhp\n" +"par_id831633021741336\n" "help.text" -msgid "The arguments command and script are mutually exclusive, hence only one of them can be set for each menu item." +msgid "Returns the locale of the operating system as a string in the format \"la-CO\" (language-COUNTRY). This is equivalent to the Locale property." msgstr "" -#. iodMg -#: sf_menu.xhp +#. BFiEF +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id31643148484084\n" +"sf_platform.xhp\n" +"par_id561633021702057\n" "help.text" -msgid "Read Scripting Framework URI Specification to learn more about the URI syntax used in the script argument." +msgid "Yes" msgstr "" -#. Aj8cF -#: sf_menu.xhp +#. v4LD3 +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id191643306748853\n" +"sf_platform.xhp\n" +"par_id831633021741958\n" "help.text" -msgid "' Menu entry associated with the .uno:Paste command" +msgid "Returns a Dictionary instance containing key-value pairs in relation with Tools - Options - User Data dialog." msgstr "" -#. gQCkK -#: sf_menu.xhp +#. FJs9t +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id271643147793320\n" +"sf_platform.xhp\n" +"par_id311633022159446\n" "help.text" -msgid "' Runs the Basic script Standard.Module1.MyListener stored in the document" +msgid "The following examples in Basic and Python illustrate how to use the Fonts property to write the names of all available fonts to the current Calc sheet starting at cell \"A1\":" msgstr "" -#. 5fxEG -#: sf_menu.xhp +#. q4gNG +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id801643306742620\n" +"sf_platform.xhp\n" +"par_id371692709207404\n" "help.text" -msgid "' Runs the Python script MyListener located in file myScripts.py in the user scripts folder" +msgid "The example below demonstrates how to create a Calc table with all the values stored in the UserData property, which is a Dictionary service instance:" msgstr "" -#. uAbp9 -#: sf_menu.xhp +#. sEkap +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id93158919963364\n" +"sf_platform.xhp\n" +"par_id611692709647033\n" "help.text" -msgid "Inserts a label entry in the menu. Returns an integer value that identifies the inserted item." +msgid "The examples above can be written in Python as follows:" msgstr "" -#. tCHcD -#: sf_menu.xhp +#. eEZPy +#: sf_platform.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203021\n" +"sf_platform.xhp\n" +"par_id301613065794148\n" "help.text" -msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." +msgid "Platform information with INFO(\"system\") Calc formula" msgstr "" -#. yFQns -#: sf_menu.xhp +#. h6atN +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203026\n" +"sf_popupmenu.xhp\n" +"tit\n" "help.text" -msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." +msgid "SFWidgets.PopupMenu service" msgstr "" -#. DMEeJ -#: sf_menu.xhp +#. Vouog +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721652886\n" +"sf_popupmenu.xhp\n" +"bm_id681600788076499\n" "help.text" -msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." +msgid "SFWidgets.PopupMenu service" msgstr "" -#. aZPNP -#: sf_menu.xhp +#. DGbZ3 +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653118\n" +"sf_popupmenu.xhp\n" +"par_id181600788076612\n" "help.text" -msgid "tooltip: Text to be displayed as tooltip." +msgid "The PopupMenu service can be used to create popup menus that can be associated with events or executed by scripts. This service provides the following capabilities:" msgstr "" -#. 23fax -#: sf_menu.xhp +#. fGtNp +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653314\n" +"sf_popupmenu.xhp\n" +"par_id301600788076785\n" "help.text" -msgid "command: The name of a UNO command without the .uno: prefix. If the command name does not exist, nothing happens." +msgid "Creation of popup menus with custom entries, checkboxes and radio buttons." msgstr "" -#. wysyV -#: sf_menu.xhp +#. QvyBB +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721652057\n" +"sf_popupmenu.xhp\n" +"par_id1001600788076848\n" "help.text" -msgid "script: The URI for a Basic or Python script that will be executed when the item is clicked." +msgid "Decoration of menu items with icons and tooltips." msgstr "" -#. QYzCL -#: sf_menu.xhp +#. GA9DY +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"bas_id41158919969106\n" +"sf_popupmenu.xhp\n" +"hd_id281600788076359\n" "help.text" -msgid "oMenu.AddItem(\"Item A\", Tooltip := \"A descriptive message\")" +msgid "Service invocation" msgstr "" -#. dxYAv -#: sf_menu.xhp +#. wHrLq +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"pyc_id321621534170554\n" +"sf_popupmenu.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "oMenu.AddItem(\"Item A\", tooltip = \"A descriptive message\")" +msgid "Before using the PopupMenu service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. qB7zU -#: sf_menu.xhp +#. aGukU +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id93158919969399\n" +"sf_popupmenu.xhp\n" +"par_id321614902851541\n" "help.text" -msgid "Inserts a radio button entry in the menu. Returns an integer value that identifies the inserted item." +msgid "The PopupMenu service can be instantiated in multiple ways. The example below creates a popup menu without associating it with a mouse or application event." msgstr "" -#. FTrvY -#: sf_menu.xhp +#. zEX7M +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203501\n" +"sf_popupmenu.xhp\n" +"bas_id841636717357955\n" "help.text" -msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." +msgid "MsgBox(\"Selected item ID: \" & vResponse)" msgstr "" -#. syjtC -#: sf_menu.xhp +#. XcbWz +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631228716\n" +"sf_popupmenu.xhp\n" +"par_id341636718182262\n" "help.text" -msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." +msgid "Running the Sub defined above will create a popup menu with two entries in the position X=300 and Y=300 on the screen." msgstr "" -#. 7WBgE -#: sf_menu.xhp +#. AySnz +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id821591631203643\n" +"sf_popupmenu.xhp\n" +"par_id711636493696169\n" "help.text" -msgid "status: Defines whether the item is selected when the menu is created (Default = False)." +msgid "The prefix SFWidgets can be suppressed while invoking the PopupMenu service." msgstr "" -#. 4uxXA -#: sf_menu.xhp +#. HnBew +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653228\n" +"sf_popupmenu.xhp\n" +"par_id851635274721129\n" "help.text" -msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." +msgid "The following example defines a Sub that can be associated with a mouse event:" msgstr "" -#. ZfFDR -#: sf_menu.xhp +#. iZdDG +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653114\n" +"sf_popupmenu.xhp\n" +"bas_id721636488722999\n" "help.text" -msgid "tooltip: Text to be displayed as tooltip." +msgid "' Populate popupmenu with items" msgstr "" -#. Sx9Bm -#: sf_menu.xhp +#. Czn9U +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721653447\n" +"sf_popupmenu.xhp\n" +"bas_id311636488724795\n" "help.text" -msgid "command: The name of a UNO command without the .uno: prefix. If the command name does not exist, nothing happens." +msgid "' Do something based on vResponse" msgstr "" -#. AEnA6 -#: sf_menu.xhp +#. ChBWz +#: sf_popupmenu.xhp msgctxt "" -"sf_menu.xhp\n" -"par_id11636721652598\n" +"sf_popupmenu.xhp\n" +"par_id991636718278125\n" "help.text" -msgid "script: The URI for a Basic or Python script that will be executed when the item is clicked." +msgid "Use the Dispose method to free resources after executing the popup menu." msgstr "" -#. yYNtX -#: sf_methods.xhp +#. K8FAQ +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"tit\n" +"sf_popupmenu.xhp\n" +"par_id531636493797707\n" "help.text" -msgid "ScriptForge Method Signatures" +msgid "It is also possible to associate a popup menu with events triggered by %PRODUCTNAME applications, form and dialog controls. Events such as \"Mouse button pressed\" and \"Mouse button released\" are commonly associated with popup menus." msgstr "" -#. GQoqb -#: sf_methods.xhp +#. L5Dhq +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"hd_id31529004750471\n" +"sf_popupmenu.xhp\n" +"par_id131635275172617\n" "help.text" -msgid "ScriptForge Method Signatures" +msgid "The examples above can be written in Python as follows:" msgstr "" -#. gEAos -#: sf_methods.xhp +#. 6esys +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"bm_id491529070339774\n" +"sf_popupmenu.xhp\n" +"pyc_id916367179574588\n" "help.text" -msgid "ScriptForge; Method signatures" +msgid "# Populate popupmenu with items" msgstr "" -#. Xq2N5 -#: sf_methods.xhp +#. Nj85P +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id681619700336879\n" +"sf_popupmenu.xhp\n" +"pyc_id851636718008427\n" "help.text" -msgid "ScriptForge libraries aggregate macro scripting resources for %PRODUCTNAME to be invoked from Basic macros or Python scripts. Its modules and classes are invoked from user scripts as \"Services\" that expose properties, methods and events." +msgid "# Do something based on response" msgstr "" -#. paARG -#: sf_methods.xhp +#. Bkw3n +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id681623415196030\n" +"sf_popupmenu.xhp\n" +"hd_id711600788076834\n" "help.text" -msgid "Whenever service methods are proposed solely for %PRODUCTNAME Basic, their syntax presentation matches that of Basic subroutines, functions or properties." +msgid "Properties" msgstr "" -#. 4dWnv -#: sf_methods.xhp +#. 7remQ +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id401623415235965\n" +"sf_popupmenu.xhp\n" +"par_id461600788076917\n" "help.text" -msgid "Whenever service methods are proposed for Python and Basic, or solely for Python, their syntax and arguments use a specific textual layout." +msgid "Name" msgstr "" -#. McY36 -#: sf_methods.xhp +#. zWaD9 +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"hd_id1001623415980365\n" +"sf_popupmenu.xhp\n" +"par_id221600788076591\n" "help.text" -msgid "Basic only service method" +msgid "Readonly" msgstr "" -#. tCvuL -#: sf_methods.xhp +#. 3bRwD +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id791623418737799\n" +"sf_popupmenu.xhp\n" +"par_id761600788076328\n" "help.text" -msgid "Typographical characters such as brackets, ellipsis or curly braces denote optional, repetitive or compulsory arguments:" +msgid "Type" msgstr "" -#. FkDFy -#: sf_methods.xhp +#. yAUC9 +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"hd_id711623416000470\n" +"sf_popupmenu.xhp\n" +"par_id67160078807636\n" "help.text" -msgid "Python or Basic service methods" +msgid "Description" msgstr "" -#. 8C6EM -#: sf_methods.xhp +#. qnMK2 +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id221623415475781\n" +"sf_popupmenu.xhp\n" +"par_id49160078807654\n" "help.text" -msgid "The following typographical rules are mixing the UML notation, the API documentation layout and the UNO object inspector user interface:" +msgid "No" msgstr "" -#. aSSDq -#: sf_methods.xhp +#. uERBN +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id661623417427142\n" +"sf_popupmenu.xhp\n" +"par_id81600788076419\n" "help.text" -msgid "Optional parameters are indicated with either opt, '=' accompanying a default value, or '[ ]' brackets." +msgid "Character used to define the access key of a menu item. The default character is ~." msgstr "" -#. 534sD -#: sf_methods.xhp +#. G2c6G +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id351623417430814\n" +"sf_popupmenu.xhp\n" +"par_id311600788076756\n" "help.text" -msgid "arguments are lowercased, in order to comply with Python PEP 8 while Basic is case-agnostic." +msgid "No" msgstr "" -#. kFDAg -#: sf_methods.xhp +#. ScuiK +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id781623417432494\n" +"sf_popupmenu.xhp\n" +"par_id441600788076826\n" "help.text" -msgid "Collections arguments or API sequences are denoted using UML multiplicity. That applies also to return values." +msgid "Character or string that defines how menu items are nested. The default character is >." msgstr "" -#. bmVjq -#: sf_methods.xhp +#. drBFS +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id741623417433319\n" +"sf_popupmenu.xhp\n" +"hd_id181636719707892\n" "help.text" -msgid "Basic data types and Python annotations are syntactically transposed as:" +msgid "Menu and Submenus" msgstr "" -#. GGeNU -#: sf_methods.xhp +#. XGwV6 +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id441613838858931\n" +"sf_popupmenu.xhp\n" +"par_id741636719725402\n" "help.text" -msgid "Syntax" +msgid "To create a popup menu with submenus, use the character defined in the SubmenuCharacter property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy." msgstr "" -#. ENqPg -#: sf_methods.xhp +#. mB5ry +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id851613847558931\n" +"sf_popupmenu.xhp\n" +"par_id211636720111489\n" "help.text" -msgid "Boolean" +msgid "The code below uses the default submenu character > to create the menu/submenu hierarchy defined above:" msgstr "" -#. vWABe -#: sf_methods.xhp +#. K5oTC +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id931623419595424\n" +"sf_popupmenu.xhp\n" +"par_id121636721243578\n" "help.text" -msgid "UNO Object" +msgid "The string --- is used to define separator lines in menus or submenus." msgstr "" -#. 2q5Bk -#: sf_methods.xhp +#. nA7BW +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id951623419595631\n" +"sf_popupmenu.xhp\n" +"hd_id211636723438558\n" "help.text" -msgid "User Defined
Type (UDT)" +msgid "Using icons" msgstr "" -#. h4Tu4 -#: sf_methods.xhp +#. UKLV5 +#: sf_popupmenu.xhp msgctxt "" -"sf_methods.xhp\n" -"par_id451623419793734\n" +"sf_popupmenu.xhp\n" +"par_id981636723485402\n" "help.text" -msgid "ScriptForge
service" +msgid "Items in the menu can have icons, which are specified as arguments in the AddCheckBox, AddItem and AddRadioButton methods." msgstr "" -#. Ah5Gj -#: sf_platform.xhp +#. TLDpD +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"tit\n" +"sf_popupmenu.xhp\n" +"par_id881636724112434\n" "help.text" -msgid "ScriptForge.Platform service" +msgid "All icons available in %PRODUCTNAME can be used by specifying their path relative to the folder where icon files are located in the installation folder. Icons are located in the following folder:" msgstr "" -#. GKXoF -#: sf_platform.xhp +#. n2owj +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"bm_id681600788076499\n" +"sf_popupmenu.xhp\n" +"par_id941636724808906\n" "help.text" -msgid "ScriptForge.Platform service" +msgid "Use the InstallFolder property of the FileSystem service to determine where %PRODUCTNAME is installed in your system." msgstr "" -#. 7D6Dx -#: sf_platform.xhp +#. xbEsC +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id181600788076612\n" +"sf_popupmenu.xhp\n" +"par_id201636724575911\n" "help.text" -msgid "The Platform service provides a collection of properties about the current execution environment and context, such as:" +msgid "This folder contains a series of ZIP files containing the image files of each available icon set. The images inside these ZIP files are organized into folders. To use an icon, specify the icon file with the path to its location inside the ZIP file." msgstr "" -#. FDJFB -#: sf_platform.xhp +#. 5yvv9 +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id301600788076785\n" +"sf_popupmenu.xhp\n" +"par_id641636724972071\n" "help.text" -msgid "The hardware platform (architecture, CPU count, machine type, etc)" +msgid "The example below uses the icon \"sc_newdoc.svg\" that is located inside the \"cmd\" folder. The forward slash \"/\" character is used as the path separator regardless of the operating system." msgstr "" -#. i9FbJ -#: sf_platform.xhp +#. 2QW4m +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id1001600788076848\n" +"sf_popupmenu.xhp\n" +"par_id691636725233961\n" "help.text" -msgid "Operating system information (OS type, release, version, etc)" +msgid "All icon sets have the same internal structure. The actual icon displayed depends on the icon set currently in use." msgstr "" -#. 6sN8Q -#: sf_platform.xhp +#. v6wRS +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id67160078807676\n" +"sf_popupmenu.xhp\n" +"hd_id501582887473754\n" "help.text" -msgid "The %PRODUCTNAME version" +msgid "Methods" msgstr "" -#. BrEr7 -#: sf_platform.xhp +#. CWGtf +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id671600788076855\n" +"sf_popupmenu.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "The current user name" +msgid "List of Methods in the PopupMenu Service" msgstr "" -#. ZvBqs -#: sf_platform.xhp +#. RAcsN +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id951614903258253\n" +"sf_popupmenu.xhp\n" +"par_id93158919969864\n" "help.text" -msgid "All properties of the Platform service are read-only." +msgid "Inserts a check box in the popup menu. Returns an integer value that identifies the inserted item." msgstr "" -#. iK4Gv -#: sf_platform.xhp +#. ZZrDA +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"hd_id281600788076359\n" +"sf_popupmenu.xhp\n" +"par_id821591631203996\n" "help.text" -msgid "Service invocation" +msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." msgstr "" -#. dogmo -#: sf_platform.xhp +#. riy7p +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id141609955500101\n" +"sf_popupmenu.xhp\n" +"par_id821591631203116\n" "help.text" -msgid "Before using the Platform service the ScriptForge library needs to be loaded or imported:" +msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." msgstr "" -#. mHGZk -#: sf_platform.xhp +#. yxK8E +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id321614902851541\n" +"sf_popupmenu.xhp\n" +"par_id821591631203133\n" "help.text" -msgid "The examples below in Basic and Python instantiate the Platform service and access the Architecture property." +msgid "status: Defines whether the item is selected when the menu is created (Default = False)." msgstr "" -#. KC5eN -#: sf_platform.xhp +#. Q4ZNV +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"hd_id711600788076834\n" +"sf_popupmenu.xhp\n" +"par_id11636721653313\n" "help.text" -msgid "Properties" +msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." msgstr "" -#. VXJ8a -#: sf_platform.xhp +#. dkqgP +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id461600788076917\n" +"sf_popupmenu.xhp\n" +"par_id11636721653208\n" "help.text" -msgid "Name" +msgid "tooltip: Text to be displayed as tooltip." msgstr "" -#. JN68D -#: sf_platform.xhp +#. NEE76 +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id221600788076591\n" +"sf_popupmenu.xhp\n" +"par_id93158919963364\n" "help.text" -msgid "Readonly" +msgid "Inserts a menu entry in the popup menu. Returns an integer value that identifies the inserted item." msgstr "" -#. ZndAt -#: sf_platform.xhp +#. vdtEn +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id761600788076328\n" +"sf_popupmenu.xhp\n" +"par_id821591631203021\n" "help.text" -msgid "Type" +msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." msgstr "" -#. dAoKA -#: sf_platform.xhp +#. 8eE5y +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id67160078807636\n" +"sf_popupmenu.xhp\n" +"par_id821591631203026\n" "help.text" -msgid "Description" +msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." msgstr "" -#. XdLGG -#: sf_platform.xhp +#. F646F +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id311600788076756\n" +"sf_popupmenu.xhp\n" +"par_id11636721652886\n" "help.text" -msgid "Yes" +msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." msgstr "" -#. EEWuL -#: sf_platform.xhp +#. XFkGB +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id441600788076826\n" +"sf_popupmenu.xhp\n" +"par_id11636721653118\n" "help.text" -msgid "The hardware bit architecture. Example: '32bit' or '64bit'" +msgid "tooltip: Text to be displayed as tooltip." msgstr "" -#. 8EZ8A -#: sf_platform.xhp +#. dJTZs +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id49160078807654\n" +"sf_popupmenu.xhp\n" +"bas_id41158919969106\n" "help.text" -msgid "Yes" +msgid "myPopup.AddItem(\"Item A\", Tooltip := \"A descriptive message\")" msgstr "" -#. iG4iH -#: sf_platform.xhp +#. VDLFK +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id81600788076419\n" +"sf_popupmenu.xhp\n" +"pyc_id321621534170554\n" "help.text" -msgid "The computer's network name." +msgid "my_popup.AddItem(\"Item A\", tooltip = \"A descriptive message\")" msgstr "" -#. hvAeY -#: sf_platform.xhp +#. U2vBb +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id711600788076534\n" +"sf_popupmenu.xhp\n" +"par_id93158919969399\n" "help.text" -msgid "Yes" +msgid "Inserts a radio button entry in the popup menu. Returns an integer value that identifies the inserted item." msgstr "" -#. v3N6U -#: sf_platform.xhp +#. 92F32 +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id541600788076645\n" +"sf_popupmenu.xhp\n" +"par_id821591631203501\n" "help.text" -msgid "The number of central processing units." +msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." msgstr "" -#. 89Lo8 -#: sf_platform.xhp +#. 2PuBE +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id891600788076190\n" +"sf_popupmenu.xhp\n" +"par_id821591631228716\n" "help.text" -msgid "Yes" +msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." msgstr "" -#. rmGRV -#: sf_platform.xhp +#. yLvRM +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id91600788076674\n" +"sf_popupmenu.xhp\n" +"par_id821591631203643\n" "help.text" -msgid "The name of the currently logged user." +msgid "status: Defines whether the item is selected when the menu is created (Default = False)." msgstr "" -#. rCN2h -#: sf_platform.xhp +#. 6XiD7 +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021747014\n" +"sf_popupmenu.xhp\n" +"par_id11636721653228\n" "help.text" -msgid "Yes" +msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." msgstr "" -#. T2MVx -#: sf_platform.xhp +#. cRTRD +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id201633021748566\n" +"sf_popupmenu.xhp\n" +"par_id11636721653114\n" "help.text" -msgid "String array" +msgid "tooltip: Text to be displayed as tooltip." msgstr "" -#. 5Fkqe -#: sf_platform.xhp +#. nQrD3 +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021749125\n" +"sf_popupmenu.xhp\n" +"par_id93158919963279\n" "help.text" -msgid "Returns a zero-based array of strings containing the internal IDs of all installed extensions." +msgid "Displays the popup menu and waits for a user action. Returns the item clicked by the user." msgstr "" -#. HE2VZ -#: sf_platform.xhp +#. qwwKx +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021747209\n" +"sf_popupmenu.xhp\n" +"par_id101636726249788\n" "help.text" -msgid "Yes" +msgid "If the user clicks outside the popup menu or presses the Esc key, then no item is selected. In such cases, the returned value depends on the returnid parameter. If returnid = True and no item is selected, then the value 0 (zero) is returned. Otherwise an empty string \"\" is returned." msgstr "" -#. MgENM -#: sf_platform.xhp +#. EFriZ +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id201633021748322\n" +"sf_popupmenu.xhp\n" +"par_id821591631202088\n" "help.text" -msgid "String array" +msgid "returnid: If True the selected item ID is returned. If False the method returns the item's name (Default = True)." msgstr "" -#. bhBD2 -#: sf_platform.xhp +#. y4PWP +#: sf_popupmenu.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021749118\n" +"sf_popupmenu.xhp\n" +"par_id51636726671698\n" "help.text" -msgid "Returns a zero-based unsorted array of strings containing the available document import and export filter names." +msgid "In the examples below, a popup menu is created and the item's name is returned because the returnid argument is set to False." msgstr "" -#. 9aGdF -#: sf_platform.xhp +#. b8bDr +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021747903\n" +"sf_region.xhp\n" +"tit\n" "help.text" -msgid "Yes" +msgid "ScriptForge.Region service" msgstr "" -#. yuuvA -#: sf_platform.xhp +#. H7HZZ +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id201633021748455\n" +"sf_region.xhp\n" +"bm_id681600788076499\n" "help.text" -msgid "String array" +msgid "ScriptForge.Region service" msgstr "" -#. BvYt3 -#: sf_platform.xhp +#. w3WgP +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021749007\n" +"sf_region.xhp\n" +"par_id181600788076612\n" "help.text" -msgid "Returns a zero-based array of strings containing the names of all available fonts." +msgid "The Region service provides a collection of properties and methods to handle locale and region-related aspects of programming, such as:" msgstr "" -#. 86VFG -#: sf_platform.xhp +#. TEk7a +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021748013\n" +"sf_region.xhp\n" +"par_id301600788076785\n" "help.text" -msgid "Yes" +msgid "Accessing locale and region-dependent settings such as number formatting, currency and timezones." msgstr "" -#. 9qBZR -#: sf_platform.xhp +#. 2f7KC +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021749297\n" +"sf_region.xhp\n" +"par_id1001600788076848\n" "help.text" -msgid "Returns the locale used for numbers and dates as a string in the format \"la-CO\" (language-COUNTRY)." +msgid "Converting timezones and calculate Daylight Saving Time (DST) offsets." msgstr "" -#. Av85C -#: sf_platform.xhp +#. tqznj +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021743188\n" +"sf_region.xhp\n" +"par_id67160078807676\n" "help.text" -msgid "Yes" +msgid "Transforming numbers into text in any supported language." msgstr "" -#. sYrDn -#: sf_platform.xhp +#. 9nRv7 +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021749018\n" +"sf_region.xhp\n" +"hd_id851656012844548\n" "help.text" -msgid "Returns the locale of the operating system as a string in the format \"la-CO\" (language-COUNTRY). This is equivalent to the SystemLocale property." +msgid "Definitions" msgstr "" -#. Dt7J5 -#: sf_platform.xhp +#. sGNu7 +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id391600788076253\n" +"sf_region.xhp\n" +"hd_id421656012886648\n" "help.text" -msgid "Yes" +msgid "Locale or Region" msgstr "" -#. LA6EN -#: sf_platform.xhp +#. FiW7z +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id21600788076541\n" +"sf_region.xhp\n" +"par_id191656012908838\n" "help.text" -msgid "The machine type. Examples are: 'i386' or 'x86_64'." +msgid "A string combining a language and a country in the format \"la-CO\". The language part is expressed with 2 or 3 lowercase characters followed by a dash and 2 uppercase characters representing the country." msgstr "" -#. LbQr2 -#: sf_platform.xhp +#. GQEGW +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021706513\n" +"sf_region.xhp\n" +"par_id431656013368415\n" "help.text" -msgid "Yes" +msgid "For instance, \"en-US\" corresponds to the English language in the United States; \"fr-BE\" corresponds to the French language in Belgium, and so forth." msgstr "" -#. ZZcSc -#: sf_platform.xhp +#. CQYAX +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021741117\n" +"sf_region.xhp\n" +"par_id981656013623018\n" "help.text" -msgid "Returns the locale of the user interface as a string in the format \"la-CO\" (language-COUNTRY)." +msgid "On some situations the full locale is not required and only the language or country may be specified." msgstr "" -#. tqwyD -#: sf_platform.xhp +#. ujAAt +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id211600788076138\n" +"sf_region.xhp\n" +"par_id261656013132204\n" "help.text" -msgid "Yes" +msgid "Most properties and methods accept a locale as argument. If no locale is specified, then the user-interface locale is used, which is defined in the OfficeLocale property of the Platform service." msgstr "" -#. WLRju -#: sf_platform.xhp +#. 6ToTC +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id521600788076371\n" +"sf_region.xhp\n" +"hd_id51656013825718\n" "help.text" -msgid "The actual %PRODUCTNAME version expressed as
' %PRODUCTNAME w.x.y.z (The Document Foundation)'." +msgid "Timezone" msgstr "" -#. 2q29b -#: sf_platform.xhp +#. GGBdC +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id621614902220807\n" +"sf_region.xhp\n" +"par_id541656013854150\n" "help.text" -msgid "Example: 'LibreOffice 7.4.1.2 (The Document Foundation, Debian and Ubuntu)'" +msgid "A string in the format \"Region/City\" such as \"Europe/Berlin\", or a timezone ID such as \"UTC\" or \"GMT-8:00\". Refer to the wiki page List of tz database timezones for a list of possible timezone names and IDs." msgstr "" -#. 7WDer -#: sf_platform.xhp +#. exa3B +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id21600788076758\n" +"sf_region.xhp\n" +"par_id981656078937577\n" "help.text" -msgid "Yes" +msgid "Providing an invalid timezone string to any of the methods in the Region service will not result in a runtime error. Instead, methods as UTCDateTime and UTCNow will return the current operating system date and time." msgstr "" -#. NUSby -#: sf_platform.xhp +#. 7GTLU +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id781600788076694\n" +"sf_region.xhp\n" +"par_id611656014040098\n" "help.text" -msgid "The operating system type. Example: 'Darwin, Linux' or 'Windows'." +msgid "The time offset between the timezone and the Greenwich Meridian Time (GMT) is expressed in minutes." msgstr "" -#. cLiaw -#: sf_platform.xhp +#. ottwV +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id261600788076841\n" +"sf_region.xhp\n" +"par_id121656014053670\n" "help.text" -msgid "Yes" +msgid "The Daylight Saving Time (DST) is an additional offset." msgstr "" -#. nepQ6 -#: sf_platform.xhp +#. yXHrp +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id11600788076757\n" +"sf_region.xhp\n" +"par_id591656014140929\n" "help.text" -msgid "A single string identifying the underlying platform with as much useful and human-readable information as possible." +msgid "The timezone and DST offsets may be positive or negative." msgstr "" -#. EH36m -#: sf_platform.xhp +#. EyNvN +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id501614902381381\n" +"sf_region.xhp\n" +"hd_id281600788076359\n" "help.text" -msgid "Example: 'Linux-5.8.0-44-generic-x86_64-with-glibc2.32'" +msgid "Service invocation" msgstr "" -#. hbyth -#: sf_platform.xhp +#. F9Wnj +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id531600789141795\n" +"sf_region.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "Yes" +msgid "Before using the Region service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. 4iEvV -#: sf_platform.xhp +#. 7AXFZ +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id301600789141619\n" +"sf_region.xhp\n" +"par_id321614902851541\n" "help.text" -msgid "The operating system's release. Example: '5.8.0-44-generic'" +msgid "The examples below in Basic and Python instantiate the Region service and access the Country property." msgstr "" -#. 2fBtD -#: sf_platform.xhp +#. 69CF7 +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id541600789286532\n" +"sf_region.xhp\n" +"bas_id791600788431935\n" "help.text" -msgid "Yes" +msgid "MsgBox oRegion.Country(\"en-US\") ' United States" msgstr "" -#. iukPq -#: sf_platform.xhp +#. FDNKL +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id701600789286280\n" +"sf_region.xhp\n" +"hd_id711600788076834\n" "help.text" -msgid "The operating system's build or version." +msgid "Properties" msgstr "" -#. DWQNA -#: sf_platform.xhp +#. VEB3D +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id351614902520555\n" +"sf_region.xhp\n" +"par_id601656018689690\n" "help.text" -msgid "Example: '#50-Ubuntu SMP Tue Feb 9 06:29:41 UTC 2021'" +msgid "All properties listed below accept a locale argument, provided as a string. Some properties require this argument to be in the format \"la-CO\", whereas others may receive \"la\" or \"CO\" as input." msgstr "" -#. E8DzK -#: sf_platform.xhp +#. vzB4T +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id941608709527698\n" +"sf_region.xhp\n" +"par_id461600788076917\n" "help.text" -msgid "Yes" +msgid "Name" msgstr "" -#. ArFcn -#: sf_platform.xhp +#. ay9iH +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id661300789527859\n" +"sf_region.xhp\n" +"par_id221600788076591\n" "help.text" -msgid "The list of available printers as a zero-based array." +msgid "Readonly" msgstr "" -#. nN5EG -#: sf_platform.xhp +#. rBUEm +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id111614952098396\n" +"sf_region.xhp\n" +"par_id761600788076328\n" "help.text" -msgid "The default printer is put in the first position of the list (index = 0)." +msgid "Type" msgstr "" -#. fCdYi -#: sf_platform.xhp +#. FpD5h +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id941600789527698\n" +"sf_region.xhp\n" +"par_id131656330679679\n" "help.text" -msgid "Yes" +msgid "Locale" msgstr "" -#. wkthE -#: sf_platform.xhp +#. FxnFK +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id631600789527859\n" +"sf_region.xhp\n" +"par_id67160078807636\n" "help.text" -msgid "The real processor name. Example: 'amdk6'." +msgid "Description" msgstr "" -#. MYY9M -#: sf_platform.xhp +#. 4Ss2G +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id111614902598396\n" +"sf_region.xhp\n" +"par_id311600788076756\n" "help.text" -msgid "This property may return the same value as the Machine property." +msgid "Yes" msgstr "" -#. yWwgE -#: sf_platform.xhp +#. ExbtG +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id941608709527036\n" +"sf_region.xhp\n" +"par_id441600788076826\n" "help.text" -msgid "Yes" +msgid "Returns the country name in English corresponding to a given region." msgstr "" -#. Rw373 -#: sf_platform.xhp +#. FN4XC +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id661300789527994\n" +"sf_region.xhp\n" +"par_id49160078807654\n" "help.text" -msgid "Returns the version of the Python interpreter being used as a string in the format \"Python major.minor.patchlevel\" (ex: \"Python 3.9.7\")." +msgid "Yes" msgstr "" -#. Ad9Cw -#: sf_platform.xhp +#. vpDwN +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021708547\n" +"sf_region.xhp\n" +"par_id81600788076419\n" "help.text" -msgid "Yes" +msgid "Returns the ISO 4217 currency code of the specified region." msgstr "" -#. Aue6E -#: sf_platform.xhp +#. Aqcuy +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021741336\n" +"sf_region.xhp\n" +"par_id711600788076534\n" "help.text" -msgid "Returns the locale of the operating system as a string in the format \"la-CO\" (language-COUNTRY). This is equivalent to the Locale property." +msgid "Yes" msgstr "" -#. BFiEF -#: sf_platform.xhp +#. 6cgk7 +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id561633021702057\n" +"sf_region.xhp\n" +"par_id911600788076842\n" "help.text" -msgid "Yes" +msgid "String array" msgstr "" -#. 4Wfdk -#: sf_platform.xhp +#. Jhkc3 +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id831633021741958\n" +"sf_region.xhp\n" +"par_id541600788076645\n" "help.text" -msgid "Returns a Dictionary instance containing key-value pairs with the information found in the Tools - Options - User Data dialog." +msgid "Returns a zero-based array of strings containing the date acceptance patterns for the specified region." msgstr "" -#. FJs9t -#: sf_platform.xhp +#. T4sUQ +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id311633022159446\n" +"sf_region.xhp\n" +"par_id891600788076190\n" "help.text" -msgid "The following examples in Basic and Python illustrate how to use the Fonts property to write the names of all available fonts to the current Calc sheet starting at cell \"A1\":" +msgid "Yes" msgstr "" -#. q4gNG -#: sf_platform.xhp +#. vAJYH +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id371692709207404\n" +"sf_region.xhp\n" +"par_id91600788076674\n" "help.text" -msgid "The example below demonstrates how to create a Calc table with all the values stored in the UserData property, which is a Dictionary service instance:" +msgid "Returns the date separator used in the given region." msgstr "" -#. sEkap -#: sf_platform.xhp +#. QKyGp +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id611692709647033\n" +"sf_region.xhp\n" +"par_id561633021747014\n" "help.text" -msgid "The examples above can be written in Python as follows:" +msgid "Yes" msgstr "" -#. eEZPy -#: sf_platform.xhp +#. jSVY8 +#: sf_region.xhp msgctxt "" -"sf_platform.xhp\n" -"par_id301613065794148\n" +"sf_region.xhp\n" +"par_id201633021748566\n" "help.text" -msgid "Platform information with INFO(\"system\") Calc formula" +msgid "String array" msgstr "" -#. h6atN -#: sf_popupmenu.xhp +#. CnTuU +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"tit\n" +"sf_region.xhp\n" +"par_id831633021745014\n" "help.text" -msgid "SFWidgets.PopupMenu service" +msgid "Returns a zero-based array of strings containing the list of abbreviated weekday names in the specified language." msgstr "" -#. Vouog -#: sf_popupmenu.xhp +#. jRUnx +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"bm_id681600788076499\n" +"sf_region.xhp\n" +"par_id561633021747209\n" "help.text" -msgid "SFWidgets.PopupMenu service" +msgid "Yes" msgstr "" -#. DGbZ3 -#: sf_popupmenu.xhp +#. CGeKU +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id181600788076612\n" +"sf_region.xhp\n" +"par_id201633021748322\n" "help.text" -msgid "The PopupMenu service can be used to create popup menus that can be associated with events or executed by scripts. This service provides the following capabilities:" +msgid "String array" msgstr "" -#. fGtNp -#: sf_popupmenu.xhp +#. tjGhP +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id301600788076785\n" +"sf_region.xhp\n" +"par_id831633021748865\n" "help.text" -msgid "Creation of popup menus with custom entries, checkboxes and radio buttons." +msgid "Returns a zero-based array of strings containing the list of weekday names in the specified language." msgstr "" -#. QvyBB -#: sf_popupmenu.xhp +#. gVevH +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id1001600788076848\n" +"sf_region.xhp\n" +"par_id561633021747903\n" "help.text" -msgid "Decoration of menu items with icons and tooltips." +msgid "Yes" msgstr "" -#. GA9DY -#: sf_popupmenu.xhp +#. hL4sb +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"hd_id281600788076359\n" +"sf_region.xhp\n" +"par_id201633021748455\n" "help.text" -msgid "Service invocation" +msgid "String array" msgstr "" -#. wHrLq -#: sf_popupmenu.xhp +#. GHdGz +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id141609955500101\n" +"sf_region.xhp\n" +"par_id831633021747711\n" "help.text" -msgid "Before using the PopupMenu service the ScriptForge library needs to be loaded or imported:" +msgid "Returns a zero-based array of strings containing the list of the initials of weekday names in the specified language." msgstr "" -#. aGukU -#: sf_popupmenu.xhp +#. TFzKG +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id321614902851541\n" +"sf_region.xhp\n" +"par_id561633021748013\n" "help.text" -msgid "The PopupMenu service can be instantiated in multiple ways. The example below creates a popup menu without associating it with a mouse or application event." +msgid "Yes" msgstr "" -#. zEX7M -#: sf_popupmenu.xhp +#. CWLzi +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"bas_id841636717357955\n" +"sf_region.xhp\n" +"par_id831633021749297\n" "help.text" -msgid "MsgBox(\"Selected item ID: \" & vResponse)" +msgid "Returns the decimal separator used in numbers in the specified region." msgstr "" -#. XcbWz -#: sf_popupmenu.xhp +#. pqWDC +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id341636718182262\n" +"sf_region.xhp\n" +"par_id561633021743188\n" "help.text" -msgid "Running the Sub defined above will create a popup menu with two entries in the position X=300 and Y=300 on the screen." +msgid "Yes" msgstr "" -#. AySnz -#: sf_popupmenu.xhp +#. droDW +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id711636493696169\n" +"sf_region.xhp\n" +"par_id831633021749018\n" "help.text" -msgid "The prefix SFWidgets can be suppressed while invoking the PopupMenu service." +msgid "Returns the name of the language, in English, of the specified region." msgstr "" -#. HnBew -#: sf_popupmenu.xhp +#. ojXGP +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id851635274721129\n" +"sf_region.xhp\n" +"par_id391600788076253\n" "help.text" -msgid "The following example defines a Sub that can be associated with a mouse event:" +msgid "Yes" msgstr "" -#. iZdDG -#: sf_popupmenu.xhp +#. a4SKv +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"bas_id721636488722999\n" +"sf_region.xhp\n" +"par_id21600788076541\n" "help.text" -msgid "' Populate popupmenu with items" +msgid "Returns the list separator used in the specified region." msgstr "" -#. Czn9U -#: sf_popupmenu.xhp +#. vUwhJ +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"bas_id311636488724795\n" +"sf_region.xhp\n" +"par_id561633021706513\n" "help.text" -msgid "' Do something based on vResponse" +msgid "Yes" msgstr "" -#. ChBWz -#: sf_popupmenu.xhp +#. 79WHE +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id991636718278125\n" +"sf_region.xhp\n" +"par_id201633021746335\n" "help.text" -msgid "Use the Dispose method to free resources after executing the popup menu." +msgid "String array" msgstr "" -#. K8FAQ -#: sf_popupmenu.xhp +#. Dz2X6 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id531636493797707\n" +"sf_region.xhp\n" +"par_id831633021741117\n" "help.text" -msgid "It is also possible to associate a popup menu with events triggered by %PRODUCTNAME applications, form and dialog controls. Events such as \"Mouse button pressed\" and \"Mouse button released\" are commonly associated with popup menus." +msgid "Returns a zero-based array of strings containing the list of abbreviated month names in the specified language." msgstr "" -#. L5Dhq -#: sf_popupmenu.xhp +#. NvQaB +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id131635275172617\n" +"sf_region.xhp\n" +"par_id211600788076138\n" "help.text" -msgid "The examples above can be written in Python as follows:" +msgid "Yes" msgstr "" -#. 6esys -#: sf_popupmenu.xhp +#. ZMsz8 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"pyc_id916367179574588\n" +"sf_region.xhp\n" +"par_id221600788076518\n" "help.text" -msgid "# Populate popupmenu with items" +msgid "String array" msgstr "" -#. Nj85P -#: sf_popupmenu.xhp +#. EbAXk +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"pyc_id851636718008427\n" +"sf_region.xhp\n" +"par_id521600788076371\n" "help.text" -msgid "# Do something based on response" +msgid "Returns a zero-based array of strings containing the list of month names in the specified language." msgstr "" -#. Bkw3n -#: sf_popupmenu.xhp +#. GeqFt +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"hd_id711600788076834\n" +"sf_region.xhp\n" +"par_id21600788076758\n" "help.text" -msgid "Properties" +msgid "Yes" msgstr "" -#. 7remQ -#: sf_popupmenu.xhp +#. wGD4y +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id461600788076917\n" +"sf_region.xhp\n" +"par_id871600788076196\n" "help.text" -msgid "Name" +msgid "String array" msgstr "" -#. zWaD9 -#: sf_popupmenu.xhp +#. RisPb +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id221600788076591\n" +"sf_region.xhp\n" +"par_id781600788076694\n" "help.text" -msgid "Readonly" +msgid "Returns a zero-based array of strings containing the list of the initials of month names in the specified language." msgstr "" -#. 3bRwD -#: sf_popupmenu.xhp +#. DBDyW +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id761600788076328\n" +"sf_region.xhp\n" +"par_id261600788076841\n" "help.text" -msgid "Type" +msgid "Yes" msgstr "" -#. yAUC9 -#: sf_popupmenu.xhp +#. fLZD2 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id67160078807636\n" +"sf_region.xhp\n" +"par_id116007880767507\n" "help.text" -msgid "Description" +msgid "Returns the thousands separator used in numbers in the specified region." msgstr "" -#. qnMK2 -#: sf_popupmenu.xhp +#. AUNfp +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id49160078807654\n" +"sf_region.xhp\n" +"par_id531600789141795\n" "help.text" -msgid "No" +msgid "Yes" msgstr "" -#. uERBN -#: sf_popupmenu.xhp +#. MjrCr +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id81600788076419\n" +"sf_region.xhp\n" +"par_id301600789141619\n" "help.text" -msgid "Character used to define the access key of a menu item. The default character is ~." +msgid "Returns the separator used to format times in the specified region." msgstr "" -#. G2c6G -#: sf_popupmenu.xhp +#. Bog4G +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id311600788076756\n" +"sf_region.xhp\n" +"par_id651606319520519\n" "help.text" -msgid "No" +msgid "List of Methods in the Region Service" msgstr "" -#. ScuiK -#: sf_popupmenu.xhp +#. szpDY +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id441600788076826\n" +"sf_region.xhp\n" +"par_id71621894830071\n" "help.text" -msgid "Character or string that defines how menu items are nested. The default character is >." +msgid "Computes the additional Daylight Saving Time (DST) offset, in minutes, that is applicable to a given region and timezone." msgstr "" -#. drBFS -#: sf_popupmenu.xhp +#. CbDHo +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"hd_id181636719707892\n" +"sf_region.xhp\n" +"par_id401621896675880\n" "help.text" -msgid "Menu and Submenus" +msgid "localdatetime: the local date and time expressed as a date." msgstr "" -#. XGwV6 -#: sf_popupmenu.xhp +#. cA2tD +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id741636719725402\n" +"sf_region.xhp\n" +"par_id401621896675125\n" "help.text" -msgid "To create a popup menu with submenus, use the character defined in the SubmenuCharacter property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy." +msgid "timezone: the timezone for which the offset will be calculated." msgstr "" -#. mB5ry -#: sf_popupmenu.xhp +#. LD3qm +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id211636720111489\n" +"sf_region.xhp\n" +"par_id401621896675963\n" "help.text" -msgid "The code below uses the default submenu character > to create the menu/submenu hierarchy defined above:" +msgid "locale: the locale specifying the country for which the offset will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." msgstr "" -#. K5oTC -#: sf_popupmenu.xhp +#. cBF4y +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id121636721243578\n" +"sf_region.xhp\n" +"bas_id531656022497519\n" "help.text" -msgid "The string --- is used to define separator lines in menus or submenus." +msgid "' Calculates the offset applicable in the \"America/Los_Angeles\" timezone" msgstr "" -#. nA7BW -#: sf_popupmenu.xhp +#. XYu4u +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"hd_id211636723438558\n" +"sf_region.xhp\n" +"bas_id801656022498143\n" "help.text" -msgid "Using icons" +msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 60 (minutes)" msgstr "" -#. UKLV5 -#: sf_popupmenu.xhp +#. CfiFK +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id981636723485402\n" +"sf_region.xhp\n" +"bas_id831656022498543\n" "help.text" -msgid "Items in the menu can have icons, which are specified as arguments in the AddCheckBox, AddItem and AddRadioButton methods." +msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 0 (minutes)" msgstr "" -#. TLDpD -#: sf_popupmenu.xhp +#. 4CkKJ +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id881636724112434\n" +"sf_region.xhp\n" +"pyc_id871621898933281\n" "help.text" -msgid "All icons available in %PRODUCTNAME can be used by specifying their path relative to the folder where icon files are located in the installation folder. Icons are located in the following folder:" +msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 60 (minutes)" msgstr "" -#. n2owj -#: sf_popupmenu.xhp +#. nkcRi +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id941636724808906\n" +"sf_region.xhp\n" +"pyc_id871621898934141\n" "help.text" -msgid "Use the InstallFolder property of the FileSystem service to determine where %PRODUCTNAME is installed in your system." +msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 0 (minutes)" msgstr "" -#. xbEsC -#: sf_popupmenu.xhp +#. BbUgj +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id201636724575911\n" +"sf_region.xhp\n" +"par_id71621894832058\n" "help.text" -msgid "This folder contains a series of ZIP files containing the image files of each available icon set. The images inside these ZIP files are organized into folders. To use an icon, specify the icon file with the path to its location inside the ZIP file." +msgid "Computes the local date and time from a UTC date and time." msgstr "" -#. 5yvv9 -#: sf_popupmenu.xhp +#. v4YSt +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id641636724972071\n" +"sf_region.xhp\n" +"par_id401621896674716\n" "help.text" -msgid "The example below uses the icon \"sc_newdoc.svg\" that is located inside the \"cmd\" folder. The forward slash \"/\" character is used as the path separator regardless of the operating system." +msgid "utcdatetime: the UTC date and time, expressed using a date object." msgstr "" -#. 2QW4m -#: sf_popupmenu.xhp +#. i63on +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id691636725233961\n" +"sf_region.xhp\n" +"par_id401621896675449\n" "help.text" -msgid "All icon sets have the same internal structure. The actual icon displayed depends on the icon set currently in use." +msgid "timezone: the timezone for which the local time will be calculated." msgstr "" -#. v6wRS -#: sf_popupmenu.xhp +#. tzvsE +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"hd_id501582887473754\n" +"sf_region.xhp\n" +"par_id401621896675193\n" "help.text" -msgid "Methods" +msgid "locale: the locale specifying the country for which the local time will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." msgstr "" -#. CWGtf -#: sf_popupmenu.xhp +#. 8UTFQ +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id891611613601554\n" +"sf_region.xhp\n" +"bas_id201656022497017\n" "help.text" -msgid "List of Methods in the PopupMenu Service" +msgid "' June 6th, 2022 at 10:30:45 (used here as UTC time)" msgstr "" -#. RAcsN -#: sf_popupmenu.xhp +#. Hcjqt +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id93158919969864\n" +"sf_region.xhp\n" +"bas_id531656022497121\n" "help.text" -msgid "Inserts a check box in the popup menu. Returns an integer value that identifies the inserted item." +msgid "' Calculates local time in Sao Paulo, Brazil" msgstr "" -#. ZZrDA -#: sf_popupmenu.xhp +#. yhKtd +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203996\n" +"sf_region.xhp\n" +"bas_id601656022498318\n" "help.text" -msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." +msgid "' June 6th, 2022 at 07:30:45" msgstr "" -#. riy7p -#: sf_popupmenu.xhp +#. YJv72 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203116\n" +"sf_region.xhp\n" +"par_id71621894832089\n" "help.text" -msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." +msgid "Converts numbers and monetary values into written text for any of the currently supported languages." msgstr "" -#. yxK8E -#: sf_popupmenu.xhp +#. CTtMf +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203133\n" +"sf_region.xhp\n" +"par_id971656026551328\n" "help.text" -msgid "status: Defines whether the item is selected when the menu is created (Default = False)." +msgid "For a list of all supported languages visit the XNumberText Interface API reference." msgstr "" -#. Q4ZNV -#: sf_popupmenu.xhp +#. xTUD6 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id11636721653313\n" +"sf_region.xhp\n" +"par_id401621896675306\n" "help.text" -msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." +msgid "number: the number to be converted into written text. It can be provided either as a numeric type or as a string. When a string is provided, it can be preceded by a prefix informing how the numbers should be written. It is also possible to include ISO 4217 currency codes. See examples below for more information." msgstr "" -#. dkqgP -#: sf_popupmenu.xhp +#. cNDim +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id11636721653208\n" +"sf_region.xhp\n" +"par_id401621896675412\n" "help.text" -msgid "tooltip: Text to be displayed as tooltip." +msgid "locale: the locale defining the language into which the number will be converted to, given either in \"la-CO\" or \"la\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." msgstr "" -#. NEE76 -#: sf_popupmenu.xhp +#. QeBpA +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id93158919963364\n" +"sf_region.xhp\n" +"bas_id301656027173020\n" "help.text" -msgid "Inserts a menu entry in the popup menu. Returns an integer value that identifies the inserted item." +msgid "' Returns \"one hundred five\"" msgstr "" -#. vdtEn -#: sf_popupmenu.xhp +#. 7xovc +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203021\n" +"sf_region.xhp\n" +"bas_id531656022496631\n" "help.text" -msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." +msgid "numText = oRegion.Number2Text(105, \"en-US\")" msgstr "" -#. 8eE5y -#: sf_popupmenu.xhp +#. UGGvv +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203026\n" +"sf_region.xhp\n" +"bas_id771656027217144\n" "help.text" -msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." +msgid "' Returns: \"two point four two\"" msgstr "" -#. F646F -#: sf_popupmenu.xhp +#. Xr7no +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id11636721652886\n" +"sf_region.xhp\n" +"bas_id201656022493367\n" "help.text" -msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." +msgid "numText = oRegion.Number2Text(2.42, \"en-US\")" msgstr "" -#. XFkGB -#: sf_popupmenu.xhp +#. 7hYbk +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id11636721653118\n" +"sf_region.xhp\n" +"bas_id281656027262234\n" "help.text" -msgid "tooltip: Text to be displayed as tooltip." +msgid "' Returns: \"twenty-five euro and ten cents\" Notice the \"EUR\" currency symbol" msgstr "" -#. dJTZs -#: sf_popupmenu.xhp +#. DBPc8 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"bas_id41158919969106\n" +"sf_region.xhp\n" +"bas_id201656022497171\n" "help.text" -msgid "myPopup.AddItem(\"Item A\", Tooltip := \"A descriptive message\")" +msgid "numText = oRegion.Number2Text(\"EUR 25.10\", \"en-US\")" msgstr "" -#. VDLFK -#: sf_popupmenu.xhp +#. pd3Fm +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"pyc_id321621534170554\n" +"sf_region.xhp\n" +"bas_id981656027330132\n" "help.text" -msgid "my_popup.AddItem(\"Item A\", tooltip = \"A descriptive message\")" +msgid "' Returns: \"fifteenth\"; Notice the \"ordinal\" prefix" msgstr "" -#. U2vBb -#: sf_popupmenu.xhp +#. ggt2A +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id93158919969399\n" +"sf_region.xhp\n" +"bas_id841656027330394\n" "help.text" -msgid "Inserts a radio button entry in the popup menu. Returns an integer value that identifies the inserted item." +msgid "numText = oRegion.Number2Text(\"ordinal 15\", \"en-US\")" msgstr "" -#. 92F32 -#: sf_popupmenu.xhp +#. YQCCF +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203501\n" +"sf_region.xhp\n" +"pyc_id401656027481473\n" "help.text" -msgid "menuitem: Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character." +msgid "numText = oRegion.Number2Text(105, \"en-US\")" msgstr "" -#. 2PuBE -#: sf_popupmenu.xhp +#. FTGnF +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631228716\n" +"sf_region.xhp\n" +"pyc_id781656027481769\n" "help.text" -msgid "name: String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used." +msgid "numText = oRegion.Number2Text(2.42, \"en-US\")" msgstr "" -#. yLvRM -#: sf_popupmenu.xhp +#. RCDq5 +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631203643\n" +"sf_region.xhp\n" +"pyc_id951656027482096\n" "help.text" -msgid "status: Defines whether the item is selected when the menu is created (Default = False)." +msgid "numText = oRegion.Number2Text(\"EUR 25.10\", \"en-US\")" msgstr "" -#. 6XiD7 -#: sf_popupmenu.xhp +#. vtGFv +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id11636721653228\n" +"sf_region.xhp\n" +"pyc_id231656027482425\n" "help.text" -msgid "icon: Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used." +msgid "numText = oRegion.Number2Text(\"ordinal 15\", \"en-US\")" msgstr "" -#. cRTRD -#: sf_popupmenu.xhp +#. 3T93o +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id11636721653114\n" +"sf_region.xhp\n" +"par_id801656027524051\n" "help.text" -msgid "tooltip: Text to be displayed as tooltip." +msgid "To get a list of all supported prefixes in a given language, call Number2Text with the special \"help\" argument. In the example below, assume your locale is set to \"en-US\", then the list of available prefixes for \"en-US\" will be shown by MsgBox:" msgstr "" -#. nQrD3 -#: sf_popupmenu.xhp +#. RBkxp +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id93158919963279\n" +"sf_region.xhp\n" +"par_id781656027840633\n" "help.text" -msgid "Displays the popup menu and waits for a user action. Returns the item clicked by the user." +msgid "The first line in the message box does not have a prefix, which means that it is the standard format. The subsequent lines include the prefix and some examples of numbers using its format." msgstr "" -#. qwwKx -#: sf_popupmenu.xhp +#. WYDkd +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id101636726249788\n" +"sf_region.xhp\n" +"par_id781656028528520\n" "help.text" -msgid "If the user clicks outside the popup menu or presses the Esc key, then no item is selected. In such cases, the returned value depends on the returnid parameter. If returnid = True and no item is selected, then the value 0 (zero) is returned. Otherwise an empty string \"\" is returned." +msgid "Each language has its own set of supported prefixes. The number of available prefixes may vary from language to language." msgstr "" -#. EFriZ -#: sf_popupmenu.xhp +#. gcMPN +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id821591631202088\n" +"sf_region.xhp\n" +"par_id531663849363398\n" "help.text" -msgid "returnid: If True the selected item ID is returned. If False the method returns the item's name (Default = True)." +msgid "To get the list of prefixes for a specific language or locale, it can be specified as the second argument in Number2Text. The example below shows the available prefixes available for the \"pt-BR\" locale:" msgstr "" -#. y4PWP -#: sf_popupmenu.xhp +#. dShiA +#: sf_region.xhp msgctxt "" -"sf_popupmenu.xhp\n" -"par_id51636726671698\n" +"sf_region.xhp\n" +"par_id71621894832117\n" "help.text" -msgid "In the examples below, a popup menu is created and the item's name is returned because the returnid argument is set to False." +msgid "Returns the offset between GMT and the given timezone and locale, in minutes." msgstr "" -#. b8bDr +#. xCAjE #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"tit\n" +"par_id401621896675018\n" "help.text" -msgid "ScriptForge.Region service" +msgid "timezone: the timezone for which the offset to the GMT will be calculated." msgstr "" -#. H7HZZ +#. XuX3E #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"bm_id681600788076499\n" +"par_id401621896675691\n" "help.text" -msgid "ScriptForge.Region service" +msgid "locale: the locale specifying the country for which the offset will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." msgstr "" -#. w3WgP +#. JiFjE #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id181600788076612\n" +"par_id71621894864217\n" "help.text" -msgid "The Region service provides a collection of properties and methods to handle locale and region-related aspects of programming, such as:" +msgid "Returns the UTC date and time considering a given local date and time in a timezone." msgstr "" -#. TEk7a +#. AK3nQ #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id301600788076785\n" +"par_id401621896674748\n" "help.text" -msgid "Accessing locale and region-dependent settings such as number formatting, currency and timezones." +msgid "localdatetime: the local date and time in a specific timezone expressed as a date." msgstr "" -#. 2f7KC +#. hpxBF #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id1001600788076848\n" +"par_id401621896675739\n" "help.text" -msgid "Converting timezones and calculate Daylight Saving Time (DST) offsets." +msgid "timezone: the timezone for which the localdatetime argument was given." msgstr "" -#. tqznj +#. zSttY #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id67160078807676\n" +"par_id401621896675550\n" "help.text" -msgid "Transforming numbers into text in any supported language." +msgid "locale: the locale specifying the country for which the localdatetime argument was given, expressed either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." msgstr "" -#. 9nRv7 +#. y3NSm #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"hd_id851656012844548\n" +"bas_id861656077547861\n" "help.text" -msgid "Definitions" +msgid "' Date/Time in Berlin, June 23, 2022 at 14:30:00" msgstr "" -#. sGNu7 +#. HjSnk #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"hd_id421656012886648\n" +"bas_id731656077523173\n" "help.text" -msgid "Locale or Region" +msgid "' The UTC date/time is June 23, 2022 at 12:30:00" msgstr "" -#. FiW7z +#. tZoWt #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id191656012908838\n" +"par_id71621894835287\n" "help.text" -msgid "A string combining a language and a country in the format \"la-CO\". The language part is expressed with 2 or 3 lowercase characters followed by a dash and 2 uppercase characters representing the country." +msgid "Returns the current UTC date and time, given a timezone and locale." msgstr "" -#. GQEGW +#. zzSQA #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id431656013368415\n" +"par_id491656078254442\n" "help.text" -msgid "For instance, \"en-US\" corresponds to the English language in the United States; \"fr-BE\" corresponds to the French language in Belgium, and so forth." +msgid "This method uses the current date and time of your operating system to calculate the UTC time." msgstr "" -#. CQYAX +#. XxBE8 #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id981656013623018\n" +"par_id401621896673318\n" "help.text" -msgid "On some situations the full locale is not required and only the language or country may be specified." +msgid "timezone: the timezone for which the current UTC time will be calculated." msgstr "" -#. ujAAt +#. BHESq #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id261656013132204\n" +"par_id401621896674831\n" "help.text" -msgid "Most properties and methods accept a locale as argument. If no locale is specified, then the user-interface locale is used, which is defined in the OfficeLocale property of the Platform service." +msgid "locale: the locale specifying the country for which the current UTC time will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." msgstr "" -#. 6ToTC +#. FWSJp #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"hd_id51656013825718\n" +"bas_id861656078128374\n" "help.text" -msgid "Timezone" +msgid "' Suppose the operating system time is June 23rd, 2022 at 10:42:00" msgstr "" -#. GGBdC +#. CWY76 #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id541656013854150\n" +"bas_id691656078180784\n" "help.text" -msgid "A string in the format \"Region/City\" such as \"Europe/Berlin\", or a timezone ID such as \"UTC\" or \"GMT-8:00\". Refer to the wiki page List of tz database timezones for a list of possible timezone names and IDs." +msgid "' If the computer is in Europe/Berlin, then UTC time is June 23rd, 2022 at 08:42:00" msgstr "" -#. exa3B +#. NPVe5 #: sf_region.xhp msgctxt "" "sf_region.xhp\n" -"par_id981656078937577\n" +"pyc_id821656078645252\n" "help.text" -msgid "Providing an invalid timezone string to any of the methods in the Region service will not result in a runtime error. Instead, methods as UTCDateTime and UTCNow will return the current operating system date and time." +msgid "utcTime = oRegion.UTCNow(\"Europe/Berlin\", \"DE\")" msgstr "" -#. 7GTLU -#: sf_region.xhp +#. GpvmN +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id611656014040098\n" +"sf_services.xhp\n" +"tit\n" "help.text" -msgid "The time offset between the timezone and the Greenwich Meridian Time (GMT) is expressed in minutes." +msgid "ScriptForge.Services service" msgstr "" -#. ottwV -#: sf_region.xhp +#. Q5KAY +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id121656014053670\n" +"sf_services.xhp\n" +"hd_id471582710868716\n" "help.text" -msgid "The Daylight Saving Time (DST) is an additional offset." +msgid "ScriptForge.Services service" msgstr "" -#. yXHrp -#: sf_region.xhp +#. SDbDJ +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id591656014140929\n" +"sf_services.xhp\n" +"par_id241627513489594\n" "help.text" -msgid "The timezone and DST offsets may be positive or negative." +msgid "The main purpose of the Services module is to provide access to the CreateScriptService method, which can be called in user scripts to instantiate services that are implemented using the ScriptForge framework." msgstr "" -#. EyNvN -#: sf_region.xhp +#. 7B2KJ +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"hd_id281600788076359\n" +"sf_services.xhp\n" +"par_id351582710868545\n" "help.text" -msgid "Service invocation" +msgid "In ScriptForge terminology a service is a collection of methods and properties that can be used for a common purpose. For example, the String service provides methods for manipulating strings whereas the FileSystem service allows for the manipulation of files and folders." msgstr "" -#. F9Wnj -#: sf_region.xhp +#. NW4BS +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id141609955500101\n" +"sf_services.xhp\n" +"par_id541627513771828\n" "help.text" -msgid "Before using the Region service the ScriptForge library needs to be loaded or imported:" +msgid "The Services module of the ScriptForge library provides additional methods that are used either internally to register available services or by developers who are interested in extending ScriptForge by creating new services. The only method that is relevant for user scripts is CreateScriptService." msgstr "" -#. 7AXFZ -#: sf_region.xhp +#. FW4FC +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id321614902851541\n" +"sf_services.xhp\n" +"par_id871582714020043\n" "help.text" -msgid "The examples below in Basic and Python instantiate the Region service and access the Country property." +msgid "This method is used to instantiate a ScriptForge service so it can be called in user scripts." msgstr "" -#. 69CF7 -#: sf_region.xhp +#. jG6U9 +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id791600788431935\n" +"sf_services.xhp\n" +"par_id711627514310039\n" "help.text" -msgid "MsgBox oRegion.Country(\"en-US\") ' United States" +msgid "The returned value is a Basic object or Nothing if an error occurred." msgstr "" -#. FDNKL -#: sf_region.xhp +#. oojMF +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"hd_id711600788076834\n" +"sf_services.xhp\n" +"par_id971582714020045\n" "help.text" -msgid "Properties" +msgid "service: The name of the service identified as a string in the format \"library.service\":" msgstr "" -#. VEB3D -#: sf_region.xhp +#. swGGN +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id601656018689690\n" +"sf_services.xhp\n" +"par_id11627475954271\n" "help.text" -msgid "All properties listed below accept a locale argument, provided as a string. Some properties require this argument to be in the format \"la-CO\", whereas others may receive \"la\" or \"CO\" as input." +msgid "The library is a Basic library that must exist in the GlobalScope. The default value is \"ScriptForge\"." msgstr "" -#. vzB4T -#: sf_region.xhp +#. BBFeA +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id461600788076917\n" +"sf_services.xhp\n" +"par_id811627475954641\n" "help.text" -msgid "Name" +msgid "The service is one of the services registered by the ScriptForge library." msgstr "" -#. ay9iH -#: sf_region.xhp +#. btbtw +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id221600788076591\n" +"sf_services.xhp\n" +"par_id391582714020045\n" "help.text" -msgid "Readonly" +msgid "arg0, ...: A list of arguments required by the invoked service." msgstr "" -#. rBUEm -#: sf_region.xhp +#. yAaks +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id761600788076328\n" +"sf_services.xhp\n" +"par_id841627475900817\n" "help.text" -msgid "Type" +msgid "If the first argument refers to an event manager, then arg0 is mandatory and must be the UNO object representing the event provided as argument to the user macro." msgstr "" -#. FpD5h -#: sf_region.xhp +#. wuR7S +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id131656330679679\n" +"sf_services.xhp\n" +"bas_id981582898174133\n" "help.text" -msgid "Locale" +msgid "' To be done once" msgstr "" -#. FxnFK -#: sf_region.xhp +#. oqovE +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id67160078807636\n" +"sf_services.xhp\n" +"bas_id311582715700844\n" "help.text" -msgid "Description" +msgid "' Refers to the \"ScriptForge.Array\" service or SF_Array" msgstr "" -#. 4Ss2G -#: sf_region.xhp +#. KvcPo +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id311600788076756\n" +"sf_services.xhp\n" +"bas_id61582715759468\n" "help.text" -msgid "Yes" +msgid "' Returns a new empty dictionary class instance; \"ScriptForge.\" is optional" msgstr "" -#. ExbtG -#: sf_region.xhp +#. pMGcR +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id441600788076826\n" +"sf_services.xhp\n" +"bas_id901582715797722\n" "help.text" -msgid "Returns the country name in English corresponding to a given region." +msgid "' Refers to the Calc service, implemented in the associated SFDocuments library" msgstr "" -#. FN4XC -#: sf_region.xhp +#. BoXHx +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id49160078807654\n" +"sf_services.xhp\n" +"bas_id361582715845747\n" "help.text" -msgid "Yes" +msgid "' Returns a Timer class instance starting immediately" msgstr "" -#. vpDwN -#: sf_region.xhp +#. 9bmdn +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id81600788076419\n" +"sf_services.xhp\n" +"bas_id571596298708062\n" "help.text" -msgid "Returns the ISO 4217 currency code of the specified region." +msgid "' Refers to the DocumentEvent service implemented in the associated SFDocuments library" msgstr "" -#. Aqcuy -#: sf_region.xhp +#. DFhat +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id711600788076534\n" +"sf_services.xhp\n" +"bas_id121613492254532\n" "help.text" -msgid "Yes" +msgid "' Returns the instance of the Document class that fired the event" msgstr "" -#. 6cgk7 -#: sf_region.xhp +#. zhCyY +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id911600788076842\n" +"sf_services.xhp\n" +"par_id321627570607194\n" "help.text" -msgid "String array" +msgid "Python scripts support keyword arguments when calling CreateScriptService. The following example illustrates this concept by instantiating the Timer and Document services using keyword arguments." msgstr "" -#. Jhkc3 -#: sf_region.xhp +#. jah7F +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id541600788076645\n" +"sf_services.xhp\n" +"par_id901627576693156\n" "help.text" -msgid "Returns a zero-based array of strings containing the date acceptance patterns for the specified region." +msgid "To make writing Python scripts more fluid, ScriptForge provides the Basic service which allows Python scripts to call a collection of methods with the same syntax and meaning as their homonymous native Basic functions." msgstr "" -#. T4sUQ -#: sf_region.xhp +#. SDQ7m +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id891600788076190\n" +"sf_services.xhp\n" +"par_id41627644806288\n" "help.text" -msgid "Yes" +msgid "The following example instantiates the Basic service and calls the MsgBox method, which is equivalent to the MsgBox function available in Basic:" msgstr "" -#. vAJYH -#: sf_region.xhp +#. TFMGE +#: sf_services.xhp msgctxt "" -"sf_region.xhp\n" -"par_id91600788076674\n" +"sf_services.xhp\n" +"par_id581627645023307\n" "help.text" -msgid "Returns the date separator used in the given region." +msgid "Be aware that the Basic service has to be instantiated in Python scripts using the CreateScriptService method." msgstr "" -#. QKyGp -#: sf_region.xhp +#. LCVem +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id561633021747014\n" +"sf_session.xhp\n" +"tit\n" "help.text" -msgid "Yes" +msgid "ScriptForge.Session service" msgstr "" -#. jSVY8 -#: sf_region.xhp +#. yWao7 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id201633021748566\n" +"sf_session.xhp\n" +"hd_id901582814720985\n" "help.text" -msgid "String array" +msgid "ScriptForge.Session service" msgstr "" -#. CnTuU -#: sf_region.xhp +#. yTgFK +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id831633021745014\n" +"sf_session.xhp\n" +"par_id861582814720987\n" "help.text" -msgid "Returns a zero-based array of strings containing the list of abbreviated weekday names in the specified language." +msgid "The Session service gathers various general-purpose methods about:" msgstr "" -#. jRUnx -#: sf_region.xhp +#. a2DCM +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id561633021747209\n" +"sf_session.xhp\n" +"par_id34158281472051\n" "help.text" -msgid "Yes" +msgid "the installation or execution environment" msgstr "" -#. CGeKU -#: sf_region.xhp +#. cf5WG +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id201633021748322\n" +"sf_session.xhp\n" +"par_id411582814720361\n" "help.text" -msgid "String array" +msgid "UNO introspection" msgstr "" -#. tjGhP -#: sf_region.xhp +#. fBApv +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id831633021748865\n" +"sf_session.xhp\n" +"par_id321582814720863\n" "help.text" -msgid "Returns a zero-based array of strings containing the list of weekday names in the specified language." +msgid "the invocation of external scripts or programs" msgstr "" -#. gVevH -#: sf_region.xhp +#. 63uDb +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id561633021747903\n" +"sf_session.xhp\n" +"hd_id91582814720116\n" "help.text" -msgid "Yes" +msgid "Service invocation" msgstr "" -#. hL4sb -#: sf_region.xhp +#. XRvpV +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id201633021748455\n" +"sf_session.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "String array" +msgid "Before using the Session service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. GHdGz -#: sf_region.xhp +#. 8BEnm +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id831633021747711\n" +"sf_session.xhp\n" +"hd_id291582814720762\n" "help.text" -msgid "Returns a zero-based array of strings containing the list of the initials of weekday names in the specified language." +msgid "Constants" msgstr "" -#. TFzKG -#: sf_region.xhp +#. zcRQu +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id561633021748013\n" +"sf_session.xhp\n" +"par_id82158281472034\n" "help.text" -msgid "Yes" +msgid "Below is a list of constants available to ease the designation of the library containing a Basic or Python script to invoke. Use them as session.CONSTANT." msgstr "" -#. CWLzi -#: sf_region.xhp +#. yyF2R +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id831633021749297\n" +"sf_session.xhp\n" +"par_id9158281472045\n" "help.text" -msgid "Returns the decimal separator used in numbers in the specified region." +msgid "Value" msgstr "" -#. pqWDC -#: sf_region.xhp +#. Wd88w +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id561633021743188\n" +"sf_session.xhp\n" +"par_id241582814720636\n" "help.text" -msgid "Yes" +msgid "Where to find the library?" msgstr "" -#. droDW -#: sf_region.xhp +#. k58kN +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id831633021749018\n" +"sf_session.xhp\n" +"par_id361582814720116\n" "help.text" -msgid "Returns the name of the language, in English, of the specified region." +msgid "Applicable" msgstr "" -#. ojXGP -#: sf_region.xhp +#. DJspw +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id391600788076253\n" +"sf_session.xhp\n" +"par_id451582814720105\n" "help.text" -msgid "Yes" +msgid "in the document" msgstr "" -#. a4SKv -#: sf_region.xhp +#. Q2KtM +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id21600788076541\n" +"sf_session.xhp\n" +"par_id73158281472032\n" "help.text" -msgid "Returns the list separator used in the specified region." +msgid "in any shared library" msgstr "" -#. vUwhJ -#: sf_region.xhp +#. 2GN3X +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id561633021706513\n" +"sf_session.xhp\n" +"par_id391582814720487\n" "help.text" -msgid "Yes" +msgid "in My Macros" msgstr "" -#. 79WHE -#: sf_region.xhp +#. MiuWT +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id201633021746335\n" +"sf_session.xhp\n" +"par_id56158281472073\n" "help.text" -msgid "String array" +msgid "in an extension installed for the current user" msgstr "" -#. Dz2X6 -#: sf_region.xhp +#. MfbpF +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id831633021741117\n" +"sf_session.xhp\n" +"par_id21582814720997\n" "help.text" -msgid "Returns a zero-based array of strings containing the list of abbreviated month names in the specified language." +msgid "in Application Macros" msgstr "" -#. NvQaB -#: sf_region.xhp +#. LnKrt +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id211600788076138\n" +"sf_session.xhp\n" +"par_id981582814720125\n" "help.text" -msgid "Yes" +msgid "in an extension installed for all users" msgstr "" -#. ZMsz8 -#: sf_region.xhp +#. gCi9j +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id221600788076518\n" +"sf_session.xhp\n" +"par_id93158281472047\n" "help.text" -msgid "String array" +msgid "in an extension but the installation parameters are unknown" msgstr "" -#. EbAXk -#: sf_region.xhp +#. mLURi +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id521600788076371\n" +"sf_session.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "Returns a zero-based array of strings containing the list of month names in the specified language." +msgid "List of Methods in the Session Service" msgstr "" -#. GeqFt -#: sf_region.xhp +#. JvBuZ +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id21600788076758\n" +"sf_session.xhp\n" +"par_id491613061572993\n" "help.text" -msgid "Yes" +msgid "Execute... methods in Session service behave as follows:
Arguments are passed by value. Changes made by the called function to the arguments do not update their values in the calling script.
A single value or an array of values is returned to the calling script." msgstr "" -#. wGD4y -#: sf_region.xhp +#. ALw6M +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id871600788076196\n" +"sf_session.xhp\n" +"par_id451582815407230\n" "help.text" -msgid "String array" +msgid "Execute the BASIC script given its name and location, and fetch its result, if any." msgstr "" -#. RisPb -#: sf_region.xhp +#. yFnSG +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id781600788076694\n" +"sf_session.xhp\n" +"par_id921600856780901\n" "help.text" -msgid "Returns a zero-based array of strings containing the list of the initials of month names in the specified language." +msgid "If the script returns nothing, which is the case of procedures defined with Sub, the returned value is Empty." msgstr "" -#. DBDyW -#: sf_region.xhp +#. VTyCE +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id261600788076841\n" +"sf_session.xhp\n" +"par_id631582815407231\n" "help.text" -msgid "Yes" +msgid "scope: String specifying where the script is stored. It can be either \"document\" (constant session.SCRIPTISEMBEDDED) or \"application\" (constant session.SCRIPTISAPPLICATION)." msgstr "" -#. fLZD2 -#: sf_region.xhp +#. SCCpE +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id116007880767507\n" +"sf_session.xhp\n" +"par_id691582815407231\n" "help.text" -msgid "Returns the thousands separator used in numbers in the specified region." +msgid "script: String specifying the script to be called in the format \"library.module.method\" as a case-sensitive string." msgstr "" -#. AUNfp -#: sf_region.xhp +#. hS5x4 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id531600789141795\n" +"sf_session.xhp\n" +"par_id741626828862265\n" "help.text" -msgid "Yes" +msgid "The library is loaded in memory if necessary." msgstr "" -#. MjrCr -#: sf_region.xhp +#. D8AL6 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id301600789141619\n" +"sf_session.xhp\n" +"par_id981626828863001\n" "help.text" -msgid "Returns the separator used to format times in the specified region." +msgid "The module must not be a class module." msgstr "" -#. Bog4G -#: sf_region.xhp +#. VsUFD +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id651606319520519\n" +"sf_session.xhp\n" +"par_id721626828863257\n" "help.text" -msgid "List of Methods in the Region Service" +msgid "The method may be a Sub or a Function." msgstr "" -#. szpDY -#: sf_region.xhp +#. eExjm +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id71621894830071\n" +"sf_session.xhp\n" +"par_id881582815407231\n" "help.text" -msgid "Computes the additional Daylight Saving Time (DST) offset, in minutes, that is applicable to a given region and timezone." +msgid "args: The arguments to be passed to the called script." msgstr "" -#. CbDHo -#: sf_region.xhp +#. mg5WG +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675880\n" +"sf_session.xhp\n" +"par_id21626809513802\n" "help.text" -msgid "localdatetime: the local date and time expressed as a date." +msgid "Consider the following Basic function named DummyFunction that is stored in \"My Macros\" in the \"Standard\" library inside a module named \"Module1\"." msgstr "" -#. cA2tD -#: sf_region.xhp +#. PMyrB +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675125\n" +"sf_session.xhp\n" +"par_id551626810319766\n" "help.text" -msgid "timezone: the timezone for which the offset will be calculated." +msgid "The function simply takes in two integer values v1 and v2 and return the sum of all values starting in v1 and ending in v2." msgstr "" -#. LD3qm -#: sf_region.xhp +#. Gx6fV +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675963\n" +"sf_session.xhp\n" +"par_id461626810470057\n" "help.text" -msgid "locale: the locale specifying the country for which the offset will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." +msgid "The examples below show how to call DummyFunction from within Basic and Python scripts." msgstr "" -#. cBF4y -#: sf_region.xhp +#. uCzZs +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id531656022497519\n" +"sf_session.xhp\n" +"par_id111582816585181\n" "help.text" -msgid "' Calculates the offset applicable in the \"America/Los_Angeles\" timezone" +msgid "Execute a Calc function using its English name and based on the given arguments.
If the arguments are arrays, the function is executed as an array formula." msgstr "" -#. XYu4u -#: sf_region.xhp +#. EDU9x +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id801656022498143\n" +"sf_session.xhp\n" +"par_id771582816585183\n" "help.text" -msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 60 (minutes)" +msgid "calcfunction: The name of the Calc function to be called, in English." msgstr "" -#. CfiFK -#: sf_region.xhp +#. FJJJh +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id831656022498543\n" +"sf_session.xhp\n" +"par_id371582816585183\n" "help.text" -msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 0 (minutes)" +msgid "args: The arguments to be passed to the called Calc function. Each argument must be either a string, a numeric value or an array of arrays combining those types." msgstr "" -#. 4CkKJ -#: sf_region.xhp +#. XMfUD +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id871621898933281\n" +"sf_session.xhp\n" +"bas_id881582816585185\n" "help.text" -msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 60 (minutes)" +msgid "' Generates an error." msgstr "" -#. nkcRi -#: sf_region.xhp +#. ygESx +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id871621898934141\n" +"sf_session.xhp\n" +"par_id571582818023245\n" "help.text" -msgid "offset = oRegion.DSTOffset(aDateTime, \"America/Los_Angeles\", \"US\") ' 0 (minutes)" +msgid "Execute the Python script given its location and name, fetch its result if any. Result can be a single value or an array of values." msgstr "" -#. BbUgj -#: sf_region.xhp +#. SB2gx +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id71621894832058\n" +"sf_session.xhp\n" +"par_id71600856817410\n" "help.text" -msgid "Computes the local date and time from a UTC date and time." +msgid "If the script is not found, or if it returns nothing, the returned value is Empty." msgstr "" -#. v4YSt -#: sf_region.xhp +#. 4WTUK +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896674716\n" +"sf_session.xhp\n" +"par_id791582818023246\n" "help.text" -msgid "utcdatetime: the UTC date and time, expressed using a date object." +msgid "scope: One of the applicable constants listed above. The default value is session.SCRIPTISSHARED." msgstr "" -#. i63on -#: sf_region.xhp +#. ELfda +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675449\n" +"sf_session.xhp\n" +"par_id71582818023247\n" "help.text" -msgid "timezone: the timezone for which the local time will be calculated." +msgid "script: Either \"library/module.py$method\" or \"module.py$method\" or \"myExtension.oxt|myScript|module.py$method\" as a case-sensitive string." msgstr "" -#. tzvsE -#: sf_region.xhp +#. P6ZKD +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675193\n" +"sf_session.xhp\n" +"par_id501613061041313\n" "help.text" -msgid "locale: the locale specifying the country for which the local time will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." +msgid "library: The folder path to the Python module." msgstr "" -#. 8UTFQ -#: sf_region.xhp +#. ktFHu +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id201656022497017\n" +"sf_session.xhp\n" +"par_id771613061043097\n" "help.text" -msgid "' June 6th, 2022 at 10:30:45 (used here as UTC time)" +msgid "myScript: The folder containing the Python module." msgstr "" -#. Hcjqt -#: sf_region.xhp +#. ANBoy +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id531656022497121\n" +"sf_session.xhp\n" +"par_id301613061123849\n" "help.text" -msgid "' Calculates local time in Sao Paulo, Brazil" +msgid "module.py: The Python module." msgstr "" -#. yhKtd -#: sf_region.xhp +#. f4B8C +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id601656022498318\n" +"sf_session.xhp\n" +"par_id241613061044560\n" "help.text" -msgid "' June 6th, 2022 at 07:30:45" +msgid "method: The Python function." msgstr "" -#. YJv72 -#: sf_region.xhp +#. ByFdE +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id71621894832089\n" +"sf_session.xhp\n" +"par_id711582818023247\n" "help.text" -msgid "Converts numbers and monetary values into written text for any of the currently supported languages." +msgid "args: The arguments to be passed to the called script." msgstr "" -#. CTtMf -#: sf_region.xhp +#. ckvXs +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id971656026551328\n" +"sf_session.xhp\n" +"par_id701626817164878\n" "help.text" -msgid "For a list of all supported languages visit the XNumberText Interface API reference." +msgid "Consider the Python function odd_integers defined below that creates a list with odd integer values between v1 and v2. Suppose this function is stored in a file named my_macros.py in your user scripts folder." msgstr "" -#. xTUD6 -#: sf_region.xhp +#. HWGRK +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675306\n" +"sf_session.xhp\n" +"par_id751626817335715\n" "help.text" -msgid "number: the number to be converted into written text. It can be provided either as a numeric type or as a string. When a string is provided, it can be preceded by a prefix informing how the numbers should be written. It is also possible to include ISO 4217 currency codes. See examples below for more information." +msgid "Read the help page Python Scripts Organization and Location to learn more about where Python scripts can be stored." msgstr "" -#. cNDim -#: sf_region.xhp +#. vqBm9 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675412\n" +"sf_session.xhp\n" +"par_id121626817725471\n" "help.text" -msgid "locale: the locale defining the language into which the number will be converted to, given either in \"la-CO\" or \"la\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." +msgid "The following examples show how to call the function odd_integers from within Basic and Python scripts." msgstr "" -#. QeBpA -#: sf_region.xhp +#. pbmij +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id301656027173020\n" +"sf_session.xhp\n" +"par_id111582816585087\n" "help.text" -msgid "' Returns \"one hundred five\"" +msgid "Returns the current PDF export settings defined in the PDF Options dialog, which can be accessed by choosing File - Export as - Export as PDF." msgstr "" -#. 7xovc -#: sf_region.xhp +#. K7j2q +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id531656022496631\n" +"sf_session.xhp\n" +"par_id931638383270026\n" "help.text" -msgid "numText = oRegion.Number2Text(105, \"en-US\")" +msgid "Export options set with the PDF Options dialog are kept for future use. Hence GetPDFExportOptions returns the settings currently defined. In addition, use SetPDFExportOptions to change current PDF export options." msgstr "" -#. UGGvv -#: sf_region.xhp +#. uFCEq +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id771656027217144\n" +"sf_session.xhp\n" +"par_id801638383659558\n" "help.text" -msgid "' Returns: \"two point four two\"" +msgid "This method returns a Dictionary object wherein each key represent export options and the corresponding values are the current PDF export settings." msgstr "" -#. Xr7no -#: sf_region.xhp +#. GCDTK +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id201656022493367\n" +"sf_session.xhp\n" +"par_id751638383457198\n" "help.text" -msgid "numText = oRegion.Number2Text(2.42, \"en-US\")" +msgid "Read the PDF Export wiki page to learn more about all available options." msgstr "" -#. 7hYbk -#: sf_region.xhp +#. Lv4iA +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id281656027262234\n" +"sf_session.xhp\n" +"par_id111587477335982\n" "help.text" -msgid "' Returns: \"twenty-five euro and ten cents\" Notice the \"EUR\" currency symbol" +msgid "Returns True if an UNO object contains the given method. Returns False when the method is not found or when an argument is invalid." msgstr "" -#. DBPc8 -#: sf_region.xhp +#. HAw32 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id201656022497171\n" +"sf_session.xhp\n" +"par_id921587477335673\n" "help.text" -msgid "numText = oRegion.Number2Text(\"EUR 25.10\", \"en-US\")" +msgid "unoobject: The object to inspect." msgstr "" -#. pd3Fm -#: sf_region.xhp +#. DDw6g +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id981656027330132\n" +"sf_session.xhp\n" +"par_id631587477566016\n" "help.text" -msgid "' Returns: \"fifteenth\"; Notice the \"ordinal\" prefix" +msgid "methodname: the method as a case-sensitive string" msgstr "" -#. ggt2A -#: sf_region.xhp +#. gDBRB +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id841656027330394\n" +"sf_session.xhp\n" +"par_id191587477832959\n" "help.text" -msgid "numText = oRegion.Number2Text(\"ordinal 15\", \"en-US\")" +msgid "Returns True if a UNO object has the given property. Returns False when the property is not found or when an argument is invalid." msgstr "" -#. YQCCF -#: sf_region.xhp +#. 54oXs +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id401656027481473\n" +"sf_session.xhp\n" +"par_id121587477832805\n" "help.text" -msgid "numText = oRegion.Number2Text(105, \"en-US\")" +msgid "unoobject: The object to inspect." msgstr "" -#. FTGnF -#: sf_region.xhp +#. hCTCk +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id781656027481769\n" +"sf_session.xhp\n" +"par_id701587477832750\n" "help.text" -msgid "numText = oRegion.Number2Text(2.42, \"en-US\")" +msgid "propertyname: the property as a case-sensitive string" msgstr "" -#. RCDq5 -#: sf_region.xhp +#. 75Rh4 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id951656027482096\n" +"sf_session.xhp\n" +"par_id97160112964017\n" "help.text" -msgid "numText = oRegion.Number2Text(\"EUR 25.10\", \"en-US\")" +msgid "Open a Uniform Resource Locator (URL) in the default browser." msgstr "" -#. vtGFv -#: sf_region.xhp +#. 4tFWV +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id231656027482425\n" +"sf_session.xhp\n" +"par_id241601129640549\n" "help.text" -msgid "numText = oRegion.Number2Text(\"ordinal 15\", \"en-US\")" +msgid "url: The URL to open." msgstr "" -#. 3T93o -#: sf_region.xhp +#. hJqsF +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id801656027524051\n" +"sf_session.xhp\n" +"par_id311582819697897\n" "help.text" -msgid "To get a list of all supported prefixes in a given language, call Number2Text with the special \"help\" argument. In the example below, assume your locale is set to \"en-US\", then the list of available prefixes for \"en-US\" will be shown by MsgBox:" +msgid "Executes an arbitrary system command and returns True if it was launched successfully." msgstr "" -#. RBkxp -#: sf_region.xhp +#. D483F +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id781656027840633\n" +"sf_session.xhp\n" +"par_id461582819697898\n" "help.text" -msgid "The first line in the message box does not have a prefix, which means that it is the standard format. The subsequent lines include the prefix and some examples of numbers using its format." +msgid "command: The command to execute. This may be an executable file or a document which is registered with an application so that the system knows what application to launch for that document. The command must be expressed in the current SF_FileSystem.FileNaming notation." msgstr "" -#. WYDkd -#: sf_region.xhp +#. b8hbC +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id781656028528520\n" +"sf_session.xhp\n" +"par_id611582819697899\n" "help.text" -msgid "Each language has its own set of supported prefixes. The number of available prefixes may vary from language to language." +msgid "parameters: A list of space separated parameters as a single string. The method does not validate the given parameters, but only passes them to the specified command." msgstr "" -#. gcMPN -#: sf_region.xhp +#. 2hTM7 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id531663849363398\n" +"sf_session.xhp\n" +"par_id131601030349755\n" "help.text" -msgid "To get the list of prefixes for a specific language or locale, it can be specified as the second argument in Number2Text. The example below shows the available prefixes available for the \"pt-BR\" locale:" +msgid "Send a message - with optional attachments - to recipients from the user's mail client. The message may be edited by the user before sending or, alternatively, be sent immediately." msgstr "" -#. dShiA -#: sf_region.xhp +#. FCn8e +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id71621894832117\n" +"sf_session.xhp\n" +"par_id701601030349896\n" "help.text" -msgid "Returns the offset between GMT and the given timezone and locale, in minutes." +msgid "recipient: An email address (the \"To\" recipient)." msgstr "" -#. xCAjE -#: sf_region.xhp +#. BdMiD +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675018\n" +"sf_session.xhp\n" +"par_id571601030349904\n" "help.text" -msgid "timezone: the timezone for which the offset to the GMT will be calculated." +msgid "cc: A comma-separated list of email addresses (the \"carbon copy\" recipients)." msgstr "" -#. XuX3E -#: sf_region.xhp +#. ADjaV +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675691\n" +"sf_session.xhp\n" +"par_id961601031043346\n" "help.text" -msgid "locale: the locale specifying the country for which the offset will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." +msgid "bcc: A comma-separated list of email addresses (the \"blind carbon copy\" recipients)." msgstr "" -#. JiFjE -#: sf_region.xhp +#. zAkWZ +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id71621894864217\n" +"sf_session.xhp\n" +"par_id891601031050814\n" "help.text" -msgid "Returns the UTC date and time considering a given local date and time in a timezone." +msgid "subject: the header of the message." msgstr "" -#. AK3nQ -#: sf_region.xhp +#. 69CFR +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896674748\n" +"sf_session.xhp\n" +"par_id191601031056673\n" "help.text" -msgid "localdatetime: the local date and time in a specific timezone expressed as a date." +msgid "body: The contents of the message as an unformatted text." msgstr "" -#. hpxBF -#: sf_region.xhp +#. McuEx +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675739\n" +"sf_session.xhp\n" +"par_id511601031063269\n" "help.text" -msgid "timezone: the timezone for which the localdatetime argument was given." +msgid "filenames: a comma-separated list of file names. Each file name must respect the SF_FileSystem.FileNaming notation." msgstr "" -#. zSttY -#: sf_region.xhp +#. h9Urq +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896675550\n" +"sf_session.xhp\n" +"par_id161601032784063\n" "help.text" -msgid "locale: the locale specifying the country for which the localdatetime argument was given, expressed either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." +msgid "editmessage: When True (default), the message is edited before being sent." msgstr "" -#. y3NSm -#: sf_region.xhp +#. g7zLC +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id861656077547861\n" +"sf_session.xhp\n" +"par_id111582816583005\n" "help.text" -msgid "' Date/Time in Berlin, June 23, 2022 at 14:30:00" +msgid "Modifies the PDF export settings defined in the PDF Options dialog, which can be accessed by choosing File - Export as - Export as PDF." msgstr "" -#. HjSnk -#: sf_region.xhp +#. T2DkW +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id731656077523173\n" +"sf_session.xhp\n" +"par_id181638385131806\n" "help.text" -msgid "' The UTC date/time is June 23, 2022 at 12:30:00" +msgid "Calling this method changes the actual values set in the PDF Options dialog, which are used by the ExportAsPDF method from the Document service." msgstr "" -#. tZoWt -#: sf_region.xhp +#. FBrKg +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id71621894835287\n" +"sf_session.xhp\n" +"par_id391638385313847\n" "help.text" -msgid "Returns the current UTC date and time, given a timezone and locale." +msgid "This method returns True when successful." msgstr "" -#. zzSQA -#: sf_region.xhp +#. zosG7 +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id491656078254442\n" +"sf_session.xhp\n" +"par_id751638383457321\n" "help.text" -msgid "This method uses the current date and time of your operating system to calculate the UTC time." +msgid "Read the PDF Export wiki page to learn more about all available options." msgstr "" -#. XxBE8 -#: sf_region.xhp +#. JhhXU +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896673318\n" +"sf_session.xhp\n" +"par_id771582816585233\n" "help.text" -msgid "timezone: the timezone for which the current UTC time will be calculated." +msgid "pdfoptions: Dictionary object that defines the PDF export settings to be changed. Each key-value pair represents an export option and the value that will be set in the dialog." msgstr "" -#. BHESq -#: sf_region.xhp +#. 8DKZK +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"par_id401621896674831\n" +"sf_session.xhp\n" +"par_id141638386087986\n" "help.text" -msgid "locale: the locale specifying the country for which the current UTC time will be calculated, given either in \"la-CO\" or \"CO\" formats. The default value is the locale defined in the OfficeLocale property of the Platform service." +msgid "The following example changes the maximum image resolution to 150 dpi and exports the current document as a PDF file." msgstr "" -#. FWSJp -#: sf_region.xhp +#. HtzHP +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id861656078128374\n" +"sf_session.xhp\n" +"par_id321587478024997\n" "help.text" -msgid "' Suppose the operating system time is June 23rd, 2022 at 10:42:00" +msgid "Returns a list of the methods callable from an UNO object. The list is a zero-based array of strings and may be empty." msgstr "" -#. CWY76 -#: sf_region.xhp +#. DX8qb +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"bas_id691656078180784\n" +"sf_session.xhp\n" +"par_id251587478024311\n" "help.text" -msgid "' If the computer is in Europe/Berlin, then UTC time is June 23rd, 2022 at 08:42:00" +msgid "unoobject: The object to inspect." msgstr "" -#. NPVe5 -#: sf_region.xhp +#. sL6Ri +#: sf_session.xhp msgctxt "" -"sf_region.xhp\n" -"pyc_id821656078645252\n" +"sf_session.xhp\n" +"par_id141587478343306\n" "help.text" -msgid "utcTime = oRegion.UTCNow(\"Europe/Berlin\", \"DE\")" +msgid "Returns a list of the properties of an UNO object. The list is a zero-based array of strings and may be empty." msgstr "" -#. GpvmN -#: sf_services.xhp +#. CFZRP +#: sf_session.xhp msgctxt "" -"sf_services.xhp\n" -"tit\n" +"sf_session.xhp\n" +"par_id241587478343323\n" "help.text" -msgid "ScriptForge.Services service" +msgid "unoobject: The object to inspect." msgstr "" -#. Q5KAY -#: sf_services.xhp +#. Cm4eK +#: sf_session.xhp msgctxt "" -"sf_services.xhp\n" -"hd_id471582710868716\n" +"sf_session.xhp\n" +"par_id371582820251347\n" "help.text" -msgid "ScriptForge.Services service" +msgid "Identify the type of a UNO object as a string." msgstr "" -#. SDbDJ -#: sf_services.xhp +#. Cs3VC +#: sf_session.xhp msgctxt "" -"sf_services.xhp\n" -"par_id241627513489594\n" +"sf_session.xhp\n" +"par_id921582820251349\n" "help.text" -msgid "The main purpose of the Services module is to provide access to the CreateScriptService method, which can be called in user scripts to instantiate services that are implemented using the ScriptForge framework." +msgid "unoobject: The object to identify." msgstr "" -#. 7B2KJ -#: sf_services.xhp +#. UAy4i +#: sf_session.xhp msgctxt "" -"sf_services.xhp\n" -"par_id351582710868545\n" +"sf_session.xhp\n" +"par_id341582821057373\n" "help.text" -msgid "In ScriptForge terminology a service is a collection of methods and properties that can be used for a common purpose. For example, the String service provides methods for manipulating strings whereas the FileSystem service allows for the manipulation of files and folders." +msgid "Get some web content from a URI." msgstr "" -#. NW4BS -#: sf_services.xhp +#. BU5XR +#: sf_session.xhp msgctxt "" -"sf_services.xhp\n" -"par_id541627513771828\n" +"sf_session.xhp\n" +"par_id771582821057374\n" "help.text" -msgid "The Services module of the ScriptForge library provides additional methods that are used either internally to register available services or by developers who are interested in extending ScriptForge by creating new services. The only method that is relevant for user scripts is CreateScriptService." +msgid "uri: URI address of the web service." msgstr "" -#. FW4FC -#: sf_services.xhp +#. gn6AM +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id871582714020043\n" +"sf_string.xhp\n" +"tit\n" "help.text" -msgid "This method is used to instantiate a ScriptForge service so it can be called in user scripts." +msgid "ScriptForge.String service (SF_String)" msgstr "" -#. jG6U9 -#: sf_services.xhp +#. qHoPA +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id711627514310039\n" +"sf_string.xhp\n" +"hd_id521580038927003\n" "help.text" -msgid "The returned value is a Basic object or Nothing if an error occurred." +msgid "ScriptForge.String service" msgstr "" -#. oojMF -#: sf_services.xhp +#. yaisH +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id971582714020045\n" +"sf_string.xhp\n" +"par_id351579602570526\n" "help.text" -msgid "service: The name of the service identified as a string in the format \"library.service\":" +msgid "The String service provides a collection of methods for string processing. These methods can be used to:" msgstr "" -#. swGGN -#: sf_services.xhp +#. oNvbV +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id11627475954271\n" +"sf_string.xhp\n" +"par_id611611952070366\n" "help.text" -msgid "The library is a Basic library that must exist in the GlobalScope. The default value is \"ScriptForge\"." +msgid "Validate the contents of strings" msgstr "" -#. BBFeA -#: sf_services.xhp +#. UmFAv +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id811627475954641\n" +"sf_string.xhp\n" +"par_id611611952070376\n" "help.text" -msgid "The service is one of the services registered by the ScriptForge library." +msgid "Format strings by trimming, justifying or wrapping their contents" msgstr "" -#. btbtw -#: sf_services.xhp +#. EZKAi +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id391582714020045\n" +"sf_string.xhp\n" +"par_id611611952070367\n" "help.text" -msgid "arg0, ...: A list of arguments required by the invoked service." +msgid "Use regular expressions to search and replace substrings" msgstr "" -#. yAaks -#: sf_services.xhp +#. D2qPU +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id841627475900817\n" +"sf_string.xhp\n" +"par_id611611952070368\n" "help.text" -msgid "If the first argument refers to an event manager, then arg0 is mandatory and must be the UNO object representing the event provided as argument to the user macro." +msgid "Apply hash algorithms on strings, etc." msgstr "" -#. wuR7S -#: sf_services.xhp +#. Nd4es +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id981582898174133\n" +"sf_string.xhp\n" +"hd_id961579603699855\n" "help.text" -msgid "' To be done once" +msgid "Definitions" msgstr "" -#. oqovE -#: sf_services.xhp +#. dQjPv +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id311582715700844\n" +"sf_string.xhp\n" +"hd_id441579603838777\n" "help.text" -msgid "' Refers to the \"ScriptForge.Array\" service or SF_Array" +msgid "Line breaks" msgstr "" -#. KvcPo -#: sf_services.xhp +#. ePyj2 +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id61582715759468\n" +"sf_string.xhp\n" +"par_id791611946942340\n" "help.text" -msgid "' Returns a new empty dictionary class instance; \"ScriptForge.\" is optional" +msgid "The String service recognizes the following line breaks:" msgstr "" -#. pMGcR -#: sf_services.xhp +#. o2TiZ +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id901582715797722\n" +"sf_string.xhp\n" +"par_id151611947117831\n" "help.text" -msgid "' Refers to the Calc service, implemented in the associated SFDocuments library" +msgid "Symbolic name" msgstr "" -#. BoXHx -#: sf_services.xhp +#. fEbm9 +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id361582715845747\n" +"sf_string.xhp\n" +"par_id721611947117831\n" "help.text" -msgid "' Returns a Timer class instance starting immediately" +msgid "ASCII number" msgstr "" -#. 9bmdn -#: sf_services.xhp +#. r8KjC +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id571596298708062\n" +"sf_string.xhp\n" +"par_id761611947117831\n" "help.text" -msgid "' Refers to the DocumentEvent service implemented in the associated SFDocuments library" +msgid "Line feed
Vertical tab
Carriage return
Carriage return + Line feed
File separator
Group separator
Record separator
Next line
Line separator
Paragraph separator" msgstr "" -#. DFhat -#: sf_services.xhp +#. WCvgW +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"bas_id121613492254532\n" +"sf_string.xhp\n" +"hd_id161579604225813\n" "help.text" -msgid "' Returns the instance of the Document class that fired the event" +msgid "Whitespaces" msgstr "" -#. zhCyY -#: sf_services.xhp +#. mFfbq +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id321627570607194\n" +"sf_string.xhp\n" +"par_id401611948279056\n" "help.text" -msgid "Python scripts support keyword arguments when calling CreateScriptService. The following example illustrates this concept by instantiating the Timer and Document services using keyword arguments." +msgid "The String service recognizes the following whitespaces:" msgstr "" -#. jah7F -#: sf_services.xhp +#. U3GSy +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id901627576693156\n" +"sf_string.xhp\n" +"par_id151611947117893\n" "help.text" -msgid "To make writing Python scripts more fluid, ScriptForge provides the Basic service which allows Python scripts to call a collection of methods with the same syntax and meaning as their homonymous native Basic functions." +msgid "Symbolic name" msgstr "" -#. SDQ7m -#: sf_services.xhp +#. ZsSFF +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id41627644806288\n" +"sf_string.xhp\n" +"par_id721611947117855\n" "help.text" -msgid "The following example instantiates the Basic service and calls the MsgBox method, which is equivalent to the MsgBox function available in Basic:" +msgid "ASCII number" msgstr "" -#. TFMGE -#: sf_services.xhp +#. TXAFP +#: sf_string.xhp msgctxt "" -"sf_services.xhp\n" -"par_id581627645023307\n" +"sf_string.xhp\n" +"par_id761611947117835\n" "help.text" -msgid "Be aware that the Basic service has to be instantiated in Python scripts using the CreateScriptService method." +msgid "Space
Horizontal tab
Line feed
Vertical tab
Form feed
Carriage return
Next line
No-break space
Line separator
Paragraph separator" msgstr "" -#. LCVem -#: sf_session.xhp +#. UPByW +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"tit\n" +"sf_string.xhp\n" +"hd_id191580480825160\n" "help.text" -msgid "ScriptForge.Session service" +msgid "Escape sequences" msgstr "" -#. yWao7 -#: sf_session.xhp +#. JD6CK +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"hd_id901582814720985\n" +"sf_string.xhp\n" +"par_id971611949145057\n" "help.text" -msgid "ScriptForge.Session service" +msgid "Below is a list of escape sequences that can be used in strings." msgstr "" -#. yTgFK -#: sf_session.xhp +#. D4DjE +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id861582814720987\n" +"sf_string.xhp\n" +"par_id151611947117287\n" "help.text" -msgid "The Session service gathers various general-purpose methods about:" +msgid "Escape Sequence" msgstr "" -#. a2DCM -#: sf_session.xhp +#. xzDai +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id34158281472051\n" +"sf_string.xhp\n" +"par_id721611947117732\n" "help.text" -msgid "the installation or execution environment" +msgid "Symbolic name" msgstr "" -#. cf5WG -#: sf_session.xhp +#. rrxV4 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id411582814720361\n" +"sf_string.xhp\n" +"par_id721611947117144\n" "help.text" -msgid "UNO introspection" +msgid "ASCII number" msgstr "" -#. fBApv -#: sf_session.xhp +#. fS24a +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id321582814720863\n" +"sf_string.xhp\n" +"par_id761611947119834\n" "help.text" -msgid "the invocation of external scripts or programs" +msgid "Line feed
Carriage return
Horizontal tab" msgstr "" -#. 63uDb -#: sf_session.xhp +#. wAbkt +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"hd_id91582814720116\n" +"sf_string.xhp\n" +"par_id251611949474763\n" "help.text" -msgid "Service invocation" +msgid "To have the escape sequence \"\\n\" interpreted as an actual string, simply use \"\\\\n\" instead of \"\\\" & Chr(10)." msgstr "" -#. XRvpV -#: sf_session.xhp +#. AYQbH +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id141609955500101\n" +"sf_string.xhp\n" +"hd_id771579606799550\n" "help.text" -msgid "Before using the Session service the ScriptForge library needs to be loaded or imported:" +msgid "Non-printable characters:" msgstr "" -#. 8BEnm -#: sf_session.xhp +#. WXEDi +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"hd_id291582814720762\n" +"sf_string.xhp\n" +"par_id531579606877342\n" "help.text" -msgid "Constants" +msgid "Characters defined in the Unicode Character Database as “Other” or “Separator” are considered as non-printable characters." msgstr "" -#. zcRQu -#: sf_session.xhp +#. MEoqS +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id82158281472034\n" +"sf_string.xhp\n" +"par_id221611949584320\n" "help.text" -msgid "Below is a list of constants available to ease the designation of the library containing a Basic or Python script to invoke. Use them as session.CONSTANT." +msgid "Control characters (ASCII code <= 0x1F) are also considered as non-printable." msgstr "" -#. yyF2R -#: sf_session.xhp +#. GfNfK +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id9158281472045\n" +"sf_string.xhp\n" +"hd_id661579604944268\n" "help.text" -msgid "Value" +msgid "Quotes inside strings:" msgstr "" -#. Wd88w -#: sf_session.xhp +#. 6KLF9 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id241582814720636\n" +"sf_string.xhp\n" +"par_id551579605035332\n" "help.text" -msgid "Where to find the library?" +msgid "To add quotes in strings use \\' (single quote) or \\\" (double quote). For example:" msgstr "" -#. k58kN -#: sf_session.xhp +#. BKoHN +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id361582814720116\n" +"sf_string.xhp\n" +"par_id201611949691285\n" "help.text" -msgid "Applicable" +msgid "The string [str\\'i\\'ng] is interpreted as [str'i'ng]" msgstr "" -#. DJspw -#: sf_session.xhp +#. eRosR +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id451582814720105\n" +"sf_string.xhp\n" +"par_id201611949691323\n" "help.text" -msgid "in the document" +msgid "The string [str\\\"i\\\"ng] is interpreted as [str\"i\"ng]" msgstr "" -#. Q2KtM -#: sf_session.xhp +#. FtzhT +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id73158281472032\n" +"sf_string.xhp\n" +"hd_id201586594659135\n" "help.text" -msgid "in any shared library" +msgid "Service invocation" msgstr "" -#. 2GN3X -#: sf_session.xhp +#. 4WFve +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id391582814720487\n" +"sf_string.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "in My Macros" +msgid "Before using the ScriptForge.String service the ScriptForge library needs to be loaded using:" msgstr "" -#. MiuWT -#: sf_session.xhp +#. znLHV +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id56158281472073\n" +"sf_string.xhp\n" +"par_id271627158844922\n" "help.text" -msgid "in an extension installed for the current user" +msgid "Loading the library will create the SF_String object that can be used to call the methods in the String service." msgstr "" -#. MfbpF -#: sf_session.xhp +#. e2Gty +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id21582814720997\n" +"sf_string.xhp\n" +"par_id63158659509728\n" "help.text" -msgid "in Application Macros" +msgid "The following code snippets show the three ways to call methods from the String service (the Capitalize method is used as an example):" msgstr "" -#. LnKrt -#: sf_session.xhp +#. UE3DL +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id981582814720125\n" +"sf_string.xhp\n" +"par_id761627158463235\n" "help.text" -msgid "in an extension installed for all users" +msgid "The code snippet below illustrates how to invoke methods from the String service in Python scripts. The IsIPv4 method is used as an example." msgstr "" -#. gCi9j -#: sf_session.xhp +#. GfEcK +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id93158281472047\n" +"sf_string.xhp\n" +"hd_id651584978211886\n" "help.text" -msgid "in an extension but the installation parameters are unknown" +msgid "Properties" msgstr "" -#. mLURi -#: sf_session.xhp +#. qKhL4 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id891611613601554\n" +"sf_string.xhp\n" +"par_id241611950267068\n" "help.text" -msgid "List of Methods in the Session Service" +msgid "The SF_String object provides the following properties for Basic scripts:" msgstr "" -#. JvBuZ -#: sf_session.xhp +#. FDjPb +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id491613061572993\n" +"sf_string.xhp\n" +"par_id271584978211792\n" "help.text" -msgid "Execute... methods in Session service behave as follows:
Arguments are passed by value. Changes made by the called function to the arguments do not update their values in the calling script.
A single value or an array of values is returned to the calling script." +msgid "Name" msgstr "" -#. ALw6M -#: sf_session.xhp +#. HGYbF +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id451582815407230\n" +"sf_string.xhp\n" +"par_id241584978211550\n" "help.text" -msgid "Execute the BASIC script given its name and location, and fetch its result, if any." +msgid "ReadOnly" msgstr "" -#. yFnSG -#: sf_session.xhp +#. 5qXzL +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id921600856780901\n" +"sf_string.xhp\n" +"par_id621584978211403\n" "help.text" -msgid "If the script returns nothing, which is the case of procedures defined with Sub, the returned value is Empty." +msgid "Description" msgstr "" -#. VTyCE -#: sf_session.xhp +#. 6DG3u +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id631582815407231\n" +"sf_string.xhp\n" +"par_id71584978715562\n" "help.text" -msgid "scope: String specifying where the script is stored. It can be either \"document\" (constant session.SCRIPTISEMBEDDED) or \"application\" (constant session.SCRIPTISAPPLICATION)." +msgid "Yes" msgstr "" -#. SCCpE -#: sf_session.xhp +#. YJA6w +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id691582815407231\n" +"sf_string.xhp\n" +"par_id581584978715701\n" "help.text" -msgid "script: String specifying the script to be called in the format \"library.module.method\" as a case-sensitive string." +msgid "Carriage return: Chr(13)" msgstr "" -#. hS5x4 -#: sf_session.xhp +#. NCbTs +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id741626828862265\n" +"sf_string.xhp\n" +"par_id211584978211383\n" "help.text" -msgid "The library is loaded in memory if necessary." +msgid "Yes" msgstr "" -#. D8AL6 -#: sf_session.xhp +#. xht7K +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id981626828863001\n" +"sf_string.xhp\n" +"par_id691584978211774\n" "help.text" -msgid "The module must not be a class module." +msgid "Carriage return + Linefeed: Chr(13) & Chr(10)" msgstr "" -#. VsUFD -#: sf_session.xhp +#. ennLs +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id721626828863257\n" +"sf_string.xhp\n" +"par_id671584978666689\n" "help.text" -msgid "The method may be a Sub or a Function." +msgid "Yes" msgstr "" -#. eExjm -#: sf_session.xhp +#. pdykp +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id881582815407231\n" +"sf_string.xhp\n" +"par_id951584978666296\n" "help.text" -msgid "args: The arguments to be passed to the called script." +msgid "Linefeed: Chr(10)" msgstr "" -#. mg5WG -#: sf_session.xhp +#. TTF6v +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id21626809513802\n" +"sf_string.xhp\n" +"par_id421584978666327\n" "help.text" -msgid "Consider the following Basic function named DummyFunction that is stored in \"My Macros\" in the \"Standard\" library inside a module named \"Module1\"." +msgid "Yes" msgstr "" -#. PMyrB -#: sf_session.xhp +#. 9djV3 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id551626810319766\n" +"sf_string.xhp\n" +"par_id901584978666158\n" "help.text" -msgid "The function simply takes in two integer values v1 and v2 and return the sum of all values starting in v1 and ending in v2." +msgid "Carriage return + Linefeed, which can be
1) Chr(13) & Chr(10) or
2) Linefeed: Chr(10)
depending on the operating system." msgstr "" -#. Gx6fV -#: sf_session.xhp +#. EMV7g +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id461626810470057\n" +"sf_string.xhp\n" +"par_id541584978666991\n" "help.text" -msgid "The examples below show how to call DummyFunction from within Basic and Python scripts." +msgid "Yes" msgstr "" -#. uCzZs -#: sf_session.xhp +#. VrjGQ +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id111582816585181\n" +"sf_string.xhp\n" +"par_id741584978666508\n" "help.text" -msgid "Execute a Calc function using its English name and based on the given arguments.
If the arguments are arrays, the function is executed as an array formula." +msgid "Horizontal tabulation: Chr(9)" msgstr "" -#. EDU9x -#: sf_session.xhp +#. Ee5CF +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id771582816585183\n" +"sf_string.xhp\n" +"par_id461584978880380\n" "help.text" -msgid "calcfunction: The name of the Calc function to be called, in English." +msgid "You can use the properties above to identify or insert the corresponding characters inside strings. For example, the Linefeed can be replaced by SF_String.sfLF." msgstr "" -#. FJJJh -#: sf_session.xhp +#. DDXd3 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id371582816585183\n" +"sf_string.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "args: The arguments to be passed to the called Calc function. Each argument must be either a string, a numeric value or an array of arrays combining those types." +msgid "List of Methods in the String Service" msgstr "" -#. XMfUD -#: sf_session.xhp +#. TFfR3 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"bas_id881582816585185\n" +"sf_string.xhp\n" +"par_id151611951803163\n" "help.text" -msgid "' Generates an error." +msgid "The first argument of most methods is the string to be considered. It is always passed by reference and left unchanged. Methods such as Capitalize, Escape, etc return a new string after their execution." msgstr "" -#. ygESx -#: sf_session.xhp +#. PYcny +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id571582818023245\n" +"sf_string.xhp\n" +"par_id371627158142730\n" "help.text" -msgid "Execute the Python script given its location and name, fetch its result if any. Result can be a single value or an array of values." +msgid "Because Python has comprehensive built-in string support, most of the methods in the String service are available for Basic scripts only. The methods available for Basic and Python are: HashStr, IsADate, IsEmail, IsFileName, IsIBAN, IsIPv4, IsLike, IsSheetName, IsUrl, SplitNotQuoted and Wrap." msgstr "" -#. SB2gx -#: sf_session.xhp +#. jaBZR +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id71600856817410\n" +"sf_string.xhp\n" +"par_id271579683706571\n" "help.text" -msgid "If the script is not found, or if it returns nothing, the returned value is Empty." +msgid "Capitalizes the first character from each word in the input string." msgstr "" -#. 4WTUK -#: sf_session.xhp +#. ibgky +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id791582818023246\n" +"sf_string.xhp\n" +"par_id941582304592013\n" "help.text" -msgid "scope: One of the applicable constants listed above. The default value is session.SCRIPTISSHARED." +msgid "inputstr: The string to be capitalized." msgstr "" -#. ELfda -#: sf_session.xhp +#. DB982 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id71582818023247\n" +"sf_string.xhp\n" +"par_id891582384556756\n" "help.text" -msgid "script: Either \"library/module.py$method\" or \"module.py$method\" or \"myExtension.oxt|myScript|module.py$method\" as a case-sensitive string." +msgid "Counts the number of occurrences of a substring or a regular expression within a string." msgstr "" -#. P6ZKD -#: sf_session.xhp +#. DxK5L +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id501613061041313\n" +"sf_string.xhp\n" +"par_id571582384689863\n" "help.text" -msgid "library: The folder path to the Python module." +msgid "inputstr: The input string to be examined" msgstr "" -#. ktFHu -#: sf_session.xhp +#. QUeur +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id771613061043097\n" +"sf_string.xhp\n" +"par_id601582384696486\n" "help.text" -msgid "myScript: The folder containing the Python module." +msgid "substring: The substring or the regular expression to be used during search" msgstr "" -#. ANBoy -#: sf_session.xhp +#. vGiqm +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id301613061123849\n" +"sf_string.xhp\n" +"par_id451582384703719\n" "help.text" -msgid "module.py: The Python module." +msgid "isregex: Use True if the substring is a regular expression (Default = False)" msgstr "" -#. f4B8C -#: sf_session.xhp +#. WiFme +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id241613061044560\n" +"sf_string.xhp\n" +"par_id141582384726168\n" "help.text" -msgid "method: The Python function." +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. ByFdE -#: sf_session.xhp +#. QcE5q +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id711582818023247\n" +"sf_string.xhp\n" +"bas_id371582384749769\n" "help.text" -msgid "args: The arguments to be passed to the called script." +msgid "'Counts the occurrences of the substring \"or\" inside the input string (returns 2)" msgstr "" -#. ckvXs -#: sf_session.xhp +#. XXCR4 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id701626817164878\n" +"sf_string.xhp\n" +"bas_id561582384801586\n" "help.text" -msgid "Consider the Python function odd_integers defined below that creates a list with odd integer values between v1 and v2. Suppose this function is stored in a file named my_macros.py in your user scripts folder." +msgid "'Counts the number of words with only lowercase letters (returns 7)" msgstr "" -#. HWGRK -#: sf_session.xhp +#. zS3nb +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id751626817335715\n" +"sf_string.xhp\n" +"par_id131612223767126\n" "help.text" -msgid "Read the help page Python Scripts Organization and Location to learn more about where Python scripts can be stored." +msgid "To learn more about regular expressions, refer to the Python's documentation on Regular Expression Operations." msgstr "" -#. vqBm9 -#: sf_session.xhp +#. CCzMc +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id121626817725471\n" +"sf_string.xhp\n" +"par_id581579687739629\n" "help.text" -msgid "The following examples show how to call the function odd_integers from within Basic and Python scripts." +msgid "Returns True if a string ends with a specified substring." msgstr "" -#. pbmij -#: sf_session.xhp +#. cAmFW +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id111582816585087\n" +"sf_string.xhp\n" +"par_id21612306392239\n" "help.text" -msgid "Returns the current PDF export settings defined in the PDF Options dialog, which can be accessed by choosing File - Export as - Export as PDF." +msgid "The function returns False when either the string or the substring have a length = 0 or when the substring is longer than the string." msgstr "" -#. K7j2q -#: sf_session.xhp +#. qk5nE +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id931638383270026\n" +"sf_string.xhp\n" +"par_id191579861552201\n" "help.text" -msgid "Export options set with the PDF Options dialog are kept for future use. Hence GetPDFExportOptions returns the settings currently defined. In addition, use SetPDFExportOptions to change current PDF export options." +msgid "inputstr: The string to be tested." msgstr "" -#. uFCEq -#: sf_session.xhp +#. ErigR +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id801638383659558\n" +"sf_string.xhp\n" +"par_id211579861561473\n" "help.text" -msgid "This method returns a Dictionary object wherein each key represent export options and the corresponding values are the current PDF export settings." +msgid "substring: The substring to be searched at the end of inputstr." msgstr "" -#. GCDTK -#: sf_session.xhp +#. 4DKkW +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id751638383457198\n" +"sf_string.xhp\n" +"par_id801579861574009\n" "help.text" -msgid "Read the PDF Export wiki page to learn more about all available options." +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. Lv4iA -#: sf_session.xhp +#. gn2F8 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id111587477335982\n" +"sf_string.xhp\n" +"bas_id811579862998452\n" "help.text" -msgid "Returns True if an UNO object contains the given method. Returns False when the method is not found or when an argument is invalid." +msgid "'Returns True because the method was called with the default CaseSensitive = False" msgstr "" -#. HAw32 -#: sf_session.xhp +#. vJDmx +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id921587477335673\n" +"sf_string.xhp\n" +"bas_id231579863168747\n" "help.text" -msgid "unoobject: The object to inspect." +msgid "'Returns False due to the CaseSensitive parameter" msgstr "" -#. DDw6g -#: sf_session.xhp +#. zThMM +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id631587477566016\n" +"sf_string.xhp\n" +"par_id921585921441429\n" "help.text" -msgid "methodname: the method as a case-sensitive string" +msgid "Converts linebreaks and tabs contained in the input string to their equivalent escaped sequence (\\\\, \\n, \\r, \\t)." msgstr "" -#. gDBRB -#: sf_session.xhp +#. kBiBE +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id191587477832959\n" +"sf_string.xhp\n" +"par_id9158592144110\n" "help.text" -msgid "Returns True if a UNO object has the given property. Returns False when the property is not found or when an argument is invalid." +msgid "inputstr: The string to be converted." msgstr "" -#. 54oXs -#: sf_session.xhp +#. cpLKD +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id121587477832805\n" +"sf_string.xhp\n" +"bas_id901585921441483\n" "help.text" -msgid "unoobject: The object to inspect." +msgid "'Returns the string \"abc\\n\\tdef\\\\n\"" msgstr "" -#. hCTCk -#: sf_session.xhp +#. ADN8M +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id701587477832750\n" +"sf_string.xhp\n" +"par_id271579868053137\n" "help.text" -msgid "propertyname: the property as a case-sensitive string" +msgid "Replaces Tab characters Chr(9) by space characters to replicate the behavior of tab stops." msgstr "" -#. 75Rh4 -#: sf_session.xhp +#. Eb23Z +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id97160112964017\n" +"sf_string.xhp\n" +"par_id951579868064344\n" "help.text" -msgid "Open a Uniform Resource Locator (URL) in the default browser." +msgid "If a line break is found, a new line is started and the character counter is reset." msgstr "" -#. 4tFWV -#: sf_session.xhp +#. E73Ko +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id241601129640549\n" +"sf_string.xhp\n" +"par_id231579868290408\n" "help.text" -msgid "url: The URL to open." +msgid "inputstr: The string to be expanded" msgstr "" -#. hJqsF -#: sf_session.xhp +#. 9dyYc +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id311582819697897\n" +"sf_string.xhp\n" +"par_id281579868299807\n" "help.text" -msgid "Executes an arbitrary system command and returns True if it was launched successfully." +msgid "tabsize: This parameter is used to determine the Tab stops using the formula: TabSize + 1, 2 * TabSize + 1 , ... N * TabSize + 1 (Default = 8)" msgstr "" -#. D483F -#: sf_session.xhp +#. GUoE8 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id461582819697898\n" +"sf_string.xhp\n" +"par_id161579874552729\n" "help.text" -msgid "command: The command to execute. This may be an executable file or a document which is registered with an application so that the system knows what application to launch for that document. The command must be expressed in the current SF_FileSystem.FileNaming notation." +msgid "Replaces all non-printable characters in the input string by a given character." msgstr "" -#. b8hbC -#: sf_session.xhp +#. GpHwp +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id611582819697899\n" +"sf_string.xhp\n" +"par_id431579874633865\n" "help.text" -msgid "parameters: A list of space separated parameters as a single string. The method does not validate the given parameters, but only passes them to the specified command." +msgid "inputstr: The string to be searched" msgstr "" -#. 2hTM7 -#: sf_session.xhp +#. GttDN +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id131601030349755\n" +"sf_string.xhp\n" +"par_id31579874656437\n" "help.text" -msgid "Send a message - with optional attachments - to recipients from the user's mail client. The message may be edited by the user before sending or, alternatively, be sent immediately." +msgid "replacedby: Zero, one or more characters that will replace all non-printable characters in inputstr (Default = \"\")" msgstr "" -#. FCn8e -#: sf_session.xhp +#. W44TL +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id701601030349896\n" +"sf_string.xhp\n" +"par_id1001579876228707\n" "help.text" -msgid "recipient: An email address (the \"To\" recipient)." +msgid "Finds in a string a substring matching a given regular expression." msgstr "" -#. BdMiD -#: sf_session.xhp +#. aq28M +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id571601030349904\n" +"sf_string.xhp\n" +"par_id131579876314120\n" "help.text" -msgid "cc: A comma-separated list of email addresses (the \"carbon copy\" recipients)." +msgid "inputstr: The string to be searched" msgstr "" -#. ADjaV -#: sf_session.xhp +#. hRrBB +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id961601031043346\n" +"sf_string.xhp\n" +"par_id751579876371545\n" "help.text" -msgid "bcc: A comma-separated list of email addresses (the \"blind carbon copy\" recipients)." +msgid "regex: The regular expression" msgstr "" -#. zAkWZ -#: sf_session.xhp +#. y2Fqs +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id891601031050814\n" +"sf_string.xhp\n" +"par_id881579876394584\n" "help.text" -msgid "subject: the header of the message." +msgid "start: The position in the string where the search will begin. This parameter is passed by reference, so after execution the value of start will point to the first character of the found substring. If no matching substring is found, start will be set to 0." msgstr "" -#. 69CFR -#: sf_session.xhp +#. yZMDg +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id191601031056673\n" +"sf_string.xhp\n" +"par_id251579876403831\n" "help.text" -msgid "body: The contents of the message as an unformatted text." +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. McuEx -#: sf_session.xhp +#. A4JC7 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id511601031063269\n" +"sf_string.xhp\n" +"par_id841579876412287\n" "help.text" -msgid "filenames: a comma-separated list of file names. Each file name must respect the SF_FileSystem.FileNaming notation." +msgid "forward: Determines the direction of the search. If True, search moves forward. If False search moves backwards (Default = True)" msgstr "" -#. h9Urq -#: sf_session.xhp +#. SkaCi +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id161601032784063\n" +"sf_string.xhp\n" +"par_id451612309155653\n" "help.text" -msgid "editmessage: When True (default), the message is edited before being sent." +msgid "At the first iteration, if forward = True, then start should be equal to 1, whereas if forward = False then start should be equal to Len(inputstr)" msgstr "" -#. g7zLC -#: sf_session.xhp +#. gv3oo +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id111582816583005\n" +"sf_string.xhp\n" +"par_id221612309579001\n" "help.text" -msgid "Modifies the PDF export settings defined in the PDF Options dialog, which can be accessed by choosing File - Export as - Export as PDF." +msgid "In the example above, the new value of lStart can be used to keep searching the same input string by setting the Start parameter to lStart + Len(result) at the next iteration." msgstr "" -#. T2DkW -#: sf_session.xhp +#. qAkN4 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id181638385131806\n" +"sf_string.xhp\n" +"par_id471601048983628\n" "help.text" -msgid "Calling this method changes the actual values set in the PDF Options dialog, which are used by the ExportAsPDF method from the Document service." +msgid "Hash functions are used inside some cryptographic algorithms, in digital signatures, message authentication codes, manipulation detection, fingerprints, checksums (message integrity check), hash tables, password storage and much more." msgstr "" -#. FBrKg -#: sf_session.xhp +#. HupGD +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id391638385313847\n" +"sf_string.xhp\n" +"par_id301601048983765\n" "help.text" -msgid "This method returns True when successful." +msgid "The HashStr method returns the result of a hash function applied on a given string and using a specified algorithm, as a string of lowercase hexadecimal digits." msgstr "" -#. zosG7 -#: sf_session.xhp +#. ZRZEF +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id751638383457321\n" +"sf_string.xhp\n" +"par_id631601048983149\n" "help.text" -msgid "Read the PDF Export wiki page to learn more about all available options." +msgid "The hash algorithms supported are: MD5, SHA1, SHA224, SHA256, SHA384 and SHA512." msgstr "" -#. JhhXU -#: sf_session.xhp +#. yUmmb +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id771582816585233\n" +"sf_string.xhp\n" +"par_id621601048983210\n" "help.text" -msgid "pdfoptions: Dictionary object that defines the PDF export settings to be changed. Each key-value pair represents an export option and the value that will be set in the dialog." +msgid "inputstr: The string to hash. It is presumed to be encoded in UTF-8. The hashing algorithm will consider the string as a stream of bytes." msgstr "" -#. 8DKZK -#: sf_session.xhp +#. nuQRb +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id141638386087986\n" +"sf_string.xhp\n" +"par_id941601048983822\n" "help.text" -msgid "The following example changes the maximum image resolution to 150 dpi and exports the current document as a PDF file." +msgid "algorithm: One of the supported algorithms listed above, passed as a string." msgstr "" -#. HtzHP -#: sf_session.xhp +#. TXGmB +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id321587478024997\n" +"sf_string.xhp\n" +"par_id221579879516929\n" "help.text" -msgid "Returns a list of the methods callable from an UNO object. The list is a zero-based array of strings and may be empty." +msgid "Encodes the input string into the HTML character codes, replacing special characters by their & counterparts." msgstr "" -#. DX8qb -#: sf_session.xhp +#. YNfid +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id251587478024311\n" +"sf_string.xhp\n" +"par_id341612351999692\n" "help.text" -msgid "unoobject: The object to inspect." +msgid "For example, the character é would be replaced by é or an equivalent numerical HTML code." msgstr "" -#. sL6Ri -#: sf_session.xhp +#. CGFQH +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id141587478343306\n" +"sf_string.xhp\n" +"bas_id501579879570781\n" "help.text" -msgid "Returns a list of the properties of an UNO object. The list is a zero-based array of strings and may be empty." +msgid "inputstr: The string to encode." msgstr "" -#. CFZRP -#: sf_session.xhp +#. jpv97 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id241587478343323\n" +"sf_string.xhp\n" +"par_id171579880990533\n" "help.text" -msgid "unoobject: The object to inspect." +msgid "Returns True if the input string is a valid date according to a specified date format." msgstr "" -#. Cm4eK -#: sf_session.xhp +#. tBGBH +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id371582820251347\n" +"sf_string.xhp\n" +"par_id151579881091821\n" "help.text" -msgid "Identify the type of a UNO object as a string." +msgid "inputstr: The string to be checked. If empty, the method returns False" msgstr "" -#. Cs3VC -#: sf_session.xhp +#. nmTv3 +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id921582820251349\n" +"sf_string.xhp\n" +"par_id991579881107670\n" "help.text" -msgid "unoobject: The object to identify." +msgid "dateformat: The date format, as a string. It can be either \"YYYY-MM-DD\" (default), \"DD-MM-YYYY\" or \"MM-DD-YYYY\"" msgstr "" -#. UAy4i -#: sf_session.xhp +#. GvZLC +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id341582821057373\n" +"sf_string.xhp\n" +"par_id291579881117126\n" "help.text" -msgid "Get some web content from a URI." +msgid "The dash (-) may be replaced by a dot (.), a slash (/) or a space." msgstr "" -#. BU5XR -#: sf_session.xhp +#. yCA3T +#: sf_string.xhp msgctxt "" -"sf_session.xhp\n" -"par_id771582821057374\n" +"sf_string.xhp\n" +"par_id51579881125801\n" "help.text" -msgid "uri: URI address of the web service." +msgid "If the format is invalid, the method returns False." msgstr "" -#. gn6AM +#. 6B2Em #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"tit\n" +"par_id211612370427721\n" "help.text" -msgid "ScriptForge.String service (SF_String)" +msgid "This method checks the format of the input string without performing any calendar-specific checks. Hence it does not test the input string for leap years or months with 30 or 31 days. For that, refer to the IsDate built-in function." msgstr "" -#. qHoPA +#. DJQFQ #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id521580038927003\n" +"par_id181612371147364\n" "help.text" -msgid "ScriptForge.String service" +msgid "The example below shows the difference between the methods IsADate (ScriptForge) and the IsDate (built-in) function." msgstr "" -#. yaisH +#. hAADi #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id351579602570526\n" +"par_id161579881600317\n" "help.text" -msgid "The String service provides a collection of methods for string processing. These methods can be used to:" +msgid "Returns True if all characters in the string are alphabetic." msgstr "" -#. oNvbV +#. 25Avc #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id611611952070366\n" +"par_id251579881615469\n" "help.text" -msgid "Validate the contents of strings" +msgid "Alphabetic characters are those characters defined in the Unicode Character Database as Letter." msgstr "" -#. UmFAv +#. a9rTa #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id611611952070376\n" +"par_id11579881691826\n" "help.text" -msgid "Format strings by trimming, justifying or wrapping their contents" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. EZKAi +#. KaLGv #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id611611952070367\n" +"par_id421579883181382\n" "help.text" -msgid "Use regular expressions to search and replace substrings" +msgid "Returns True if all characters in the string are alphabetic, digits or \"_\" (underscore). The first character must not be a digit." msgstr "" -#. D2qPU +#. BAEB4 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id611611952070368\n" +"par_id31579884464101\n" "help.text" -msgid "Apply hash algorithms on strings, etc." +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. Nd4es +#. sdSga #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id961579603699855\n" +"par_id671580039484786\n" "help.text" -msgid "Definitions" +msgid "Returns True if all characters in the string are ASCII characters." msgstr "" -#. dQjPv +#. 3DNou #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id441579603838777\n" +"par_id791580039528838\n" "help.text" -msgid "Line breaks" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. ePyj2 +#. iuPF4 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id791611946942340\n" +"par_id861580044805749\n" "help.text" -msgid "The String service recognizes the following line breaks:" +msgid "Returns True if all characters in the string are digits." msgstr "" -#. o2TiZ +#. yU7cc #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id151611947117831\n" +"par_id41580044873043\n" "help.text" -msgid "Symbolic name" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. fEbm9 +#. J8Ykx #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id721611947117831\n" +"par_id521580045221758\n" "help.text" -msgid "ASCII number" +msgid "Returns True if the string is a valid email address." msgstr "" -#. r8KjC +#. 8Pxsn #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id761611947117831\n" +"par_id841580045280071\n" "help.text" -msgid "Line feed
Vertical tab
Carriage return
Carriage return + Line feed
File separator
Group separator
Record separator
Next line
Line separator
Paragraph separator" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. WCvgW +#. R6MsU #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id161579604225813\n" +"par_id41580047039666\n" "help.text" -msgid "Whitespaces" +msgid "Returns True if the string is a valid filename in a given operating system." msgstr "" -#. mFfbq +#. aQbRF #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id401611948279056\n" +"par_id801580047079938\n" "help.text" -msgid "The String service recognizes the following whitespaces:" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. U3GSy +#. jWMpJ #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id151611947117893\n" +"par_id781580047088954\n" "help.text" -msgid "Symbolic name" +msgid "osname: The operating system name, as a string. It can be \"WINDOWS\", \"LINUX\", \"MACOSX\" or \"SOLARIS\"." msgstr "" -#. ZsSFF +#. GnrxA #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id721611947117855\n" +"par_id991612372824234\n" "help.text" -msgid "ASCII number" +msgid "The default value is the current operating system on which the script is running." msgstr "" -#. TXAFP +#. FPuAV #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id761611947117835\n" +"par_id911580047551929\n" "help.text" -msgid "Space
Horizontal tab
Line feed
Vertical tab
Form feed
Carriage return
Next line
No-break space
Line separator
Paragraph separator" +msgid "Returns True if all characters in the string are hexadecimal digits." msgstr "" -#. UPByW +#. hWqAh #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id191580480825160\n" +"par_id331580047594144\n" "help.text" -msgid "Escape sequences" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. JD6CK +#. kEz4y #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id971611949145057\n" +"par_id521612377109554\n" "help.text" -msgid "Below is a list of escape sequences that can be used in strings." +msgid "The hexadecimal digits may be prefixed with \"0x\" or \"&H\"." msgstr "" -#. D4DjE +#. 3WKNf #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id151611947117287\n" +"par_id791584008420941\n" "help.text" -msgid "Escape Sequence" +msgid "Returns True if the string is a valid International Bank Account Number (IBAN). The comparison is not case-sensitive." msgstr "" -#. xzDai +#. DnC6i #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id721611947117732\n" +"par_id951880048466565\n" "help.text" -msgid "Symbolic name" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. rrxV4 +#. VgT3x #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id721611947117144\n" +"par_id631619526542367\n" "help.text" -msgid "ASCII number" +msgid "True if the string contains a valid IBAN number." msgstr "" -#. fS24a +#. CcTNk #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id761611947119834\n" +"par_id791580048420941\n" "help.text" -msgid "Line feed
Carriage return
Horizontal tab" +msgid "Returns True if the string is a valid IP(v4) address." msgstr "" -#. wAbkt +#. rMpXB #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id251611949474763\n" +"par_id981580048466565\n" "help.text" -msgid "To have the escape sequence \"\\n\" interpreted as an actual string, simply use \"\\\\n\" instead of \"\\\" & Chr(10)." +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. AYQbH +#. yWHew #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id771579606799550\n" +"par_id831580049093038\n" "help.text" -msgid "Non-printable characters:" +msgid "Returns True if the whole input string matches a given pattern containing wildcards." msgstr "" -#. WXEDi +#. PzigS #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id531579606877342\n" +"par_id141580049142548\n" "help.text" -msgid "Characters defined in the Unicode Character Database as “Other” or “Separator” are considered as non-printable characters." +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. MEoqS +#. XEBzh #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id221611949584320\n" +"par_id31580049154551\n" "help.text" -msgid "Control characters (ASCII code <= 0x1F) are also considered as non-printable." +msgid "pattern: The pattern as a string. Wildcards are:" msgstr "" -#. GfNfK +#. ZCzDP #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id661579604944268\n" +"par_id181612441703306\n" "help.text" -msgid "Quotes inside strings:" +msgid "\"?\" represents any single character;" msgstr "" -#. 6KLF9 +#. CFPcW #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id551579605035332\n" +"par_id861612377611438\n" "help.text" -msgid "To add quotes in strings use \\' (single quote) or \\\" (double quote). For example:" +msgid "\"*\" represents zero, one, or multiple characters." msgstr "" -#. BKoHN +#. eLYBF #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id201611949691285\n" +"par_id991580049206617\n" "help.text" -msgid "The string [str\\'i\\'ng] is interpreted as [str'i'ng]" +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. eRosR +#. kSMmn #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id201611949691323\n" +"par_id581580050048679\n" "help.text" -msgid "The string [str\\\"i\\\"ng] is interpreted as [str\"i\"ng]" +msgid "Returns True if all characters in the string are in lowercase. Non-alphabetic characters are ignored." msgstr "" -#. FtzhT +#. nWGvX #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id201586594659135\n" +"par_id751580050122938\n" "help.text" -msgid "Service invocation" +msgid "InputStr: The string to be checked. If empty, the method returns False." msgstr "" -#. 4WFve +#. BzD3y #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id141609955500101\n" +"par_id231580051650488\n" "help.text" -msgid "Before using the ScriptForge.String service the ScriptForge library needs to be loaded using:" +msgid "Returns True if all characters in the string are printable." msgstr "" -#. znLHV +#. gUhut #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id271627158844922\n" +"par_id721580051706431\n" "help.text" -msgid "Loading the library will create the SF_String object that can be used to call the methods in the String service." +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. e2Gty +#. HYBp5 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id63158659509728\n" +"par_id281580052400960\n" "help.text" -msgid "The following code snippets show the three ways to call methods from the String service (the Capitalize method is used as an example):" +msgid "Returns True if the whole input string matches a given regular expression." msgstr "" -#. UE3DL +#. ZuBxC #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id761627158463235\n" +"par_id161580052454770\n" "help.text" -msgid "The code snippet below illustrates how to invoke methods from the String service in Python scripts. The IsIPv4 method is used as an example." +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. GfEcK +#. mi4mi #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"hd_id651584978211886\n" +"par_id581580052467973\n" "help.text" -msgid "Properties" +msgid "regex: The regular expression. If empty, the method returns False." msgstr "" -#. qKhL4 +#. vmqZM #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id241611950267068\n" +"par_id621580052654341\n" "help.text" -msgid "The SF_String object provides the following properties for Basic scripts:" +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. FDjPb +#. iZSEw #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id271584978211792\n" +"par_id1001589460240467\n" "help.text" -msgid "Name" +msgid "Returns True if the input string is a valid Calc sheet name." msgstr "" -#. HGYbF +#. xPFLm #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id241584978211550\n" +"par_id671589460240552\n" "help.text" -msgid "ReadOnly" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. 5qXzL +#. uE5gz #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id621584978211403\n" +"par_id551612442002823\n" "help.text" -msgid "Description" +msgid "A sheet name must not contain the characters [ ] * ? : / \\ or the character ' (apostrophe) as first or last character." msgstr "" -#. 6DG3u +#. ALdgg #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id71584978715562\n" +"par_id371580293093655\n" "help.text" -msgid "Yes" +msgid "Returns True if the first character of every word is in uppercase and the other characters are in lowercase." msgstr "" -#. YJA6w +#. uVF9U #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id581584978715701\n" +"par_id471580293142283\n" "help.text" -msgid "Carriage return: Chr(13)" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. NCbTs +#. 7Ryzp #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id211584978211383\n" +"par_id801580128672004\n" "help.text" -msgid "Yes" +msgid "Returns True if all characters in the string are in uppercase. Non alphabetic characters are ignored." msgstr "" -#. xht7K +#. HFDCW #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id691584978211774\n" +"par_id391580128736809\n" "help.text" -msgid "Carriage return + Linefeed: Chr(13) & Chr(10)" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. ennLs +#. BTRpG #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id671584978666689\n" +"par_id531580132067813\n" "help.text" -msgid "Yes" +msgid "Returns True if the string is a valid absolute URL (Uniform Resource Locator) address. Only the http, https and ftp protocols are supported." msgstr "" -#. pdykp +#. HrFqG #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id951584978666296\n" +"par_id321580132113593\n" "help.text" -msgid "Linefeed: Chr(10)" +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. TTF6v +#. wBAqG #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id421584978666327\n" +"par_id41580132491698\n" "help.text" -msgid "Yes" +msgid "Returns True if all characters in the string are whitespaces" msgstr "" -#. 9djV3 +#. JDD85 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id901584978666158\n" +"par_id801580132535511\n" "help.text" -msgid "Carriage return + Linefeed, which can be
1) Chr(13) & Chr(10) or
2) Linefeed: Chr(10)
depending on the operating system." +msgid "inputstr: The string to be checked. If empty, the method returns False." msgstr "" -#. EMV7g +#. 7EBbA #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id541584978666991\n" +"par_id891580133307100\n" "help.text" -msgid "Yes" +msgid "Returns the input string center-justified." msgstr "" -#. VrjGQ +#. TLmnE #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id741584978666508\n" +"par_id571612380829021\n" "help.text" -msgid "Horizontal tabulation: Chr(9)" +msgid "The leading and trailing white spaces are stripped and the remaining characters are completed left and right up to a specified total length with the character padding." msgstr "" -#. Ee5CF +#. 4uuQT #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id461584978880380\n" +"par_id911580133391827\n" "help.text" -msgid "You can use the properties above to identify or insert the corresponding characters inside strings. For example, the Linefeed can be replaced by SF_String.sfLF." +msgid "inputstr: The string to be center-justified. If empty, the method returns an empty string." msgstr "" -#. DDXd3 +#. jHJNT #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id891611613601554\n" +"par_id671580133694946\n" "help.text" -msgid "List of Methods in the String Service" +msgid "length: The length of the resulting string (default = the length of the input string)." msgstr "" -#. TFfR3 +#. A3qof #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id151611951803163\n" +"par_id511612381090109\n" "help.text" -msgid "The first argument of most methods is the string to be considered. It is always passed by reference and left unchanged. Methods such as Capitalize, Escape, etc return a new string after their execution." +msgid "If the specified length is shorter than the center-justified input string, then the returned string is truncated." msgstr "" -#. PYcny +#. V5xMA #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id371627158142730\n" +"par_id101580133705268\n" "help.text" -msgid "Because Python has comprehensive built-in string support, most of the methods in the String service are available for Basic scripts only. The methods available for Basic and Python are: HashStr, IsADate, IsEmail, IsFileName, IsIBAN, IsIPv4, IsLike, IsSheetName, IsUrl, SplitNotQuoted and Wrap." +msgid "padding: The single character to be used as padding (default = the ASCII space \" \")." msgstr "" -#. jaBZR +#. 4zk3p #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id271579683706571\n" +"par_id911580135466348\n" "help.text" -msgid "Capitalizes the first character from each word in the input string." +msgid "Returns the input string left-justified." msgstr "" -#. ibgky +#. 9KeCE #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id941582304592013\n" +"par_id431612381917641\n" "help.text" -msgid "inputstr: The string to be capitalized." +msgid "The leading white spaces are stripped and the remaining characters are completed to the right up to a specified total length with the character padding." msgstr "" -#. DB982 +#. UQXSM #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id891582384556756\n" +"par_id281580135523448\n" "help.text" -msgid "Counts the number of occurrences of a substring or a regular expression within a string." +msgid "inputstr: The string to be left-justified. If empty, the method returns an empty string." msgstr "" -#. DxK5L +#. EAwAa #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id571582384689863\n" +"par_id431580135534910\n" "help.text" -msgid "inputstr: The input string to be examined" +msgid "length: The length of the resulting string (default = the length of the input string)." msgstr "" -#. QUeur +#. ntKXx #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id601582384696486\n" +"par_id161612381664182\n" "help.text" -msgid "substring: The substring or the regular expression to be used during search" +msgid "If the specified length is shorter than the left-justified input string, then the returned string is truncated." msgstr "" -#. vGiqm +#. mjmdP #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id451582384703719\n" +"par_id221580135568475\n" "help.text" -msgid "isregex: Use True if the substring is a regular expression (Default = False)" +msgid "padding: The single character to be used as padding (default = the ASCII space \" \")." msgstr "" -#. WiFme +#. TTokb #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id141582384726168\n" +"par_id821580136091225\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "Returns the input string right-justified." msgstr "" -#. QcE5q +#. 4fG7c #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"bas_id371582384749769\n" +"par_id771612382000293\n" "help.text" -msgid "'Counts the occurrences of the substring \"or\" inside the input string (returns 2)" +msgid "The leading white spaces are stripped and the remaining characters are completed to the left up to a specified total length with the character padding." msgstr "" -#. XXCR4 +#. KxskT #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"bas_id561582384801586\n" +"par_id201580136154170\n" "help.text" -msgid "'Counts the number of words with only lowercase letters (returns 7)" +msgid "inputstr: The string to be right-justified. If empty, the method returns an empty string." msgstr "" -#. zS3nb +#. FboQc #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id131612223767126\n" +"par_id71580136164632\n" "help.text" -msgid "To learn more about regular expressions, refer to the Python's documentation on Regular Expression Operations." +msgid "length: The length of the resulting string (default = the length of the input string)." msgstr "" -#. CCzMc +#. dshKE #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id581579687739629\n" +"par_id191612381732163\n" "help.text" -msgid "Returns True if a string ends with a specified substring." +msgid "If the specified length is shorter than the right-justified input string, then the returned string is truncated." msgstr "" -#. cAmFW +#. E2fug #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id21612306392239\n" +"par_id751580136200680\n" "help.text" -msgid "The function returns False when either the string or the substring have a length = 0 or when the substring is longer than the string." +msgid "padding: The single character to be used as padding (default = the ASCII space \" \")." msgstr "" -#. qk5nE +#. Wn55u #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id191579861552201\n" +"par_id251580136888958\n" "help.text" -msgid "inputstr: The string to be tested." +msgid "Returns the input string enclosed in single or double quotes. Existing quotes are left unchanged, including leading and/or trailing quotes." msgstr "" -#. ErigR +#. YBvt4 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id211579861561473\n" +"par_id811580136944674\n" "help.text" -msgid "substring: The substring to be searched at the end of inputstr." +msgid "inputstr: The string to quote." msgstr "" -#. 4DKkW +#. GynWV #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id801579861574009\n" +"par_id581599129397412\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "quotechar: Either the single (') or double (\") quote (default)." msgstr "" -#. gn2F8 +#. fY3PC #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"bas_id811579862998452\n" +"par_id911612382537087\n" "help.text" -msgid "'Returns True because the method was called with the default CaseSensitive = False" +msgid "This method can be useful while preparing a string field to be stored in a csv-like file, which requires that text values be enclosed with single or double quotes." msgstr "" -#. vJDmx +#. 8Rr4M #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"bas_id231579863168747\n" +"par_id951580139124650\n" "help.text" -msgid "'Returns False due to the CaseSensitive parameter" +msgid "Replaces all occurrences of the characters specified in the Before parameter by the corresponding characters specified in After." msgstr "" -#. zThMM +#. 5hn2y #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id921585921441429\n" +"par_id1001612384040018\n" "help.text" -msgid "Converts linebreaks and tabs contained in the input string to their equivalent escaped sequence (\\\\, \\n, \\r, \\t)." +msgid "If the length of Before is greater than the length of After, the residual characters in Before are replaced by the last character in After." msgstr "" -#. kBiBE +#. DD2CL #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id9158592144110\n" +"par_id11580139160633\n" "help.text" -msgid "inputstr: The string to be converted." +msgid "inputstr: The input string on which replacements will occur." msgstr "" -#. cpLKD +#. DvaRE #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"bas_id901585921441483\n" +"par_id111580139169795\n" "help.text" -msgid "'Returns the string \"abc\\n\\tdef\\\\n\"" +msgid "before: A string with the characters that will be searched in the input string for replacement." msgstr "" -#. ADN8M +#. N46b3 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id271579868053137\n" +"par_id851580139182113\n" "help.text" -msgid "Replaces Tab characters Chr(9) by space characters to replicate the behavior of tab stops." +msgid "after: A string with the new characters that will replace those defined in before." msgstr "" -#. Eb23Z +#. CDuCC #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id951579868064344\n" +"bas_id921580139218457\n" "help.text" -msgid "If a line break is found, a new line is started and the character counter is reset." +msgid "' Replaces accented characters" msgstr "" -#. E73Ko +#. 5ww5A #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id231579868290408\n" +"par_id151612442904499\n" "help.text" -msgid "inputstr: The string to be expanded" +msgid "The SF_String service provides useful public constants for the Latin character sets, as shown in the example below:" msgstr "" -#. 9dyYc +#. 9SPjv #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id281579868299807\n" +"par_id671580140272818\n" "help.text" -msgid "tabsize: This parameter is used to determine the Tab stops using the formula: TabSize + 1, 2 * TabSize + 1 , ... N * TabSize + 1 (Default = 8)" +msgid "Replaces all occurrences of a given regular expression by a new string." msgstr "" -#. GUoE8 +#. ujCyu #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id161579874552729\n" +"par_id471580140311626\n" "help.text" -msgid "Replaces all non-printable characters in the input string by a given character." +msgid "inputstr: The input string on which replacements will occur." msgstr "" -#. GpHwp +#. o2DS2 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id431579874633865\n" +"par_id651580140322666\n" "help.text" -msgid "inputstr: The string to be searched" +msgid "regex: The regular expression." msgstr "" -#. GttDN +#. itEEd #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id31579874656437\n" +"par_id891580140334754\n" "help.text" -msgid "replacedby: Zero, one or more characters that will replace all non-printable characters in inputstr (Default = \"\")" +msgid "newstr: The replacing string." msgstr "" -#. W44TL +#. gJRAr #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id1001579876228707\n" +"par_id581580140345221\n" "help.text" -msgid "Finds in a string a substring matching a given regular expression." +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. aq28M +#. ykPVR #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id131579876314120\n" +"bas_id961612384647003\n" "help.text" -msgid "inputstr: The string to be searched" +msgid "' \"Lxxxx xxxxx xxxxx xxx xxxx, xxxxxxxxxxx xxxxxxxxxx xxxx.\" (each lowercase letter is replaced by \"x\")" msgstr "" -#. hRrBB +#. rkMsv #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id751579876371545\n" +"bas_id751612384623936\n" "help.text" -msgid "regex: The regular expression" +msgid "' \"x x x x x, x x x.\" (each word is replaced by \"x\")" msgstr "" -#. y2Fqs +#. 2Gd5C #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id881579876394584\n" +"par_id51580146471894\n" "help.text" -msgid "start: The position in the string where the search will begin. This parameter is passed by reference, so after execution the value of start will point to the first character of the found substring. If no matching substring is found, start will be set to 0." +msgid "Replaces in a string some or all occurrences of an array of strings by an array of new strings." msgstr "" -#. yZMDg +#. SDpot #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id251579876403831\n" +"par_id831580146504326\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "inputstr: The input string on which replacements will occur." msgstr "" -#. A4JC7 +#. UfuEm #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id841579876412287\n" +"par_id411580146514927\n" "help.text" -msgid "forward: Determines the direction of the search. If True, search moves forward. If False search moves backwards (Default = True)" +msgid "oldstr: A single string or an array of strings. Zero-length strings are ignored." msgstr "" -#. SkaCi +#. Ukr3F #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id451612309155653\n" +"par_id591580146532966\n" "help.text" -msgid "At the first iteration, if forward = True, then start should be equal to 1, whereas if forward = False then start should be equal to Len(inputstr)" +msgid "newstr: The replacing string or the array of replacing strings." msgstr "" -#. gv3oo +#. 7BQ7F #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id221612309579001\n" +"par_id611612384873347\n" "help.text" -msgid "In the example above, the new value of lStart can be used to keep searching the same input string by setting the Start parameter to lStart + Len(result) at the next iteration." +msgid "If oldstr is an array, each occurrence of any of the items in oldstr is replaced by newstr." msgstr "" -#. qAkN4 +#. AfRz6 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id471601048983628\n" +"par_id611612384880820\n" "help.text" -msgid "Hash functions are used inside some cryptographic algorithms, in digital signatures, message authentication codes, manipulation detection, fingerprints, checksums (message integrity check), hash tables, password storage and much more." +msgid "If oldstr and newstr are arrays, replacements occur one by one up to the UBound(newstr)." msgstr "" -#. HupGD +#. E39aH #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id301601048983765\n" +"par_id241612385058264\n" "help.text" -msgid "The HashStr method returns the result of a hash function applied on a given string and using a specified algorithm, as a string of lowercase hexadecimal digits." +msgid "If oldstr has more entries than newstr, then the residual elements in oldstr are replaced by the last element in newstr." msgstr "" -#. ZRZEF +#. MkqW5 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id631601048983149\n" +"par_id701580146547619\n" "help.text" -msgid "The hash algorithms supported are: MD5, SHA1, SHA224, SHA256, SHA384 and SHA512." +msgid "occurrences: The maximum number of replacements. The default value is 0, meaning that all occurrences will be replaced." msgstr "" -#. yUmmb +#. QX33p #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id621601048983210\n" +"par_id741612385380533\n" "help.text" -msgid "inputstr: The string to hash. It is presumed to be encoded in UTF-8. The hashing algorithm will consider the string as a stream of bytes." +msgid "When oldstr is an array, the occurrence parameter is computed separately for each item in the array." msgstr "" -#. nuQRb +#. aWrvA #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id941601048983822\n" +"par_id301580146556599\n" "help.text" -msgid "algorithm: One of the supported algorithms listed above, passed as a string." +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. TXGmB +#. eygyi #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id221579879516929\n" +"par_id901580147558931\n" "help.text" -msgid "Encodes the input string into the HTML character codes, replacing special characters by their & counterparts." +msgid "Returns a string with a readable representation of the argument, truncated at a given length. This is useful mainly for debugging or logging purposes." msgstr "" -#. YNfid +#. cU3Ev #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id341612351999692\n" +"par_id11612386054691\n" "help.text" -msgid "For example, the character é would be replaced by é or an equivalent numerical HTML code." +msgid "If the anyvalue parameter is an object, it will be enclosed with square brackets \"[\" and \"]\"." msgstr "" -#. CGFQH +#. gVB32 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"bas_id501579879570781\n" +"par_id491612386081802\n" "help.text" -msgid "inputstr: The string to encode." +msgid "In strings, tabs and line breaks are replaced by \\t, \\n or \\r." msgstr "" -#. jpv97 +#. SfUGD #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id171579880990533\n" +"par_id921612386089103\n" "help.text" -msgid "Returns True if the input string is a valid date according to a specified date format." +msgid "If the final length exceeds the maxlength parameter, the latter part of the string is replaced by \" ... (N)\" where N is the total length of the original string before truncation." msgstr "" -#. tBGBH +#. zLfNR #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id151579881091821\n" +"par_id91580147593626\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False" +msgid "anyvalue: The input value to be represented. It can be any value, such as a string, an array, a Basic object, a UNO object, etc." msgstr "" -#. nmTv3 +#. hdDFi #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id991579881107670\n" +"par_id811580147609322\n" "help.text" -msgid "dateformat: The date format, as a string. It can be either \"YYYY-MM-DD\" (default), \"DD-MM-YYYY\" or \"MM-DD-YYYY\"" +msgid "maxlength: The maximum length of the resulting string. The default value is 0, meaning there is no limit to the length of the resulting representation." msgstr "" -#. GvZLC +#. Ape7i #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id291579881117126\n" +"par_id641612386659292\n" "help.text" -msgid "The dash (-) may be replaced by a dot (.), a slash (/) or a space." +msgid "Note that the representation of data types such as Arrays and ScriptForge.Dictionary object instances include both the data type and their values:" msgstr "" -#. yCA3T +#. ZFFAD #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id51579881125801\n" +"bas_id971612386906463\n" "help.text" -msgid "If the format is invalid, the method returns False." +msgid "' An example with a Basic built-in Array" msgstr "" -#. 6B2Em +#. GEZzM #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id211612370427721\n" +"bas_id401612386876329\n" "help.text" -msgid "This method checks the format of the input string without performing any calendar-specific checks. Hence it does not test the input string for leap years or months with 30 or 31 days. For that, refer to the IsDate built-in function." +msgid "' An example with a ScriptForge Array" msgstr "" -#. DJQFQ +#. mZ3ar #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id181612371147364\n" +"bas_id551612386931680\n" "help.text" -msgid "The example below shows the difference between the methods IsADate (ScriptForge) and the IsDate (built-in) function." +msgid "' An example with a ScriptForge Dictionary" msgstr "" -#. hAADi +#. vvADG #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id161579881600317\n" +"par_id411580312925741\n" "help.text" -msgid "Returns True if all characters in the string are alphabetic." +msgid "Returns the input string in reversed order." msgstr "" -#. 25Avc +#. RxpPa #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id251579881615469\n" +"par_id141612387177873\n" "help.text" -msgid "Alphabetic characters are those characters defined in the Unicode Character Database as Letter." +msgid "This method is equivalent to the built-in StrReverse Basic function." msgstr "" -#. a9rTa +#. ZEarP #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id11579881691826\n" +"par_id961612387463144\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "To use the StrReverse function, the statement Option VBASupport 1 must be present in the module." msgstr "" -#. KaLGv +#. pSyL6 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id421579883181382\n" +"par_id241580312964497\n" "help.text" -msgid "Returns True if all characters in the string are alphabetic, digits or \"_\" (underscore). The first character must not be a digit." +msgid "inputstr: The string to be reversed." msgstr "" -#. BAEB4 +#. KBFDk #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id31579884464101\n" +"par_id721580210762286\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "Returns a zero-based array of strings with the lines in the input string. Each item in the array is obtained by splitting the input string at newline characters." msgstr "" -#. sdSga +#. nuUF6 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id671580039484786\n" +"par_id481580210806878\n" "help.text" -msgid "Returns True if all characters in the string are ASCII characters." +msgid "inputstr: The string to be split." msgstr "" -#. 3DNou +#. FEFUw #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id791580039528838\n" +"par_id231580210820309\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "keepbreaks: When True, line breaks are preserved in the output array (default = False)." msgstr "" -#. iuPF4 +#. HAG8Q #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id861580044805749\n" +"par_id471580211762739\n" "help.text" -msgid "Returns True if all characters in the string are digits." +msgid "Splits a string into an array of elements using a specified delimiter." msgstr "" -#. yU7cc +#. zsADB #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id41580044873043\n" +"par_id281612388034501\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "If a quoted substring contains a delimiter, it is ignored. This is useful when parsing CSV-like records that contain quoted strings." msgstr "" -#. J8Ykx +#. JKAaG #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id521580045221758\n" +"par_id881580211809490\n" "help.text" -msgid "Returns True if the string is a valid email address." +msgid "inputstr: The string to be split." msgstr "" -#. 8Pxsn +#. PFDPa #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id841580045280071\n" +"par_id811580211821162\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "delimiter: A string of one or more characters that will be used as delimiter. The default delimiter is the ASCII space \" \" character." msgstr "" -#. R6MsU +#. 3rGRu #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id41580047039666\n" +"par_id181580211833778\n" "help.text" -msgid "Returns True if the string is a valid filename in a given operating system." +msgid "occurrences: The maximum number of substrings to return. The default value is 0, meaning that there is no limit to the number of returned strings." msgstr "" -#. aQbRF +#. W2og7 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id801580047079938\n" +"par_id421599123777334\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "quotechar: Either the single (') or double (\") quote." msgstr "" -#. jWMpJ +#. DiYMJ #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id781580047088954\n" +"par_id661627251379676\n" "help.text" -msgid "osname: The operating system name, as a string. It can be \"WINDOWS\", \"LINUX\", \"MACOSX\" or \"SOLARIS\"." +msgid "Beware of the differences between Basic and Python when representing strings. For example, in Basic two \"\" characters inside a string are interpreted as a single \" character. In Python, strings enclosed with single quotes can contain \" characters without having to double them." msgstr "" -#. GnrxA +#. 6Q2tJ #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id991612372824234\n" +"par_id771580212837884\n" "help.text" -msgid "The default value is the current operating system on which the script is running." +msgid "Returns True if the first characters of a string are identical to a given substring." msgstr "" -#. FPuAV +#. BYx4G #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id911580047551929\n" +"par_id781612393174350\n" "help.text" -msgid "Returns True if all characters in the string are hexadecimal digits." +msgid "This method returns False if either the input string or the substring have a length = 0 or when the substring is longer than the input string." msgstr "" -#. hWqAh +#. jrzxu #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id331580047594144\n" +"par_id271580212876135\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "inputstr: The string to be tested." msgstr "" -#. kEz4y +#. tE9WD #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id521612377109554\n" +"par_id571580212889462\n" "help.text" -msgid "The hexadecimal digits may be prefixed with \"0x\" or \"&H\"." +msgid "substring: The substring to be searched at the start of inputstr." msgstr "" -#. 3WKNf +#. ZeQP4 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id791584008420941\n" +"par_id811580212900799\n" "help.text" -msgid "Returns True if the string is a valid International Bank Account Number (IBAN). The comparison is not case-sensitive." +msgid "casesensitive: The search can be case sensitive or not (Default = False)." msgstr "" -#. DnC6i +#. DGgBx #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id951880048466565\n" +"par_id911580295999690\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "Returns the input string without its leading and trailing whitespaces." msgstr "" -#. VgT3x +#. BESEu #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id631619526542367\n" +"par_id541580296044377\n" "help.text" -msgid "True if the string contains a valid IBAN number." +msgid "inputstr: The string to trim." msgstr "" -#. CcTNk +#. 44XZC #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id791580048420941\n" +"par_id61580483096936\n" "help.text" -msgid "Returns True if the string is a valid IP(v4) address." +msgid "Converts any escaped sequence (\\\\, \\n, \\r, \\t) in the input string to their corresponding ASCII character." msgstr "" -#. rMpXB +#. mzTsG #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id981580048466565\n" +"par_id971580483124743\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "inputstr: The string to be converted." msgstr "" -#. yWHew +#. BoYHV #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id831580049093038\n" +"par_id831580213634029\n" "help.text" -msgid "Returns True if the whole input string matches a given pattern containing wildcards." +msgid "Removes the single or double quotes enclosing the input string." msgstr "" -#. PzigS +#. Ae8c5 #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id141580049142548\n" +"par_id811612393585600\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "This is useful when parsing CSV-like records that contain quoted strings." msgstr "" -#. XEBzh +#. BhVvp #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id31580049154551\n" +"par_id761580213677493\n" "help.text" -msgid "pattern: The pattern as a string. Wildcards are:" +msgid "inputstr: The string to unquote." msgstr "" -#. ZCzDP +#. gRUHA #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id181612441703306\n" +"par_id211599129509890\n" "help.text" -msgid "\"?\" represents any single character;" +msgid "quotechar: Either the single (') or double (\") quote (default)." msgstr "" -#. CFPcW +#. nGq4Q #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id861612377611438\n" +"bas_id371580213702598\n" "help.text" -msgid "\"*\" represents zero, one, or multiple characters." +msgid "' s = \"Some text\" (without enclosing quotes)" msgstr "" -#. eLYBF +#. Fp8ip #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id991580049206617\n" +"bas_id51580213693694\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "' The string below does not have enclosing quotes, so it remains unchanged" msgstr "" -#. kSMmn +#. A4Eki #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id581580050048679\n" +"bas_id961612393917830\n" "help.text" -msgid "Returns True if all characters in the string are in lowercase. Non-alphabetic characters are ignored." +msgid "' s = \"Some text\" (unchanged)" msgstr "" -#. nWGvX +#. ULtxx #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id751580050122938\n" +"bas_id461612394182689\n" "help.text" -msgid "InputStr: The string to be checked. If empty, the method returns False." +msgid "' Quotes inside the string are not removed" msgstr "" -#. BzD3y +#. 8w4ia #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id231580051650488\n" +"bas_id961612394171208\n" "help.text" -msgid "Returns True if all characters in the string are printable." +msgid "' s = \"The \"\"true\"\" meaning\" (unchanged)" msgstr "" -#. gUhut +#. JGhWK #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id721580051706431\n" +"par_id871585834468102\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "Converts the input string into an array of substrings so that each item in the array has at most a given number of characters." msgstr "" -#. HYBp5 +#. 4G9FU #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id281580052400960\n" +"par_id21612394465120\n" "help.text" -msgid "Returns True if the whole input string matches a given regular expression." +msgid "In practice, this method returns a zero-based array of output lines, without newlines at the end, except for the pre-existing line-breaks." msgstr "" -#. ZuBxC +#. BN3eR #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id161580052454770\n" +"par_id601612395193333\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "Tabs are expanded using the same procedure performed by the ExpandTabs method." msgstr "" -#. mi4mi +#. vLtDg #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id581580052467973\n" +"par_id641612394826616\n" "help.text" -msgid "regex: The regular expression. If empty, the method returns False." +msgid "Symbolic line breaks are replaced by their equivalent ASCII characters." msgstr "" -#. vmqZM +#. y7VvP #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id621580052654341\n" +"par_id361612394859733\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "If the wrapped output has no content, the returned array is empty." msgstr "" -#. iZSEw +#. SNRzH #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id1001589460240467\n" +"par_id251585834468498\n" "help.text" -msgid "Returns True if the input string is a valid Calc sheet name." +msgid "inputstr: The string to wrap." msgstr "" -#. xPFLm +#. MiptC #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id671589460240552\n" +"par_id351585834773177\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "width: The maximum number of characters in each line (Default = 70)." msgstr "" -#. uE5gz +#. epG6z #: sf_string.xhp msgctxt "" "sf_string.xhp\n" -"par_id551612442002823\n" +"par_id741585834874500\n" "help.text" -msgid "A sheet name must not contain the characters [ ] * ? : / \\ or the character ' (apostrophe) as first or last character." +msgid "tabsize: Before wrapping the text, the existing TAB Chr(9) characters are replaced with spaces. The argument tabsize defines the TAB stops at TabSize + 1, 2 * TabSize + 1 , ... N * TabSize + 1 (Default = 8)." msgstr "" -#. ALdgg -#: sf_string.xhp +#. HjZDB +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id371580293093655\n" +"sf_textstream.xhp\n" +"tit\n" "help.text" -msgid "Returns True if the first character of every word is in uppercase and the other characters are in lowercase." +msgid "ScriptForge.TextStream service" msgstr "" -#. uVF9U -#: sf_string.xhp +#. yCCia +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id471580293142283\n" +"sf_textstream.xhp\n" +"bm_id351585330787295\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "ScriptForge.TextStream service" msgstr "" -#. 7Ryzp -#: sf_string.xhp +#. nBJsE +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id801580128672004\n" +"sf_textstream.xhp\n" +"par_id511585330787205\n" "help.text" -msgid "Returns True if all characters in the string are in uppercase. Non alphabetic characters are ignored." +msgid "The TextStream service is used to sequentially read from and write to files opened or created using the ScriptForge.FileSystem service." msgstr "" -#. HFDCW -#: sf_string.xhp +#. TeRTa +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id391580128736809\n" +"sf_textstream.xhp\n" +"par_id41613596903894\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "The methods OpenTextFile and CreateTextFile from the FileSystem service return an instance of the TextStream service." msgstr "" -#. BTRpG -#: sf_string.xhp +#. MVFWC +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id531580132067813\n" +"sf_textstream.xhp\n" +"par_id161585330787262\n" "help.text" -msgid "Returns True if the string is a valid absolute URL (Uniform Resource Locator) address. Only the http, https and ftp protocols are supported." +msgid "Line delimiters may be specified by the user. In input operations CR, LF or CR+LF are supported. In output operations, the default line delimiter is the one used by the operating system." msgstr "" -#. HrFqG -#: sf_string.xhp +#. GDkir +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id321580132113593\n" +"sf_textstream.xhp\n" +"par_id831613598137669\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "The line delimiter for the operating system where the macro is being executed can be accessed using the SF_String.sfNEWLINE property." msgstr "" -#. wBAqG -#: sf_string.xhp +#. SvXzF +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id41580132491698\n" +"sf_textstream.xhp\n" +"par_id851613597445432\n" "help.text" -msgid "Returns True if all characters in the string are whitespaces" +msgid "All operations needed to read from or write to a file (open, read/write and close) are presumed to happen during the same macro run." msgstr "" -#. JDD85 -#: sf_string.xhp +#. dc5KN +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id801580132535511\n" +"sf_textstream.xhp\n" +"hd_id83158533078741\n" "help.text" -msgid "inputstr: The string to be checked. If empty, the method returns False." +msgid "Service invocation" msgstr "" -#. 7EBbA -#: sf_string.xhp +#. AuQX2 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id891580133307100\n" +"sf_textstream.xhp\n" +"par_id351613598192725\n" "help.text" -msgid "Returns the input string center-justified." +msgid "The examples below in Basic and Python use the OpenTextFile method to create an instance of the TextStream Service." msgstr "" -#. TLmnE -#: sf_string.xhp +#. UUudg +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id571612380829021\n" +"sf_textstream.xhp\n" +"par_id371585330787197\n" "help.text" -msgid "The leading and trailing white spaces are stripped and the remaining characters are completed left and right up to a specified total length with the character padding." +msgid "The file must be closed with the CloseFile method after all read or write operations have been executed:" msgstr "" -#. 4uuQT -#: sf_string.xhp +#. zNveN +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id911580133391827\n" +"sf_textstream.xhp\n" +"par_id891582733781994\n" "help.text" -msgid "inputstr: The string to be center-justified. If empty, the method returns an empty string." +msgid "Optionally, the resources used by the TextStream instance can be released using the Dispose method:" msgstr "" -#. jHJNT -#: sf_string.xhp +#. L8vEQ +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id671580133694946\n" +"sf_textstream.xhp\n" +"par_id121612917368946\n" "help.text" -msgid "length: The length of the resulting string (default = the length of the input string)." +msgid "The methods in the TextStream service are mostly based on the XTextInputStream and XTextOutputStream UNO interfaces." msgstr "" -#. A3qof -#: sf_string.xhp +#. JAmgD +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id511612381090109\n" +"sf_textstream.xhp\n" +"hd_id941585330787948\n" "help.text" -msgid "If the specified length is shorter than the center-justified input string, then the returned string is truncated." +msgid "Properties" msgstr "" -#. V5xMA -#: sf_string.xhp +#. aN9zM +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id101580133705268\n" +"sf_textstream.xhp\n" +"par_id631585330787267\n" "help.text" -msgid "padding: The single character to be used as padding (default = the ASCII space \" \")." +msgid "Name" msgstr "" -#. 4zk3p -#: sf_string.xhp +#. vwGC5 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id911580135466348\n" +"sf_textstream.xhp\n" +"par_id401585330787370\n" "help.text" -msgid "Returns the input string left-justified." +msgid "Readonly" msgstr "" -#. 9KeCE -#: sf_string.xhp +#. GpL38 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id431612381917641\n" +"sf_textstream.xhp\n" +"par_id581585330787700\n" "help.text" -msgid "The leading white spaces are stripped and the remaining characters are completed to the right up to a specified total length with the character padding." +msgid "Type" msgstr "" -#. UQXSM -#: sf_string.xhp +#. 6FDuM +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id281580135523448\n" +"sf_textstream.xhp\n" +"par_id551585330787608\n" "help.text" -msgid "inputstr: The string to be left-justified. If empty, the method returns an empty string." +msgid "Description" msgstr "" -#. EAwAa -#: sf_string.xhp +#. ECkTm +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id431580135534910\n" +"sf_textstream.xhp\n" +"par_id181585330787752\n" "help.text" -msgid "length: The length of the resulting string (default = the length of the input string)." +msgid "Yes" msgstr "" -#. ntKXx -#: sf_string.xhp +#. YFkaY +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id161612381664182\n" +"sf_textstream.xhp\n" +"par_id901585330787680\n" "help.text" -msgid "If the specified length is shorter than the left-justified input string, then the returned string is truncated." +msgid "Used in read mode. A True value indicates that the end of the file has been reached. A test using this property should precede calls to the ReadLine method." msgstr "" -#. mjmdP -#: sf_string.xhp +#. EFEnA +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id221580135568475\n" +"sf_textstream.xhp\n" +"par_id561585330787568\n" "help.text" -msgid "padding: The single character to be used as padding (default = the ASCII space \" \")." +msgid "Yes" msgstr "" -#. TTokb -#: sf_string.xhp +#. cVCoJ +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id821580136091225\n" +"sf_textstream.xhp\n" +"par_id741585330787777\n" "help.text" -msgid "Returns the input string right-justified." +msgid "The character set to be used. The default encoding is \"UTF-8\"." msgstr "" -#. 4fG7c -#: sf_string.xhp +#. p5s3X +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id771612382000293\n" +"sf_textstream.xhp\n" +"par_id641585330787207\n" "help.text" -msgid "The leading white spaces are stripped and the remaining characters are completed to the left up to a specified total length with the character padding." +msgid "Yes" msgstr "" -#. KxskT -#: sf_string.xhp +#. JjEqX +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id201580136154170\n" +"sf_textstream.xhp\n" +"par_id281585330787614\n" "help.text" -msgid "inputstr: The string to be right-justified. If empty, the method returns an empty string." +msgid "Returns the name of the current file either in URL format or in the native operating system's format, depending on the current value of the FileNaming property of the FileSystem service." msgstr "" -#. FboQc -#: sf_string.xhp +#. goEnw +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id71580136164632\n" +"sf_textstream.xhp\n" +"par_id111585330787410\n" "help.text" -msgid "length: The length of the resulting string (default = the length of the input string)." +msgid "Yes" msgstr "" -#. dshKE -#: sf_string.xhp +#. MZS6Z +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id191612381732163\n" +"sf_textstream.xhp\n" +"par_id861585330787417\n" "help.text" -msgid "If the specified length is shorter than the right-justified input string, then the returned string is truncated." +msgid "Indicates the input/output mode. Possible values are \"READ\", \"WRITE\" or \"APPEND\"." msgstr "" -#. E2fug -#: sf_string.xhp +#. 7nTb9 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id751580136200680\n" +"sf_textstream.xhp\n" +"par_id87158533078795\n" "help.text" -msgid "padding: The single character to be used as padding (default = the ASCII space \" \")." +msgid "Yes" msgstr "" -#. Wn55u -#: sf_string.xhp +#. j45gC +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id251580136888958\n" +"sf_textstream.xhp\n" +"par_id561585330787741\n" "help.text" -msgid "Returns the input string enclosed in single or double quotes. Existing quotes are left unchanged, including leading and/or trailing quotes." +msgid "Returns the number of lines read or written so far." msgstr "" -#. YBvt4 -#: sf_string.xhp +#. CLAvQ +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id811580136944674\n" +"sf_textstream.xhp\n" +"par_id531585330787157\n" "help.text" -msgid "inputstr: The string to quote." +msgid "No" msgstr "" -#. GynWV -#: sf_string.xhp +#. rdA5M +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id581599129397412\n" +"sf_textstream.xhp\n" +"par_id691585330787279\n" "help.text" -msgid "quotechar: Either the single (') or double (\") quote (default)." +msgid "Sets or returns the current delimiter to be inserted between two successive written lines. The default value is the native line delimiter in the current operating system." msgstr "" -#. fY3PC -#: sf_string.xhp +#. veDBj +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id911612382537087\n" +"sf_textstream.xhp\n" +"par_id141613001281573\n" "help.text" -msgid "This method can be useful while preparing a string field to be stored in a csv-like file, which requires that text values be enclosed with single or double quotes." +msgid "To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets." msgstr "" -#. 8Rr4M -#: sf_string.xhp +#. hKJkD +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id951580139124650\n" +"sf_textstream.xhp\n" +"par_id891611613601554\n" "help.text" -msgid "Replaces all occurrences of the characters specified in the Before parameter by the corresponding characters specified in After." +msgid "List of Methods in the TextStream Service" msgstr "" -#. 5hn2y -#: sf_string.xhp +#. DBBKM +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id1001612384040018\n" +"sf_textstream.xhp\n" +"par_id421585330787675\n" "help.text" -msgid "If the length of Before is greater than the length of After, the residual characters in Before are replaced by the last character in After." +msgid "Closes the current input or output stream and empties the output buffer if relevant. Returns True if the file was successfully closed." msgstr "" -#. DD2CL -#: sf_string.xhp +#. MCW3q +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id11580139160633\n" +"sf_textstream.xhp\n" +"par_id65158533078799\n" "help.text" -msgid "inputstr: The input string on which replacements will occur." +msgid "Returns all the remaining lines in the text stream as a single string. Line breaks are not removed." msgstr "" -#. DvaRE -#: sf_string.xhp +#. Vr34D +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id111580139169795\n" +"sf_textstream.xhp\n" +"par_id71613600347125\n" "help.text" -msgid "before: A string with the characters that will be searched in the input string for replacement." +msgid "The resulting string can be split in lines either by using the Split built-in Basic function if the line delimiter is known, or with the SF_String.SplitLines method." msgstr "" -#. N46b3 -#: sf_string.xhp +#. VRLGn +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id851580139182113\n" +"sf_textstream.xhp\n" +"par_id91585330787373\n" "help.text" -msgid "after: A string with the new characters that will replace those defined in before." +msgid "For large files, using the ReadAll method wastes memory resources. In such cases it is recommended to read the file line by line using the ReadLine method." msgstr "" -#. CDuCC -#: sf_string.xhp +#. BuBVA +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id921580139218457\n" +"sf_textstream.xhp\n" +"par_id921613595637851\n" "help.text" -msgid "' Replaces accented characters" +msgid "Consider the text file \"Students.txt\" with the following contents (a name in each line):" msgstr "" -#. 5ww5A -#: sf_string.xhp +#. hk7q4 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id151612442904499\n" +"sf_textstream.xhp\n" +"par_id391613596019750\n" "help.text" -msgid "The SF_String service provides useful public constants for the Latin character sets, as shown in the example below:" +msgid "The examples below in Basic and Python use the ReadAll and SplitLines methods to read the contents of the file into an array of strings:" msgstr "" -#. 9SPjv -#: sf_string.xhp +#. BuRJE +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id671580140272818\n" +"sf_textstream.xhp\n" +"bas_id251613595640550\n" "help.text" -msgid "Replaces all occurrences of a given regular expression by a new string." +msgid "'Loads the FileSystem service" msgstr "" -#. ujCyu -#: sf_string.xhp +#. L2a3D +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id471580140311626\n" +"sf_textstream.xhp\n" +"bas_id181613595641087\n" "help.text" -msgid "inputstr: The input string on which replacements will occur." +msgid "'Opens the text file with the names to be read" msgstr "" -#. o2DS2 -#: sf_string.xhp +#. rDCSD +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id651580140322666\n" +"sf_textstream.xhp\n" +"bas_id711613595642109\n" "help.text" -msgid "regex: The regular expression." +msgid "'Reads all the contents in the input file as a single string" msgstr "" -#. itEEd -#: sf_string.xhp +#. 6w73J +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id891580140334754\n" +"sf_textstream.xhp\n" +"bas_id961613595643093\n" "help.text" -msgid "newstr: The replacing string." +msgid "'Splits the string into an array" msgstr "" -#. gJRAr -#: sf_string.xhp +#. 7Fq9E +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id581580140345221\n" +"sf_textstream.xhp\n" +"par_id871585330787885\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "Returns the next line in the text stream as a string. Line breaks are removed from the returned string." msgstr "" -#. ykPVR -#: sf_string.xhp +#. 6iDcF +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id961612384647003\n" +"sf_textstream.xhp\n" +"par_id431613600221626\n" "help.text" -msgid "' \"Lxxxx xxxxx xxxxx xxx xxxx, xxxxxxxxxxx xxxxxxxxxx xxxx.\" (each lowercase letter is replaced by \"x\")" +msgid "The AtEndOfStream test should precede the ReadLine method like in the example below." msgstr "" -#. rkMsv -#: sf_string.xhp +#. GRRkq +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id751612384623936\n" +"sf_textstream.xhp\n" +"par_id171585330787774\n" "help.text" -msgid "' \"x x x x x, x x x.\" (each word is replaced by \"x\")" +msgid "An error will be raised if the AtEndOfStream was reached during the previous ReadLine or SkipLine method call." msgstr "" -#. 2Gd5C -#: sf_string.xhp +#. mAty4 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id51580146471894\n" +"sf_textstream.xhp\n" +"par_id11585330787847\n" "help.text" -msgid "Replaces in a string some or all occurrences of an array of strings by an array of new strings." +msgid "Skips the next line in the input stream when reading a TextStream file." msgstr "" -#. SDpot -#: sf_string.xhp +#. FDMJB +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id831580146504326\n" +"sf_textstream.xhp\n" +"par_id441613600704766\n" "help.text" -msgid "inputstr: The input string on which replacements will occur." +msgid "This method can result in AtEndOfStream being set to True." msgstr "" -#. UfuEm -#: sf_string.xhp +#. D4JVb +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id411580146514927\n" +"sf_textstream.xhp\n" +"par_id141585330787657\n" "help.text" -msgid "oldstr: A single string or an array of strings. Zero-length strings are ignored." +msgid "Writes a specified number of empty lines to the output stream." msgstr "" -#. Ukr3F -#: sf_string.xhp +#. YsBUm +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id591580146532966\n" +"sf_textstream.xhp\n" +"par_id291585330787357\n" "help.text" -msgid "newstr: The replacing string or the array of replacing strings." +msgid "lines: The number of empty lines to write to the file." msgstr "" -#. 7BQ7F -#: sf_string.xhp +#. GCPCC +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id611612384873347\n" +"sf_textstream.xhp\n" +"par_id101585330787215\n" "help.text" -msgid "If oldstr is an array, each occurrence of any of the items in oldstr is replaced by newstr." +msgid "Writes the given string to the output stream as a single line." msgstr "" -#. AfRz6 -#: sf_string.xhp +#. Eska7 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id611612384880820\n" +"sf_textstream.xhp\n" +"par_id421613601002074\n" "help.text" -msgid "If oldstr and newstr are arrays, replacements occur one by one up to the UBound(newstr)." +msgid "The character defined in the NewLine property is used as the line delimiter." msgstr "" -#. E39aH -#: sf_string.xhp +#. LXFPE +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id241612385058264\n" +"sf_textstream.xhp\n" +"par_id491585330787650\n" "help.text" -msgid "If oldstr has more entries than newstr, then the residual elements in oldstr are replaced by the last element in newstr." +msgid "line: The line to write, may be empty." msgstr "" -#. MkqW5 -#: sf_string.xhp +#. PM5Bx +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id701580146547619\n" +"sf_textstream.xhp\n" +"par_id821626894480105\n" "help.text" -msgid "occurrences: The maximum number of replacements. The default value is 0, meaning that all occurrences will be replaced." +msgid "The examples below in Basic and Python create a text file in CSV format in which each line contains a value and its square until lastValue is reached." msgstr "" -#. QX33p -#: sf_string.xhp +#. 39u4o +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id741612385380533\n" +"sf_textstream.xhp\n" +"bas_id21613321528612\n" "help.text" -msgid "When oldstr is an array, the occurrence parameter is computed separately for each item in the array." +msgid "'Instantiates the FileSystem Service" msgstr "" -#. aWrvA -#: sf_string.xhp +#. FnTiG +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id301580146556599\n" +"sf_textstream.xhp\n" +"bas_id191613321529277\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "'Creates a text file" msgstr "" -#. eygyi -#: sf_string.xhp +#. f5RSB +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id901580147558931\n" +"sf_textstream.xhp\n" +"bas_id641613321530181\n" "help.text" -msgid "Returns a string with a readable representation of the argument, truncated at a given length. This is useful mainly for debugging or logging purposes." +msgid "'Writes the Value and Value squared, separated by \";\"" msgstr "" -#. cU3Ev -#: sf_string.xhp +#. FCowk +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id11612386054691\n" +"sf_textstream.xhp\n" +"bas_id141613321530960\n" "help.text" -msgid "If the anyvalue parameter is an object, it will be enclosed with square brackets \"[\" and \"]\"." +msgid "myFile.WriteLine(\"Value;Value Squared\")" msgstr "" -#. gVB32 -#: sf_string.xhp +#. m9Mo4 +#: sf_textstream.xhp msgctxt "" -"sf_string.xhp\n" -"par_id491612386081802\n" +"sf_textstream.xhp\n" +"bas_id881613321532598\n" "help.text" -msgid "In strings, tabs and line breaks are replaced by \\t, \\n or \\r." +msgid "'Closes the file and free resources" msgstr "" -#. SfUGD -#: sf_string.xhp +#. PCSPY +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id921612386089103\n" +"sf_timer.xhp\n" +"tit\n" "help.text" -msgid "If the final length exceeds the maxlength parameter, the latter part of the string is replaced by \" ... (N)\" where N is the total length of the original string before truncation." +msgid "ScriptForge.Timer service" msgstr "" -#. zLfNR -#: sf_string.xhp +#. uvCrq +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id91580147593626\n" +"sf_timer.xhp\n" +"hd_id731582733781114\n" "help.text" -msgid "anyvalue: The input value to be represented. It can be any value, such as a string, an array, a Basic object, a UNO object, etc." +msgid "ScriptForge.Timer service" msgstr "" -#. hdDFi -#: sf_string.xhp +#. WyVvH +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id811580147609322\n" +"sf_timer.xhp\n" +"par_id961582733781662\n" "help.text" -msgid "maxlength: The maximum length of the resulting string. The default value is 0, meaning there is no limit to the length of the resulting representation." +msgid "The Timer service measures the amount of time it takes to run user scripts." msgstr "" -#. Ape7i -#: sf_string.xhp +#. qDa8E +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id641612386659292\n" +"sf_timer.xhp\n" +"par_id181582733781323\n" "help.text" -msgid "Note that the representation of data types such as Arrays and ScriptForge.Dictionary object instances include both the data type and their values:" +msgid "A Timer measures durations. It can be:" msgstr "" -#. ZFFAD -#: sf_string.xhp +#. ErpLm +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id971612386906463\n" +"sf_timer.xhp\n" +"par_id711582733781252\n" "help.text" -msgid "' An example with a Basic built-in Array" +msgid "Started, to indicate when to start measuring time." msgstr "" -#. GEZzM -#: sf_string.xhp +#. NAAFg +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id401612386876329\n" +"sf_timer.xhp\n" +"par_id631582733781431\n" "help.text" -msgid "' An example with a ScriptForge Array" +msgid "Suspended, to pause measuring running time." msgstr "" -#. mZ3ar -#: sf_string.xhp +#. nt9Qc +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id551612386931680\n" +"sf_timer.xhp\n" +"par_id691582733781498\n" "help.text" -msgid "' An example with a ScriptForge Dictionary" +msgid "Resumed, to continue tracking running time after the Timer has been suspended." msgstr "" -#. vvADG -#: sf_string.xhp +#. DVCBM +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id411580312925741\n" +"sf_timer.xhp\n" +"par_id31582733781344\n" "help.text" -msgid "Returns the input string in reversed order." +msgid "Restarted, which will cancel previous measurements and start the Timer at zero." msgstr "" -#. RxpPa -#: sf_string.xhp +#. dm7yA +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id141612387177873\n" +"sf_timer.xhp\n" +"par_id991582733781280\n" "help.text" -msgid "This method is equivalent to the built-in StrReverse Basic function." +msgid "Durations are expressed in seconds with a precision of 3 decimal digits (milliseconds). A duration value of 12.345 means 12 seconds and 345 milliseconds" msgstr "" -#. ZEarP -#: sf_string.xhp +#. CVhDR +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id961612387463144\n" +"sf_timer.xhp\n" +"hd_id201582733781265\n" "help.text" -msgid "To use the StrReverse function, the statement Option VBASupport 1 must be present in the module." +msgid "Service invocation" msgstr "" -#. pSyL6 -#: sf_string.xhp +#. fYto9 +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id241580312964497\n" +"sf_timer.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "inputstr: The string to be reversed." +msgid "Before using the Timer service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. KBFDk -#: sf_string.xhp +#. SCYEX +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id721580210762286\n" +"sf_timer.xhp\n" +"par_id891610734806133\n" "help.text" -msgid "Returns a zero-based array of strings with the lines in the input string. Each item in the array is obtained by splitting the input string at newline characters." +msgid "The example below creates a Timer object named myTimer and starts it immediately." msgstr "" -#. nuUF6 -#: sf_string.xhp +#. WMZog +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id481580210806878\n" +"sf_timer.xhp\n" +"bas_id681582733781715\n" "help.text" -msgid "inputstr: The string to be split." +msgid "'The timer starts immediately when the second argument = True, default = False" msgstr "" -#. FEFUw -#: sf_string.xhp +#. CnZqc +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id231580210820309\n" +"sf_timer.xhp\n" +"par_id891582733781994\n" "help.text" -msgid "keepbreaks: When True, line breaks are preserved in the output array (default = False)." +msgid "It is recommended to free resources after use:" msgstr "" -#. HAG8Q -#: sf_string.xhp +#. 8h3fp +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id471580211762739\n" +"sf_timer.xhp\n" +"hd_id521582733781450\n" "help.text" -msgid "Splits a string into an array of elements using a specified delimiter." +msgid "Properties" msgstr "" -#. zsADB -#: sf_string.xhp +#. dVncX +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id281612388034501\n" +"sf_timer.xhp\n" +"par_id71582733781260\n" "help.text" -msgid "If a quoted substring contains a delimiter, it is ignored. This is useful when parsing CSV-like records that contain quoted strings." +msgid "Name" msgstr "" -#. JKAaG -#: sf_string.xhp +#. hFnkK +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id881580211809490\n" +"sf_timer.xhp\n" +"par_id711582733781103\n" "help.text" -msgid "inputstr: The string to be split." +msgid "Readonly" msgstr "" -#. PFDPa -#: sf_string.xhp +#. NvqK9 +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id811580211821162\n" +"sf_timer.xhp\n" +"par_id76158273378122\n" "help.text" -msgid "delimiter: A string of one or more characters that will be used as delimiter. The default delimiter is the ASCII space \" \" character." +msgid "Type" msgstr "" -#. 3rGRu -#: sf_string.xhp +#. 7zFYh +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id181580211833778\n" +"sf_timer.xhp\n" +"par_id751582733781926\n" "help.text" -msgid "occurrences: The maximum number of substrings to return. The default value is 0, meaning that there is no limit to the number of returned strings." +msgid "Description" msgstr "" -#. W2og7 -#: sf_string.xhp +#. T92or +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id421599123777334\n" +"sf_timer.xhp\n" +"par_id621582733781588\n" "help.text" -msgid "quotechar: Either the single (') or double (\") quote." +msgid "Yes" msgstr "" -#. DiYMJ -#: sf_string.xhp +#. 9yDgM +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id661627251379676\n" +"sf_timer.xhp\n" +"par_id731582733781476\n" "help.text" -msgid "Beware of the differences between Basic and Python when representing strings. For example, in Basic two \"\" characters inside a string are interpreted as a single \" character. In Python, strings enclosed with single quotes can contain \" characters without having to double them." +msgid "The actual running time elapsed since start or between start and stop (does not consider suspended time)" msgstr "" -#. 6Q2tJ -#: sf_string.xhp +#. ThAaG +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id771580212837884\n" +"sf_timer.xhp\n" +"par_id301582733781498\n" "help.text" -msgid "Returns True if the first characters of a string are identical to a given substring." +msgid "Yes" msgstr "" -#. BYx4G -#: sf_string.xhp +#. tqpDU +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id781612393174350\n" +"sf_timer.xhp\n" +"par_id401582733781608\n" "help.text" -msgid "This method returns False if either the input string or the substring have a length = 0 or when the substring is longer than the input string." +msgid "True when timer is started or suspended" msgstr "" -#. jrzxu -#: sf_string.xhp +#. pSPgk +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id271580212876135\n" +"sf_timer.xhp\n" +"par_id181582733781551\n" "help.text" -msgid "inputstr: The string to be tested." +msgid "Yes" msgstr "" -#. tE9WD -#: sf_string.xhp +#. SGyi4 +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id571580212889462\n" +"sf_timer.xhp\n" +"par_id161582733781328\n" "help.text" -msgid "substring: The substring to be searched at the start of inputstr." +msgid "True when timer is started and suspended" msgstr "" -#. ZeQP4 -#: sf_string.xhp +#. qoNpD +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id811580212900799\n" +"sf_timer.xhp\n" +"par_id651582733781874\n" "help.text" -msgid "casesensitive: The search can be case sensitive or not (Default = False)." +msgid "Yes" msgstr "" -#. DGgBx -#: sf_string.xhp +#. E45MD +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id911580295999690\n" +"sf_timer.xhp\n" +"par_id171582733781456\n" "help.text" -msgid "Returns the input string without its leading and trailing whitespaces." +msgid "The actual time elapsed while suspended since start or between start and stop" msgstr "" -#. BESEu -#: sf_string.xhp +#. gxF8S +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id541580296044377\n" +"sf_timer.xhp\n" +"par_id141582733781303\n" "help.text" -msgid "inputstr: The string to trim." +msgid "Yes" msgstr "" -#. 44XZC -#: sf_string.xhp +#. FeCob +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id61580483096936\n" +"sf_timer.xhp\n" +"par_id411582733781932\n" "help.text" -msgid "Converts any escaped sequence (\\\\, \\n, \\r, \\t) in the input string to their corresponding ASCII character." +msgid "The actual time elapsed since start or between start and stop (including suspensions and running time)" msgstr "" -#. mzTsG -#: sf_string.xhp +#. a63gW +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id971580483124743\n" +"sf_timer.xhp\n" +"par_id9158273378151\n" "help.text" -msgid "inputstr: The string to be converted." +msgid "Note that the TotalDuration property is equivalent to summing the Duration and SuspendDuration properties." msgstr "" -#. BoYHV -#: sf_string.xhp +#. Mav4g +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id831580213634029\n" +"sf_timer.xhp\n" +"hd_id141582734141895\n" "help.text" -msgid "Removes the single or double quotes enclosing the input string." +msgid "Methods" msgstr "" -#. Ae8c5 -#: sf_string.xhp +#. P8RQj +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id811612393585600\n" +"sf_timer.xhp\n" +"par_id291582734377752\n" "help.text" -msgid "This is useful when parsing CSV-like records that contain quoted strings." +msgid "All methods do not require arguments and return a Boolean value." msgstr "" -#. BhVvp -#: sf_string.xhp +#. onEib +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id761580213677493\n" +"sf_timer.xhp\n" +"par_id311582734894257\n" "help.text" -msgid "inputstr: The string to unquote." +msgid "If the returned value is False, then nothing happened." msgstr "" -#. gRUHA -#: sf_string.xhp +#. U82Do +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id211599129509890\n" +"sf_timer.xhp\n" +"par_id871582734180676\n" "help.text" -msgid "quotechar: Either the single (') or double (\") quote (default)." +msgid "Name" msgstr "" -#. nGq4Q -#: sf_string.xhp +#. 6oGwx +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id371580213702598\n" +"sf_timer.xhp\n" +"par_id971582734180676\n" "help.text" -msgid "' s = \"Some text\" (without enclosing quotes)" +msgid "Description" msgstr "" -#. Fp8ip -#: sf_string.xhp +#. ZMfpe +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id51580213693694\n" +"sf_timer.xhp\n" +"par_id911582734180676\n" "help.text" -msgid "' The string below does not have enclosing quotes, so it remains unchanged" +msgid "Returned value" msgstr "" -#. A4Eki -#: sf_string.xhp +#. 6DJTP +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id961612393917830\n" +"sf_timer.xhp\n" +"par_id301582734180676\n" "help.text" -msgid "' s = \"Some text\" (unchanged)" +msgid "Resumes the Timer if it has been suspended" msgstr "" -#. ULtxx -#: sf_string.xhp +#. ixF7A +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id461612394182689\n" +"sf_timer.xhp\n" +"par_id661582734180676\n" "help.text" -msgid "' Quotes inside the string are not removed" +msgid "False if the timer is not suspended" msgstr "" -#. 8w4ia -#: sf_string.xhp +#. AAozF +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"bas_id961612394171208\n" +"sf_timer.xhp\n" +"par_id821582734649305\n" "help.text" -msgid "' s = \"The \"\"true\"\" meaning\" (unchanged)" +msgid "Terminates the Timer and discards its current property values, restarting as a new clean Timer" msgstr "" -#. JGhWK -#: sf_string.xhp +#. UtCTT +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id871585834468102\n" +"sf_timer.xhp\n" +"par_id761582734649305\n" "help.text" -msgid "Converts the input string into an array of substrings so that each item in the array has at most a given number of characters." +msgid "False if the timer is inactive" msgstr "" -#. 4G9FU -#: sf_string.xhp +#. AkgAy +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id21612394465120\n" +"sf_timer.xhp\n" +"par_id641582734802443\n" "help.text" -msgid "In practice, this method returns a zero-based array of output lines, without newlines at the end, except for the pre-existing line-breaks." +msgid "Starts a new clean timer" msgstr "" -#. BN3eR -#: sf_string.xhp +#. B4gTh +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id601612395193333\n" +"sf_timer.xhp\n" +"par_id921582734802443\n" "help.text" -msgid "Tabs are expanded using the same procedure performed by the ExpandTabs method." +msgid "False if the timer is already started" msgstr "" -#. vLtDg -#: sf_string.xhp +#. D7CoH +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id641612394826616\n" +"sf_timer.xhp\n" +"par_id81582734905507\n" "help.text" -msgid "Symbolic line breaks are replaced by their equivalent ASCII characters." +msgid "Suspends a running timer" msgstr "" -#. y7VvP -#: sf_string.xhp +#. YbeSJ +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id361612394859733\n" +"sf_timer.xhp\n" +"par_id661582734905507\n" "help.text" -msgid "If the wrapped output has no content, the returned array is empty." +msgid "False if the timer is not started or already suspended" msgstr "" -#. SNRzH -#: sf_string.xhp +#. sgXra +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id251585834468498\n" +"sf_timer.xhp\n" +"par_id861582734996722\n" "help.text" -msgid "inputstr: The string to wrap." +msgid "Stops a running timer" msgstr "" -#. MiptC -#: sf_string.xhp +#. WkCCC +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id351585834773177\n" +"sf_timer.xhp\n" +"par_id381582734996722\n" "help.text" -msgid "width: The maximum number of characters in each line (Default = 70)." +msgid "False if the timer is neither started nor suspended" msgstr "" -#. epG6z -#: sf_string.xhp +#. DuD3h +#: sf_timer.xhp msgctxt "" -"sf_string.xhp\n" -"par_id741585834874500\n" +"sf_timer.xhp\n" +"par_id731626871820490\n" "help.text" -msgid "tabsize: Before wrapping the text, the existing TAB Chr(9) characters are replaced with spaces. The argument tabsize defines the TAB stops at TabSize + 1, 2 * TabSize + 1 , ... N * TabSize + 1 (Default = 8)." +msgid "The examples below in Basic and Python illustrate the use of the methods and properties in the Timer service." msgstr "" -#. HjZDB -#: sf_textstream.xhp +#. UgBnC +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"tit\n" +"sf_timer.xhp\n" +"bas_id141582735926821\n" "help.text" -msgid "ScriptForge.TextStream service" +msgid "'The time elapsed while the Dialog box is open will be counted as suspended time" msgstr "" -#. yCCia -#: sf_textstream.xhp +#. 4jHcj +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"bm_id351585330787295\n" +"sf_timer.xhp\n" +"bas_id901582735961725\n" "help.text" -msgid "ScriptForge.TextStream service" +msgid "'The time elapsed while the Dialog box is open will be counted as running time" msgstr "" -#. nBJsE -#: sf_textstream.xhp +#. 7QhZU +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id511585330787205\n" +"sf_timer.xhp\n" +"bas_id941610739926687\n" "help.text" -msgid "The TextStream service is used to sequentially read from and write to files opened or created using the ScriptForge.FileSystem service." +msgid "'Shows the final time measurements" msgstr "" -#. TeRTa -#: sf_textstream.xhp +#. J6XGB +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id41613596903894\n" +"sf_timer.xhp\n" +"par_id281610740093006\n" "help.text" -msgid "The methods OpenTextFile and CreateTextFile from the FileSystem service return an instance of the TextStream service." +msgid "If you call the Terminate method, subsequent calls for the Continue method will not resume time measurement. Similarly, after a Timer has been terminated, calling the Start method will restart it as if it were a clean new Timer." msgstr "" -#. MVFWC -#: sf_textstream.xhp +#. AqGfb +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id161585330787262\n" +"sf_timer.xhp\n" +"par_id391626872019832\n" "help.text" -msgid "Line delimiters may be specified by the user. In input operations CR, LF or CR+LF are supported. In output operations, the default line delimiter is the one used by the operating system." +msgid "Be aware that the Wait function in BASIC takes in a duration argument in milliseconds whereas the sleep function in Python uses seconds in its argument." msgstr "" -#. GDkir -#: sf_textstream.xhp +#. bHEyr +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id831613598137669\n" +"sf_timer.xhp\n" +"hd_id431610989623086\n" "help.text" -msgid "The line delimiter for the operating system where the macro is being executed can be accessed using the SF_String.sfNEWLINE property." +msgid "Working with Multiple Timers" msgstr "" -#. SvXzF -#: sf_textstream.xhp +#. dr779 +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id851613597445432\n" +"sf_timer.xhp\n" +"par_id741610989639201\n" "help.text" -msgid "All operations needed to read from or write to a file (open, read/write and close) are presumed to happen during the same macro run." +msgid "It is possible to instantiate multiple Timer services in parallel, which gives flexibility in measuring time in different parts of the code." msgstr "" -#. dc5KN -#: sf_textstream.xhp +#. ueLgB +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"hd_id83158533078741\n" +"sf_timer.xhp\n" +"par_id921610989722908\n" "help.text" -msgid "Service invocation" +msgid "The following example illustrates how to create two Timer objects and start them separately." msgstr "" -#. AuQX2 -#: sf_textstream.xhp +#. PtA4E +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id351613598192725\n" +"sf_timer.xhp\n" +"bas_id481610989853679\n" "help.text" -msgid "The examples below in Basic and Python use the OpenTextFile method to create an instance of the TextStream Service." +msgid "'Starts myTimerA" msgstr "" -#. UUudg -#: sf_textstream.xhp +#. VUdGW +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id371585330787197\n" +"sf_timer.xhp\n" +"bas_id331610989849501\n" "help.text" -msgid "The file must be closed with the CloseFile method after all read or write operations have been executed:" +msgid "'Starts myTimerB" msgstr "" -#. zNveN -#: sf_textstream.xhp +#. t98Fv +#: sf_timer.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id891582733781994\n" +"sf_timer.xhp\n" +"bas_id931610989837747\n" "help.text" -msgid "Optionally, the resources used by the TextStream instance can be released using the Dispose method:" +msgid "'Terminate both timers" msgstr "" -#. L8vEQ -#: sf_textstream.xhp +#. AuovU +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id121612917368946\n" +"sf_toc.xhp\n" +"tit\n" "help.text" -msgid "The methods in the TextStream service are mostly based on the XTextInputStream and XTextOutputStream UNO interfaces." +msgid "List of all ScriptForge methods and properties" msgstr "" -#. JAmgD -#: sf_textstream.xhp +#. zxZFp +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"hd_id941585330787948\n" +"sf_toc.xhp\n" +"hd_id461623364876507\n" "help.text" -msgid "Properties" +msgid "List of all ScriptForge methods and properties" msgstr "" -#. aN9zM -#: sf_textstream.xhp +#. 9cBCb +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id631585330787267\n" +"sf_toc.xhp\n" +"par_id691671192231981\n" "help.text" -msgid "Name" +msgid "This help page shows all methods and properties available in the ScriptForge library by service with links to the corresponding documentation." msgstr "" -#. vwGC5 -#: sf_textstream.xhp +#. 4NBjy +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id401585330787370\n" +"sf_toc.xhp\n" +"par_id401671192686811\n" "help.text" -msgid "Readonly" +msgid "The Basic source code for all ScriptForge services is available via Application Macros and Dialogs and is distributed in multiple libraries: ScriptForge, SFDatabases, SFDialogs, SFDocuments, SFUnitTests and SFWidgets. The Python portion of the source code is available in the program\\scriptforge.py file under the %PRODUCTNAME installation directory." msgstr "" -#. GpL38 -#: sf_textstream.xhp +#. MPEN4 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id581585330787700\n" +"sf_toc.xhp\n" +"hd_id101671192601663\n" "help.text" -msgid "Type" +msgid "ScriptForge.Array service" msgstr "" -#. 6FDuM -#: sf_textstream.xhp +#. xA5NE +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id551585330787608\n" +"sf_toc.xhp\n" +"hd_id101671192601553\n" "help.text" -msgid "Description" +msgid "SFDocuments.Base service" msgstr "" -#. ECkTm -#: sf_textstream.xhp +#. JFajQ +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id181585330787752\n" +"sf_toc.xhp\n" +"par_id541674484344235\n" "help.text" -msgid "Yes" +msgid "This service also supports the methods and properties defined in the Document service, which includes methods that are generic to all document types." msgstr "" -#. YFkaY -#: sf_textstream.xhp +#. pFPFA +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id901585330787680\n" +"sf_toc.xhp\n" +"hd_id101671192609363\n" "help.text" -msgid "Used in read mode. A True value indicates that the end of the file has been reached. A test using this property should precede calls to the ReadLine method." +msgid "ScriptForge.Basic service" msgstr "" -#. EFEnA -#: sf_textstream.xhp +#. gRcDE +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id561585330787568\n" +"sf_toc.xhp\n" +"par_id651606319520519\n" "help.text" -msgid "Yes" +msgid "List of Properties in the Basic Service" msgstr "" -#. cVCoJ -#: sf_textstream.xhp +#. LAgbN +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id741585330787777\n" +"sf_toc.xhp\n" +"hd_id101671192601502\n" "help.text" -msgid "The character set to be used. The default encoding is \"UTF-8\"." +msgid "SFDocuments.Calc service" msgstr "" -#. p5s3X -#: sf_textstream.xhp +#. uxhCu +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id641585330787207\n" +"sf_toc.xhp\n" +"par_id651606319520654\n" "help.text" -msgid "Yes" +msgid "List of Properties in the Calc Service" msgstr "" -#. JjEqX -#: sf_textstream.xhp +#. 8B4AP +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id281585330787614\n" +"sf_toc.xhp\n" +"hd_id101671192601677\n" "help.text" -msgid "Returns the name of the current file either in URL format or in the native operating system's format, depending on the current value of the FileNaming property of the FileSystem service." +msgid "SFDocuments.Chart service" msgstr "" -#. goEnw -#: sf_textstream.xhp +#. hNAmL +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id111585330787410\n" +"sf_toc.xhp\n" +"par_id651606319523634\n" "help.text" -msgid "Yes" +msgid "List of Properties in the Chart Service" msgstr "" -#. MZS6Z -#: sf_textstream.xhp +#. mbPs5 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id861585330787417\n" +"sf_toc.xhp\n" +"hd_id101671192601147\n" +"help.text" +msgid "SFDatabases.Database service" +msgstr "" + +#. nEVNp +#: sf_toc.xhp +msgctxt "" +"sf_toc.xhp\n" +"par_id651606319520332\n" "help.text" -msgid "Indicates the input/output mode. Possible values are \"READ\", \"WRITE\" or \"APPEND\"." +msgid "List of Properties in the Database Service" msgstr "" -#. 7nTb9 -#: sf_textstream.xhp +#. FpWGN +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id87158533078795\n" +"sf_toc.xhp\n" +"hd_id101671192603066\n" "help.text" -msgid "Yes" +msgid "SFDatabases.Dataset service" msgstr "" -#. j45gC -#: sf_textstream.xhp +#. zzVnN +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id561585330787741\n" +"sf_toc.xhp\n" +"par_id651606319591202\n" "help.text" -msgid "Returns the number of lines read or written so far." +msgid "List of Properties in the Dataset Service" msgstr "" -#. CLAvQ -#: sf_textstream.xhp +#. rGLDA +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id531585330787157\n" +"sf_toc.xhp\n" +"hd_id101671192690807\n" "help.text" -msgid "No" +msgid "SFDatabases.Datasheet service" msgstr "" -#. rdA5M -#: sf_textstream.xhp +#. ZA8ZQ +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id691585330787279\n" +"sf_toc.xhp\n" +"par_id651606319510928\n" "help.text" -msgid "Sets or returns the current delimiter to be inserted between two successive written lines. The default value is the native line delimiter in the current operating system." +msgid "List of Properties in the Datasheet Service" msgstr "" -#. veDBj -#: sf_textstream.xhp +#. Y5mr6 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id141613001281573\n" +"sf_toc.xhp\n" +"hd_id101671192601308\n" "help.text" -msgid "To learn more about the names of character sets, visit IANA's Character Set page. Be aware that %PRODUCTNAME does not implement all existing character sets." +msgid "SFDialogs.Dialog service" msgstr "" -#. hKJkD -#: sf_textstream.xhp +#. eqEbb +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id891611613601554\n" +"sf_toc.xhp\n" +"par_id651606319527165\n" "help.text" -msgid "List of Methods in the TextStream Service" +msgid "List of Properties in the Dialog Service" msgstr "" -#. DBBKM -#: sf_textstream.xhp +#. dCD6o +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id421585330787675\n" +"sf_toc.xhp\n" +"hd_id101671192601688\n" "help.text" -msgid "Closes the current input or output stream and empties the output buffer if relevant. Returns True if the file was successfully closed." +msgid "SFDialogs.DialogControl service" msgstr "" -#. MCW3q -#: sf_textstream.xhp +#. QBrji +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id65158533078799\n" +"sf_toc.xhp\n" +"par_id651606319523433\n" "help.text" -msgid "Returns all the remaining lines in the text stream as a single string. Line breaks are not removed." +msgid "List of Properties in the DialogControl Service" msgstr "" -#. Vr34D -#: sf_textstream.xhp +#. CEN8p +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id71613600347125\n" +"sf_toc.xhp\n" +"hd_id101671192601559\n" "help.text" -msgid "The resulting string can be split in lines either by using the Split built-in Basic function if the line delimiter is known, or with the SF_String.SplitLines method." +msgid "ScriptForge.Dictionary service" msgstr "" -#. VRLGn -#: sf_textstream.xhp +#. V3dV2 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id91585330787373\n" +"sf_toc.xhp\n" +"par_id651606319520328\n" "help.text" -msgid "For large files, using the ReadAll method wastes memory resources. In such cases it is recommended to read the file line by line using the ReadLine method." +msgid "List of Properties in the Dictionary Service" msgstr "" -#. BuBVA -#: sf_textstream.xhp +#. kXRkE +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id921613595637851\n" +"sf_toc.xhp\n" +"hd_id101671192601711\n" "help.text" -msgid "Consider the text file \"Students.txt\" with the following contents (a name in each line):" +msgid "SFDocuments.Document service" msgstr "" -#. hk7q4 -#: sf_textstream.xhp +#. uPiwD +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id391613596019750\n" +"sf_toc.xhp\n" +"par_id651606319746528\n" "help.text" -msgid "The examples below in Basic and Python use the ReadAll and SplitLines methods to read the contents of the file into an array of strings:" +msgid "List of Properties in the Document Service" msgstr "" -#. BuRJE -#: sf_textstream.xhp +#. Gk8EF +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id251613595640550\n" +"sf_toc.xhp\n" +"hd_id101671192501339\n" "help.text" -msgid "'Loads the FileSystem service" +msgid "ScriptForge.Exception service" msgstr "" -#. L2a3D -#: sf_textstream.xhp +#. rGaFn +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id181613595641087\n" +"sf_toc.xhp\n" +"par_id651606319500328\n" "help.text" -msgid "'Opens the text file with the names to be read" +msgid "List of Properties in the Exception Service" msgstr "" -#. rDCSD -#: sf_textstream.xhp +#. 7L6SK +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id711613595642109\n" +"sf_toc.xhp\n" +"hd_id101671192505579\n" "help.text" -msgid "'Reads all the contents in the input file as a single string" +msgid "ScriptForge.FileSystem service" msgstr "" -#. 6w73J -#: sf_textstream.xhp +#. i7nPm +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id961613595643093\n" +"sf_toc.xhp\n" +"par_id651606319646328\n" "help.text" -msgid "'Splits the string into an array" +msgid "List of Properties in the FileSystem Service" msgstr "" -#. 7Fq9E -#: sf_textstream.xhp +#. kdN69 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id871585330787885\n" +"sf_toc.xhp\n" +"hd_id101671192505441\n" "help.text" -msgid "Returns the next line in the text stream as a string. Line breaks are removed from the returned string." +msgid "SFDocuments.Form service" msgstr "" -#. 6iDcF -#: sf_textstream.xhp +#. FkAkF +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id431613600221626\n" +"sf_toc.xhp\n" +"par_id651606319525458\n" "help.text" -msgid "The AtEndOfStream test should precede the ReadLine method like in the example below." +msgid "List of Properties in the Form Service" msgstr "" -#. GRRkq -#: sf_textstream.xhp +#. uZGQs +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id171585330787774\n" +"sf_toc.xhp\n" +"hd_id101671192506636\n" "help.text" -msgid "An error will be raised if the AtEndOfStream was reached during the previous ReadLine or SkipLine method call." +msgid "SFDocuments.FormControl service" msgstr "" -#. mAty4 -#: sf_textstream.xhp +#. ivRX2 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id11585330787847\n" +"sf_toc.xhp\n" +"par_id651606319411328\n" "help.text" -msgid "Skips the next line in the input stream when reading a TextStream file." +msgid "List of Properties in the FormControl Service" msgstr "" -#. FDMJB -#: sf_textstream.xhp +#. kPCcD +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id441613600704766\n" +"sf_toc.xhp\n" +"hd_id101671192705399\n" "help.text" -msgid "This method can result in AtEndOfStream being set to True." +msgid "SFDocuments.FormDocument service" msgstr "" -#. D4JVb -#: sf_textstream.xhp +#. DCwnN +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id141585330787657\n" +"sf_toc.xhp\n" +"hd_id101671199996466\n" "help.text" -msgid "Writes a specified number of empty lines to the output stream." +msgid "ScriptForge.L10N service" msgstr "" -#. YsBUm -#: sf_textstream.xhp +#. CNrDo +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id291585330787357\n" +"sf_toc.xhp\n" +"par_id651606319527168\n" "help.text" -msgid "lines: The number of empty lines to write to the file." +msgid "List of Properties in the L10N Service" msgstr "" -#. GCPCC -#: sf_textstream.xhp +#. kPEXF +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id101585330787215\n" +"sf_toc.xhp\n" +"hd_id101671199996396\n" "help.text" -msgid "Writes the given string to the output stream as a single line." +msgid "SFWidgets.Menu service" msgstr "" -#. Eska7 -#: sf_textstream.xhp +#. CAaoK +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id421613601002074\n" +"sf_toc.xhp\n" +"par_id651606314140328\n" "help.text" -msgid "The character defined in the NewLine property is used as the line delimiter." +msgid "List of Properties in the Menu Service" msgstr "" -#. LXFPE -#: sf_textstream.xhp +#. Nm9Ft +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id491585330787650\n" +"sf_toc.xhp\n" +"hd_id101671199994016\n" "help.text" -msgid "line: The line to write, may be empty." +msgid "ScriptForge.Platform service" msgstr "" -#. PM5Bx -#: sf_textstream.xhp +#. y2Hhd +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"par_id821626894480105\n" +"sf_toc.xhp\n" +"par_id651606319518728\n" "help.text" -msgid "The examples below in Basic and Python create a text file in CSV format in which each line contains a value and its square until lastValue is reached." +msgid "List of Properties in the Platform Service" msgstr "" -#. 39u4o -#: sf_textstream.xhp +#. JgPNJ +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id21613321528612\n" +"sf_toc.xhp\n" +"hd_id101671199996417\n" "help.text" -msgid "'Instantiates the FileSystem Service" +msgid "SFWidgets.PopupMenu service" msgstr "" -#. FnTiG -#: sf_textstream.xhp +#. jPDs4 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id191613321529277\n" +"sf_toc.xhp\n" +"par_id651606314130218\n" "help.text" -msgid "'Creates a text file" +msgid "List of Properties in the PopupMenu Service" msgstr "" -#. f5RSB -#: sf_textstream.xhp +#. 5rfxS +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id641613321530181\n" +"sf_toc.xhp\n" +"hd_id101671199993577\n" "help.text" -msgid "'Writes the Value and Value squared, separated by \";\"" +msgid "ScriptForge.Region service" msgstr "" -#. FCowk -#: sf_textstream.xhp +#. 6P6YE +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id141613321530960\n" +"sf_toc.xhp\n" +"par_id651606316032328\n" "help.text" -msgid "myFile.WriteLine(\"Value;Value Squared\")" +msgid "List of Properties in the Region Service" msgstr "" -#. m9Mo4 -#: sf_textstream.xhp +#. YjCc5 +#: sf_toc.xhp msgctxt "" -"sf_textstream.xhp\n" -"bas_id881613321532598\n" +"sf_toc.xhp\n" +"hd_id101671199993654\n" "help.text" -msgid "'Closes the file and free resources" +msgid "ScriptForge.Session service" msgstr "" -#. PCSPY -#: sf_timer.xhp +#. Ch9rH +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"tit\n" +"sf_toc.xhp\n" +"par_id651606319550408\n" "help.text" -msgid "ScriptForge.Timer service" +msgid "List of Properties in the Session Service" msgstr "" -#. uvCrq -#: sf_timer.xhp +#. FqDWZ +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"hd_id731582733781114\n" +"sf_toc.xhp\n" +"hd_id1016711992514654\n" "help.text" -msgid "ScriptForge.Timer service" +msgid "ScriptForge.String service" msgstr "" -#. WyVvH -#: sf_timer.xhp +#. 6vNEV +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id961582733781662\n" +"sf_toc.xhp\n" +"par_id651606358900328\n" "help.text" -msgid "The Timer service measures the amount of time it takes to run user scripts." +msgid "List of Properties in the Dictionary Service" msgstr "" -#. qDa8E -#: sf_timer.xhp +#. EGy6c +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id181582733781323\n" +"sf_toc.xhp\n" +"hd_id1016711992512103\n" "help.text" -msgid "A Timer measures durations. It can be:" +msgid "ScriptForge.TextStream service" msgstr "" -#. ErpLm -#: sf_timer.xhp +#. sqgkG +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id711582733781252\n" +"sf_toc.xhp\n" +"par_id651606305698328\n" "help.text" -msgid "Started, to indicate when to start measuring time." +msgid "List of Properties in the TextStream Service" msgstr "" -#. NAAFg -#: sf_timer.xhp +#. rfA4y +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id631582733781431\n" +"sf_toc.xhp\n" +"hd_id1016711992519543\n" "help.text" -msgid "Suspended, to pause measuring running time." +msgid "ScriptForge.Timer service" msgstr "" -#. nt9Qc -#: sf_timer.xhp +#. 7S2q8 +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id691582733781498\n" +"sf_toc.xhp\n" +"par_id651601219036328\n" "help.text" -msgid "Resumed, to continue tracking running time after the Timer has been suspended." +msgid "List of Methods in the Timer Service" msgstr "" -#. DVCBM -#: sf_timer.xhp +#. BeSkR +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id31582733781344\n" +"sf_toc.xhp\n" +"par_id651601219520328\n" "help.text" -msgid "Restarted, which will cancel previous measurements and start the Timer at zero." +msgid "List of Properties in the Timer Service" msgstr "" -#. dm7yA -#: sf_timer.xhp +#. SZgAH +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id991582733781280\n" +"sf_toc.xhp\n" +"hd_id1016711992036103\n" "help.text" -msgid "Durations are expressed in seconds with a precision of 3 decimal digits (milliseconds). A duration value of 12.345 means 12 seconds and 345 milliseconds" +msgid "ScriptForge.Toolbar service" msgstr "" -#. CVhDR -#: sf_timer.xhp +#. uKPSJ +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"hd_id201582733781265\n" +"sf_toc.xhp\n" +"par_id651606205603658\n" "help.text" -msgid "Service invocation" +msgid "List of Properties in the Toolbar Service" msgstr "" -#. fYto9 -#: sf_timer.xhp +#. cFDeN +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id141609955500101\n" +"sf_toc.xhp\n" +"hd_id1016711992054103\n" "help.text" -msgid "Before using the Timer service the ScriptForge library needs to be loaded or imported:" +msgid "ScriptForge.ToolbarButton service" msgstr "" -#. SCYEX -#: sf_timer.xhp +#. wauAF +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id891610734806133\n" +"sf_toc.xhp\n" +"par_id651635105603658\n" "help.text" -msgid "The example below creates a Timer object named myTimer and starts it immediately." +msgid "List of Properties in the ToolbarButton Service" msgstr "" -#. WMZog -#: sf_timer.xhp +#. MexL5 +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id681582733781715\n" +"sf_toc.xhp\n" +"hd_id1016711992512950\n" "help.text" -msgid "'The timer starts immediately when the second argument = True, default = False" +msgid "ScriptForge.UI service" msgstr "" -#. CnZqc -#: sf_timer.xhp +#. jttmj +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id891582733781994\n" +"sf_toc.xhp\n" +"par_id651606657520328\n" "help.text" -msgid "It is recommended to free resources after use:" +msgid "List of Properties in the UI Service" msgstr "" -#. 8h3fp -#: sf_timer.xhp +#. uY9cX +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"hd_id521582733781450\n" +"sf_toc.xhp\n" +"hd_id1016711992512540\n" "help.text" -msgid "Properties" +msgid "ScriptForge.UnitTest service" msgstr "" -#. dVncX -#: sf_timer.xhp +#. MFG4G +#: sf_toc.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id71582733781260\n" +"sf_toc.xhp\n" +"par_id651606313658328\n" "help.text" -msgid "Name" +msgid "List of Properties in the UnitTest Service" msgstr "" -#. hFnkK -#: sf_timer.xhp +#. EBb8i +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id711582733781103\n" +"sf_toolbar.xhp\n" +"tit\n" "help.text" -msgid "Readonly" +msgid "SFWidgets.Toolbar service" msgstr "" -#. NvqK9 -#: sf_timer.xhp +#. pqQFq +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id76158273378122\n" +"sf_toolbar.xhp\n" +"hd_id731582733781114\n" "help.text" -msgid "Type" +msgid "SFWidgets.Toolbar service" msgstr "" -#. 7zFYh -#: sf_timer.xhp +#. oqrPc +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id751582733781926\n" +"sf_toolbar.xhp\n" +"par_id571700837631557\n" "help.text" -msgid "Description" +msgid "The Toolbar service allows to retrieve information related to the toolbars available for a specific document window. With this service it is possible to:" msgstr "" -#. T92or -#: sf_timer.xhp +#. vwn3U +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id621582733781588\n" +"sf_toolbar.xhp\n" +"par_id891589189452545\n" "help.text" -msgid "Yes" +msgid "Toggle the visibility of specific toolbars." msgstr "" -#. 9yDgM -#: sf_timer.xhp +#. Cq89r +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id731582733781476\n" +"sf_toolbar.xhp\n" +"par_id811589189463041\n" "help.text" -msgid "The actual running time elapsed since start or between start and stop (does not consider suspended time)" +msgid "Access information about the buttons available in each toolbar." msgstr "" -#. ThAaG -#: sf_timer.xhp +#. tGA5p +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id301582733781498\n" +"sf_toolbar.xhp\n" +"par_id141700851608146\n" "help.text" -msgid "Yes" +msgid "Each %PRODUCTNAME application has its own set of available toolbars. This service handles both built-in and custom toolbars." msgstr "" -#. tqpDU -#: sf_timer.xhp +#. EnCbC +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id401582733781608\n" +"sf_toolbar.xhp\n" +"par_id181700851890467\n" "help.text" -msgid "True when timer is started or suspended" +msgid "The status bar and the menu bar are not considered toolbars in the context of this service." msgstr "" -#. pSPgk -#: sf_timer.xhp +#. x39EK +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id181582733781551\n" +"sf_toolbar.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "Yes" +msgid "Service invocation" msgstr "" -#. SGyi4 -#: sf_timer.xhp +#. sDTg5 +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id161582733781328\n" +"sf_toolbar.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "True when timer is started and suspended" +msgid "Before using the Toolbar service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. qoNpD -#: sf_timer.xhp +#. H4Jrb +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id651582733781874\n" +"sf_toolbar.xhp\n" +"par_id411700851985942\n" "help.text" -msgid "Yes" +msgid "The Toolbar service is invoked using the Toolbars method, which is available in the following services: Calc, Datasheet, Document, FormDocument and Writer." msgstr "" -#. E45MD -#: sf_timer.xhp +#. DXXZt +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id171582733781456\n" +"sf_toolbar.xhp\n" +"par_id771700853155061\n" "help.text" -msgid "The actual time elapsed while suspended since start or between start and stop" +msgid "The example below gets an Array with the names of the toolbars available in the current document." msgstr "" -#. gxF8S -#: sf_timer.xhp +#. dCrhf +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id141582733781303\n" +"sf_toolbar.xhp\n" +"par_id961700853354817\n" "help.text" -msgid "Yes" +msgid "Use the Toolbars method without arguments to retrieve an array with available toolbar names." msgstr "" -#. FeCob -#: sf_timer.xhp +#. LGmwr +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id411582733781932\n" +"sf_toolbar.xhp\n" +"par_id171700853415555\n" "help.text" -msgid "The actual time elapsed since start or between start and stop (including suspensions and running time)" +msgid "The example below toggles the visibility of the Standard toolbar:" msgstr "" -#. a63gW -#: sf_timer.xhp +#. UDbvF +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id9158273378151\n" +"sf_toolbar.xhp\n" +"hd_id351582885195476\n" "help.text" -msgid "Note that the TotalDuration property is equivalent to summing the Duration and SuspendDuration properties." +msgid "Properties" msgstr "" -#. Mav4g -#: sf_timer.xhp +#. JyMa7 +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"hd_id141582734141895\n" +"sf_toolbar.xhp\n" +"par_id41582885195836\n" "help.text" -msgid "Methods" +msgid "Name" msgstr "" -#. P8RQj -#: sf_timer.xhp +#. ynz5j +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id291582734377752\n" +"sf_toolbar.xhp\n" +"par_id31582885195372\n" "help.text" -msgid "All methods do not require arguments and return a Boolean value." +msgid "Readonly" msgstr "" -#. onEib -#: sf_timer.xhp +#. 2FULu +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id311582734894257\n" +"sf_toolbar.xhp\n" +"par_id31582885195238\n" "help.text" -msgid "If the returned value is False, then nothing happened." +msgid "Type" msgstr "" -#. U82Do -#: sf_timer.xhp +#. CXito +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id871582734180676\n" +"sf_toolbar.xhp\n" +"par_id931582885195131\n" "help.text" -msgid "Name" +msgid "Description" msgstr "" -#. 6oGwx -#: sf_timer.xhp +#. NWaGJ +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id971582734180676\n" +"sf_toolbar.xhp\n" +"par_id861582885655779\n" "help.text" -msgid "Description" +msgid "Yes" msgstr "" -#. ZMfpe -#: sf_timer.xhp +#. NFBvJ +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id911582734180676\n" +"sf_toolbar.xhp\n" +"par_id581582885655885\n" "help.text" -msgid "Returned value" +msgid "Returns True when the toolbar is part of the set of standard toolbars shipped with %PRODUCTNAME." msgstr "" -#. 6DJTP -#: sf_timer.xhp +#. 2sRrz +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id301582734180676\n" +"sf_toolbar.xhp\n" +"par_id861582885655669\n" "help.text" -msgid "Resumes the Timer if it has been suspended" +msgid "Yes" msgstr "" -#. ixF7A -#: sf_timer.xhp +#. kBEqC +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id661582734180676\n" +"sf_toolbar.xhp\n" +"par_id581582885657885\n" "help.text" -msgid "False if the timer is not suspended" +msgid "Returns True when the toolbar is active in the window and docked." msgstr "" -#. AAozF -#: sf_timer.xhp +#. wgQVn +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id821582734649305\n" +"sf_toolbar.xhp\n" +"par_id861582885655710\n" "help.text" -msgid "Terminates the Timer and discards its current property values, restarting as a new clean Timer" +msgid "Yes" msgstr "" -#. UtCTT -#: sf_timer.xhp +#. pnCss +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id761582734649305\n" +"sf_toolbar.xhp\n" +"par_id581582885655102\n" "help.text" -msgid "False if the timer is inactive" +msgid "Returns True when the toolbar is available in all documents of the same type." msgstr "" -#. AkgAy -#: sf_timer.xhp +#. QdmGf +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id641582734802443\n" +"sf_toolbar.xhp\n" +"par_id861582885655205\n" "help.text" -msgid "Starts a new clean timer" +msgid "Yes" msgstr "" -#. B4gTh -#: sf_timer.xhp +#. JkADV +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id921582734802443\n" +"sf_toolbar.xhp\n" +"par_id581582885655369\n" "help.text" -msgid "False if the timer is already started" +msgid "Returns the name of the toolbar." msgstr "" -#. D7CoH -#: sf_timer.xhp +#. SPCka +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id81582734905507\n" +"sf_toolbar.xhp\n" +"par_id861582885655966\n" "help.text" -msgid "Suspends a running timer" +msgid "Yes" msgstr "" -#. YbeSJ -#: sf_timer.xhp +#. 9tRd5 +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id661582734905507\n" +"sf_toolbar.xhp\n" +"par_id581582885655812\n" "help.text" -msgid "False if the timer is not started or already suspended" +msgid "Returns the resource URL of the toolbar, in the form private:toolbar/toolbar_name." msgstr "" -#. sgXra -#: sf_timer.xhp +#. JKEeR +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id861582734996722\n" +"sf_toolbar.xhp\n" +"par_id861582885655212\n" "help.text" -msgid "Stops a running timer" +msgid "No" msgstr "" -#. WkCCC -#: sf_timer.xhp +#. cAQFF +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id381582734996722\n" +"sf_toolbar.xhp\n" +"par_id581582885655344\n" "help.text" -msgid "False if the timer is neither started nor suspended" +msgid "Returns True when the toolbar is active and visible in the document window." msgstr "" -#. DuD3h -#: sf_timer.xhp +#. DsnCd +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id731626871820490\n" +"sf_toolbar.xhp\n" +"par_id861582885655788\n" "help.text" -msgid "The examples below in Basic and Python illustrate the use of the methods and properties in the Timer service." +msgid "Yes" msgstr "" -#. UgBnC -#: sf_timer.xhp +#. SBzqD +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id141582735926821\n" +"sf_toolbar.xhp\n" +"par_id581582885655062\n" "help.text" -msgid "'The time elapsed while the Dialog box is open will be counted as suspended time" +msgid "Returns the com.sun.star.ui.XUIElement UNO object that represents the toolbar." msgstr "" -#. 4jHcj -#: sf_timer.xhp +#. NaxAS +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id901582735961725\n" +"sf_toolbar.xhp\n" +"par_id651606319520519\n" "help.text" -msgid "'The time elapsed while the Dialog box is open will be counted as running time" +msgid "List of Methods in the Toolbar Service" msgstr "" -#. 7QhZU -#: sf_timer.xhp +#. FED3g +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id941610739926687\n" +"sf_toolbar.xhp\n" +"par_id93158919969864\n" "help.text" -msgid "'Shows the final time measurements" +msgid "Returns an Array containing the names of all toolbar buttons when called without arguments." msgstr "" -#. J6XGB -#: sf_timer.xhp +#. ZFAQU +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id281610740093006\n" +"sf_toolbar.xhp\n" +"par_id421611148353046\n" "help.text" -msgid "If you call the Terminate method, subsequent calls for the Continue method will not resume time measurement. Similarly, after a Timer has been terminated, calling the Start method will restart it as if it were a clean new Timer." +msgid "Provide the name of a toolbar button as argument to obtain a ToolbarButton service instance." msgstr "" -#. AqGfb -#: sf_timer.xhp +#. 4FNvr +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id391626872019832\n" +"sf_toolbar.xhp\n" +"par_id381701012526415\n" "help.text" -msgid "Be aware that the Wait function in BASIC takes in a duration argument in milliseconds whereas the sleep function in Python uses seconds in its argument." +msgid "buttonname: The name of a toolbar button in the current toolbar." msgstr "" -#. bHEyr -#: sf_timer.xhp +#. KDGVG +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"hd_id431610989623086\n" +"sf_toolbar.xhp\n" +"par_id601611148017930\n" "help.text" -msgid "Working with Multiple Timers" +msgid "The example below returns the command executed when the button New is clicked in the Standard toolbar:" msgstr "" -#. dr779 -#: sf_timer.xhp +#. wAXLm +#: sf_toolbar.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id741610989639201\n" +"sf_toolbar.xhp\n" +"par_id531701012694220\n" "help.text" -msgid "It is possible to instantiate multiple Timer services in parallel, which gives flexibility in measuring time in different parts of the code." +msgid "Inactive toolbars do not have buttons. Therefore, calling the ToolbarButtons method will make the toolbar visible." msgstr "" -#. ueLgB -#: sf_timer.xhp +#. C2z22 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_timer.xhp\n" -"par_id921610989722908\n" +"sf_toolbarbutton.xhp\n" +"tit\n" "help.text" -msgid "The following example illustrates how to create two Timer objects and start them separately." +msgid "SFWidgets.ToolbarButton service" msgstr "" -#. PtA4E -#: sf_timer.xhp +#. 7vbG4 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id481610989853679\n" +"sf_toolbarbutton.xhp\n" +"hd_id731582733781114\n" "help.text" -msgid "'Starts myTimerA" +msgid "SFWidgets.ToolbarButton service" msgstr "" -#. VUdGW -#: sf_timer.xhp +#. 3WPXi +#: sf_toolbarbutton.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id331610989849501\n" +"sf_toolbarbutton.xhp\n" +"par_id571700837631557\n" "help.text" -msgid "'Starts myTimerB" +msgid "The ToolbarButton service allows to retrieve information related to the toolbar buttons available in a given toolbar. With this service it is possible to:" msgstr "" -#. t98Fv -#: sf_timer.xhp +#. AFA7c +#: sf_toolbarbutton.xhp msgctxt "" -"sf_timer.xhp\n" -"bas_id931610989837747\n" +"sf_toolbarbutton.xhp\n" +"par_id891589189452545\n" "help.text" -msgid "'Terminate both timers" +msgid "Toggle the visibility of toolbar elements." msgstr "" -#. AuovU -#: sf_toc.xhp +#. uvPBu +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"tit\n" +"sf_toolbarbutton.xhp\n" +"par_id811589189463041\n" "help.text" -msgid "List of all ScriptForge methods and properties" +msgid "Execute the command associated with a given toolbar button." msgstr "" -#. zxZFp -#: sf_toc.xhp +#. GF4Sh +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id461623364876507\n" +"sf_toolbarbutton.xhp\n" +"hd_id581582885621841\n" "help.text" -msgid "List of all ScriptForge methods and properties" +msgid "Service invocation" msgstr "" -#. 9cBCb -#: sf_toc.xhp +#. Jv5uU +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id691671192231981\n" +"sf_toolbarbutton.xhp\n" +"par_id141609955500101\n" "help.text" -msgid "This help page shows all methods and properties available in the ScriptForge library by service with links to the corresponding documentation." +msgid "Before using the ToolbarButton service the ScriptForge library needs to be loaded or imported:" msgstr "" -#. 4NBjy -#: sf_toc.xhp +#. 84iEK +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id401671192686811\n" +"sf_toolbarbutton.xhp\n" +"par_id411700851985942\n" "help.text" -msgid "The Basic source code for all ScriptForge services is available via Application Macros and Dialogs and is distributed in multiple libraries: ScriptForge, SFDatabases, SFDialogs, SFDocuments, SFUnitTests and SFWidgets. The Python portion of the source code is available in the program\\scriptforge.py file under the %PRODUCTNAME installation directory." +msgid "The ToolbarButton service is invoked using the ToolbarButtons method from the Toolbar service." msgstr "" -#. MPEN4 -#: sf_toc.xhp +#. bXAc8 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601663\n" +"sf_toolbarbutton.xhp\n" +"par_id771700853155061\n" "help.text" -msgid "ScriptForge.Array service" +msgid "The example below retrieves the names of all buttons available in the Standard toolbar." msgstr "" -#. xA5NE -#: sf_toc.xhp +#. dBPud +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601553\n" +"sf_toolbarbutton.xhp\n" +"par_id961700853354817\n" "help.text" -msgid "SFDocuments.Base service" +msgid "Use the ToolbarButtons method without arguments to retrieve an array with all available toolbar button names." msgstr "" -#. JFajQ -#: sf_toc.xhp +#. MCeGq +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id541674484344235\n" +"sf_toolbarbutton.xhp\n" +"par_id171700853415555\n" "help.text" -msgid "This service also supports the methods and properties defined in the Document service, which includes methods that are generic to all document types." +msgid "The example below toggles the visibility of the Print button in the Standard toolbar:" msgstr "" -#. pFPFA -#: sf_toc.xhp +#. EccFb +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192609363\n" +"sf_toolbarbutton.xhp\n" +"bas_id117008537580631\n" "help.text" -msgid "ScriptForge.Basic service" +msgid "oToolbarButton = oToolbar.ToolbarButtons(\"Print\")" msgstr "" -#. gRcDE -#: sf_toc.xhp +#. WL7SE +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319520519\n" +"sf_toolbarbutton.xhp\n" +"par_id981701021131646\n" "help.text" -msgid "List of Properties in the Basic Service" +msgid "The button name passed as argument to the ToolbarButtons method is the localized button name defined in the Tools - Customize - Toolbars dialog." msgstr "" -#. LAgbN -#: sf_toc.xhp +#. UbFqB +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601502\n" +"sf_toolbarbutton.xhp\n" +"par_id531701012694220\n" "help.text" -msgid "SFDocuments.Calc service" +msgid "Inactive toolbars do not have buttons. Therefore, calling the ToolbarButtons method will make the toolbar visible." msgstr "" -#. uxhCu -#: sf_toc.xhp +#. noSwD +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319520654\n" +"sf_toolbarbutton.xhp\n" +"pyc_id351701021554314\n" "help.text" -msgid "List of Properties in the Calc Service" +msgid "toolbar_button = toolbar.ToolbarButtons(\"Print\")" msgstr "" -#. 8B4AP -#: sf_toc.xhp +#. zVUEe +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601677\n" +"sf_toolbarbutton.xhp\n" +"hd_id351582885195476\n" "help.text" -msgid "SFDocuments.Chart service" +msgid "Properties" msgstr "" -#. hNAmL -#: sf_toc.xhp +#. v9qLc +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319523634\n" +"sf_toolbarbutton.xhp\n" +"par_id41582885195836\n" "help.text" -msgid "List of Properties in the Chart Service" +msgid "Name" msgstr "" -#. mbPs5 -#: sf_toc.xhp +#. ZEAQj +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601147\n" +"sf_toolbarbutton.xhp\n" +"par_id31582885195372\n" "help.text" -msgid "SFDatabases.Database service" +msgid "Readonly" msgstr "" -#. nEVNp -#: sf_toc.xhp +#. XsFaH +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319520332\n" +"sf_toolbarbutton.xhp\n" +"par_id31582885195238\n" "help.text" -msgid "List of Properties in the Database Service" +msgid "Type" msgstr "" -#. rGLDA -#: sf_toc.xhp +#. L7CFQ +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192690807\n" +"sf_toolbarbutton.xhp\n" +"par_id931582885195131\n" "help.text" -msgid "SFDatabases.Datasheet service" +msgid "Description" msgstr "" -#. ZA8ZQ -#: sf_toc.xhp +#. rD5Wn +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319510928\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655779\n" "help.text" -msgid "List of Properties in the Datasheet Service" +msgid "Yes" msgstr "" -#. Y5mr6 -#: sf_toc.xhp +#. HmTft +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601308\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885655885\n" "help.text" -msgid "SFDialogs.Dialog service" +msgid "Returns the name of the button." msgstr "" -#. eqEbb -#: sf_toc.xhp +#. XFmBe +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319527165\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655669\n" "help.text" -msgid "List of Properties in the Dialog Service" +msgid "Yes" msgstr "" -#. dCD6o -#: sf_toc.xhp +#. wxbpS +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601688\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885657885\n" "help.text" -msgid "SFDialogs.DialogControl service" +msgid "Returns the height of the button, in pixels." msgstr "" -#. QBrji -#: sf_toc.xhp +#. KKkBJ +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319523433\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655710\n" "help.text" -msgid "List of Properties in the DialogControl Service" +msgid "Yes" msgstr "" -#. CEN8p -#: sf_toc.xhp +#. DPmJW +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601559\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885655102\n" "help.text" -msgid "ScriptForge.Dictionary service" +msgid "Returns the index of the button in its parent toolbar." msgstr "" -#. V3dV2 -#: sf_toc.xhp +#. NWZML +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319520328\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655205\n" "help.text" -msgid "List of Properties in the Dictionary Service" +msgid "No" msgstr "" -#. kXRkE -#: sf_toc.xhp +#. DarcX +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192601711\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885655369\n" "help.text" -msgid "SFDocuments.Document service" +msgid "The UNO command or script executed when the button is pressed. Read the Wiki page Scripting Framework URI Specification to learn more on how to define a URI string." msgstr "" -#. uPiwD -#: sf_toc.xhp +#. 5cZz5 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319746528\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655966\n" "help.text" -msgid "List of Properties in the Document Service" +msgid "Yes" msgstr "" -#. Gk8EF -#: sf_toc.xhp +#. CVk4f +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192501339\n" +"sf_toolbarbutton.xhp\n" +"par_id271582885605065\n" "help.text" -msgid "ScriptForge.Exception service" +msgid "Toolbar service" msgstr "" -#. rGaFn -#: sf_toc.xhp +#. ky5Ft +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319500328\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885655812\n" "help.text" -msgid "List of Properties in the Exception Service" +msgid "Returns a Toolbar service instance corresponding to the parent toolbar of the current toolbar button." msgstr "" -#. 7L6SK -#: sf_toc.xhp +#. evEJD +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192505579\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655212\n" "help.text" -msgid "ScriptForge.FileSystem service" +msgid "No" msgstr "" -#. i7nPm -#: sf_toc.xhp +#. RFDDd +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319646328\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885655344\n" "help.text" -msgid "List of Properties in the FileSystem Service" +msgid "Specifies the tooltip text shown when the user hovers over the toolbar button." msgstr "" -#. kdN69 -#: sf_toc.xhp +#. 7rEk3 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192505441\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885655788\n" "help.text" -msgid "SFDocuments.Form service" +msgid "No" msgstr "" -#. FkAkF -#: sf_toc.xhp +#. Xwj6X +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319525458\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885655062\n" "help.text" -msgid "List of Properties in the Form Service" +msgid "Specifies whether the toolbar button is visible or not." msgstr "" -#. uZGQs -#: sf_toc.xhp +#. MAiCW +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192506636\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885651058\n" "help.text" -msgid "SFDocuments.FormControl service" +msgid "Yes" msgstr "" -#. ivRX2 -#: sf_toc.xhp +#. nBeFQ +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319411328\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885653342\n" "help.text" -msgid "List of Properties in the FormControl Service" +msgid "Returns the width of the button, in pixels." msgstr "" -#. kPCcD -#: sf_toc.xhp +#. XBYFY +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671192705399\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885636258\n" "help.text" -msgid "SFDocuments.FormDocument service" +msgid "Yes" msgstr "" -#. DCwnN -#: sf_toc.xhp +#. 4uB2C +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671199996466\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885641742\n" "help.text" -msgid "ScriptForge.L10N service" +msgid "Returns the X (horizontal) coordinate of the top-left corner of the button, in pixels." msgstr "" -#. CNrDo -#: sf_toc.xhp +#. nZBBC +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319527168\n" +"sf_toolbarbutton.xhp\n" +"par_id861582885603158\n" "help.text" -msgid "List of Properties in the L10N Service" +msgid "Yes" msgstr "" -#. kPEXF -#: sf_toc.xhp +#. sapte +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671199996396\n" +"sf_toolbarbutton.xhp\n" +"par_id581582885609942\n" "help.text" -msgid "SFWidgets.Menu service" +msgid "Returns the Y (vertical) coordinate of the top-left corner of the button, in pixels." msgstr "" -#. CAaoK -#: sf_toc.xhp +#. 5EuPv +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606314140328\n" +"sf_toolbarbutton.xhp\n" +"hd_id501701094012462\n" "help.text" -msgid "List of Properties in the Menu Service" +msgid "Use of ToolbarButton alongside the PopupMenu service" msgstr "" -#. Nm9Ft -#: sf_toc.xhp +#. BA5AH +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671199994016\n" +"sf_toolbarbutton.xhp\n" +"par_id731701094077095\n" "help.text" -msgid "ScriptForge.Platform service" +msgid "A common use case of the properties X and Y described above is to open a popup menu in the position where the toolbar button is located." msgstr "" -#. y2Hhd -#: sf_toc.xhp +#. y6sZ3 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319518728\n" +"sf_toolbarbutton.xhp\n" +"par_id761701094138529\n" "help.text" -msgid "List of Properties in the Platform Service" +msgid "Suppose you create the script below and associate it with a button named \"My Button\" in the standardbar. When it is clicked, a popup menu will be shown with 3 options for the user to select." msgstr "" -#. JgPNJ -#: sf_toc.xhp +#. ScQ7D +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671199996417\n" +"sf_toolbarbutton.xhp\n" +"bas_id971701094239852\n" "help.text" -msgid "SFWidgets.PopupMenu service" +msgid "oButton = oToolbar.ToolbarButtons(\"My Button\")" msgstr "" -#. jPDs4 -#: sf_toc.xhp +#. FdnTg +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606314130218\n" +"sf_toolbarbutton.xhp\n" +"bas_id521701094240308\n" "help.text" -msgid "List of Properties in the PopupMenu Service" +msgid "oPopup.AddItem(\"Item A\", \"A\")" msgstr "" -#. 5rfxS -#: sf_toc.xhp +#. q5NAy +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671199993577\n" +"sf_toolbarbutton.xhp\n" +"bas_id201701094240523\n" "help.text" -msgid "ScriptForge.Region service" +msgid "oPopup.AddItem(\"Item B\", \"B\")" msgstr "" -#. 6P6YE -#: sf_toc.xhp +#. hSrs9 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606316032328\n" +"sf_toolbarbutton.xhp\n" +"bas_id961701094240764\n" "help.text" -msgid "List of Properties in the Region Service" +msgid "oPopup.AddItem(\"Item C\", \"C\")" msgstr "" -#. YjCc5 -#: sf_toc.xhp +#. nN4Ci +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id101671199993654\n" +"sf_toolbarbutton.xhp\n" +"bas_id531701094241275\n" "help.text" -msgid "ScriptForge.Session service" +msgid "MsgBox \"Your choice: \" & strResponse" msgstr "" -#. Ch9rH -#: sf_toc.xhp +#. FEgta +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606319550408\n" +"sf_toolbarbutton.xhp\n" +"pyc_id231701094980046\n" "help.text" -msgid "List of Properties in the Session Service" +msgid "toolbutton = toolbar.ToolbarButtons(\"My Button\")" msgstr "" -#. FqDWZ -#: sf_toc.xhp +#. AUB9g +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id1016711992514654\n" +"sf_toolbarbutton.xhp\n" +"pyc_id521701094980469\n" "help.text" -msgid "ScriptForge.String service" +msgid "popup.AddItem(\"Item A\", \"A\")" msgstr "" -#. 6vNEV -#: sf_toc.xhp +#. Afb6C +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606358900328\n" +"sf_toolbarbutton.xhp\n" +"pyc_id841701094980684\n" "help.text" -msgid "List of Properties in the Dictionary Service" +msgid "popup.AddItem(\"Item B\", \"B\")" msgstr "" -#. EGy6c -#: sf_toc.xhp +#. NDiSP +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id1016711992512103\n" +"sf_toolbarbutton.xhp\n" +"pyc_id441701094980908\n" "help.text" -msgid "ScriptForge.TextStream service" +msgid "popup.AddItem(\"Item C\", \"C\")" msgstr "" -#. sqgkG -#: sf_toc.xhp +#. dW3ae +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606305698328\n" +"sf_toolbarbutton.xhp\n" +"pyc_id241701094981357\n" "help.text" -msgid "List of Properties in the TextStream Service" +msgid "bas.MsgBox(f\"Your choice: {response}\")" msgstr "" -#. rfA4y -#: sf_toc.xhp +#. FdzNA +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id1016711992519543\n" +"sf_toolbarbutton.xhp\n" +"par_id651606319520519\n" "help.text" -msgid "ScriptForge.Timer service" +msgid "List of Methods in the ToolbarButton Service" msgstr "" -#. 7S2q8 -#: sf_toc.xhp +#. oGWqY +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651601219036328\n" +"sf_toolbarbutton.xhp\n" +"par_id93158919969864\n" "help.text" -msgid "List of Methods in the Timer Service" +msgid "Executes the command or script associated with the toolbar button." msgstr "" -#. BeSkR -#: sf_toc.xhp +#. 7BYZB +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651601219520328\n" +"sf_toolbarbutton.xhp\n" +"par_id191701023292148\n" "help.text" -msgid "List of Properties in the Timer Service" +msgid "This method returns the value returned by the command or script executed." msgstr "" -#. MexL5 -#: sf_toc.xhp +#. DypG2 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id1016711992512950\n" +"sf_toolbarbutton.xhp\n" +"par_id731701023160247\n" "help.text" -msgid "ScriptForge.UI service" +msgid "Use the OnClick property to determine the command or script that shall be executed. If the command/script does not return any value, then Null is returned." msgstr "" -#. jttmj -#: sf_toc.xhp +#. o3Jvt +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606657520328\n" +"sf_toolbarbutton.xhp\n" +"par_id601611148017930\n" "help.text" -msgid "List of Properties in the UI Service" +msgid "The example below executes the Print button from the Standard toolbar:" msgstr "" -#. uY9cX -#: sf_toc.xhp +#. PErti +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"hd_id1016711992512540\n" +"sf_toolbarbutton.xhp\n" +"bas_id841701013457456\n" "help.text" -msgid "ScriptForge.UnitTest service" +msgid "oToolbarButton = oToolbar.ToolbarButtons(\"Print\")" msgstr "" -#. MFG4G -#: sf_toc.xhp +#. izBv6 +#: sf_toolbarbutton.xhp msgctxt "" -"sf_toc.xhp\n" -"par_id651606313658328\n" +"sf_toolbarbutton.xhp\n" +"pyc_id351701020654314\n" "help.text" -msgid "List of Properties in the UnitTest Service" +msgid "toolbar_button = toolbar.ToolbarButtons(\"Print\")" msgstr "" #. dphFv diff --git a/source/ja/helpcontent2/source/text/scalc.po b/source/ja/helpcontent2/source/text/scalc.po index 3c236aa5362..7b92c6024bb 100644 --- a/source/ja/helpcontent2/source/text/scalc.po +++ b/source/ja/helpcontent2/source/text/scalc.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-03-20 12:49+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -250,42 +250,6 @@ msgctxt "" msgid "Cells" msgstr "セル" -#. V6AvZ -#: main0105.xhp -msgctxt "" -"main0105.xhp\n" -"hd_id3145748\n" -"help.text" -msgid "Character" -msgstr "文字" - -#. KN9sa -#: main0105.xhp -msgctxt "" -"main0105.xhp\n" -"hd_id3154485\n" -"help.text" -msgid "Paragraph" -msgstr "段落" - -#. 4uQFo -#: main0105.xhp -msgctxt "" -"main0105.xhp\n" -"hd_id3157980\n" -"help.text" -msgid "AutoFormat" -msgstr "" - -#. 3Eg3G -#: main0105.xhp -msgctxt "" -"main0105.xhp\n" -"hd_id3159206\n" -"help.text" -msgid "Conditional Formatting" -msgstr "条件付き書式設定..." - #. tnar9 #: main0105.xhp msgctxt "" diff --git a/source/ja/helpcontent2/source/text/scalc/00.po b/source/ja/helpcontent2/source/text/scalc/00.po index 173c65627af..33c0789705f 100644 --- a/source/ja/helpcontent2/source/text/scalc/00.po +++ b/source/ja/helpcontent2/source/text/scalc/00.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2021-11-30 06:46+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -1672,6 +1672,96 @@ msgctxt "" msgid "Format Menu" msgstr "書式メニュー" +#. pC9kk +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id321701545027940\n" +"help.text" +msgid "Choose Format - Sparklines." +msgstr "" + +#. BhWSr +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id491701553926646\n" +"help.text" +msgid "In a cell with sparklines, choose Sparklines." +msgstr "" + +#. SGyNP +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id21701561553735\n" +"help.text" +msgid "On the Data menu of the Data tab, choose Sparklines." +msgstr "" + +#. WPudy +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id81701536119142\n" +"help.text" +msgid "Choose Format - Spreadsheet Themes." +msgstr "" + +#. YMdQf +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id611701536216717\n" +"help.text" +msgid "Choose Layout - Spreadsheet Themes." +msgstr "" + +#. nh94Q +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id3155132\n" +"help.text" +msgid "Icon Themes" +msgstr "" + +#. By63e +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id3153953\n" +"help.text" +msgid "Choose Themes" +msgstr "" + +#. Jmsgx +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id181698927976688\n" +"help.text" +msgid "Choose Format - Number Format." +msgstr "" + +#. 9z6Gx +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id301698928319097\n" +"help.text" +msgid "Choose Home." +msgstr "" + +#. Bv4Qv +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id721698928559289\n" +"help.text" +msgid "Access the Number Format deck of the Properties Panel." +msgstr "" + #. TmWCz #: 00000405.xhp msgctxt "" @@ -1681,6 +1771,15 @@ msgctxt "" msgid "Choose Format - Cells." msgstr "書式 → セル を選択します。" +#. PEBkG +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id361700498438435\n" +"help.text" +msgid "Choose Format Cells." +msgstr "" + #. DEPHV #: 00000405.xhp msgctxt "" @@ -1735,13 +1834,94 @@ msgctxt "" msgid "Choose Format - Columns - Hide." msgstr "" -#. LbHeW +#. FoGvR #: 00000405.xhp msgctxt "" "00000405.xhp\n" -"par_id3151114\n" +"par_id831700513819432\n" "help.text" -msgid "Choose Sheet - Hide Sheet." +msgid "Click on the rows headers to select, choose Hide Rows." +msgstr "" + +#. wxn8L +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id321700513823426\n" +"help.text" +msgid "Click on the columns headers to select, choose Hide Columns." +msgstr "" + +#. tjBgT +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id671700514153401\n" +"help.text" +msgid "Choose Home - Rows - Hide Rows." +msgstr "" + +#. BsU3u +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id191700514157898\n" +"help.text" +msgid "Choose Home - Columns - Hide Columns." +msgstr "" + +#. fqGhm +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id411700514162075\n" +"help.text" +msgid "Choose Layout - Rows - Hide Rows." +msgstr "" + +#. JUPbu +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id861700514166156\n" +"help.text" +msgid "Choose Layout - Columns - Hide Columns." +msgstr "" + +#. HjY2e +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id481700513853264\n" +"help.text" +msgid "Icon Hide Rows" +msgstr "" + +#. 7XJ6H +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id271700513853268\n" +"help.text" +msgid "Hide Rows" +msgstr "" + +#. mpbyc +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id991700513860257\n" +"help.text" +msgid "Icon Hide Columns" +msgstr "" + +#. kpKu2 +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id911700513860261\n" +"help.text" +msgid "Hide Columns" msgstr "" #. dGUoz @@ -1762,6 +1942,96 @@ msgctxt "" msgid "Choose Format - Columns - Show." msgstr "" +#. 5LSog +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id701700515229874\n" +"help.text" +msgid "Click on the columns headers to select, choose Show Rows." +msgstr "" + +#. BjpaW +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id271700515233843\n" +"help.text" +msgid "Click on the columns headers to select, choose Show Columns." +msgstr "" + +#. SB5Ep +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id451700515369771\n" +"help.text" +msgid "Choose Home - Rows - Show Rows." +msgstr "" + +#. GDVkE +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id261700515372556\n" +"help.text" +msgid "Choose Home - Columns - Show Columns." +msgstr "" + +#. 5EAEu +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id221700515375420\n" +"help.text" +msgid "Choose Layout - Rows - Show Rows." +msgstr "" + +#. WNGyg +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id521700515378076\n" +"help.text" +msgid "Choose Layout - Columns - Show Columns." +msgstr "" + +#. YarF2 +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id651700515398519\n" +"help.text" +msgid "Icon Show Rows" +msgstr "" + +#. t7esA +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id41700515398523\n" +"help.text" +msgid "Show Rows" +msgstr "" + +#. RtaST +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id111700515405883\n" +"help.text" +msgid "Icon Show Columns" +msgstr "" + +#. q797z +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id301700515405886\n" +"help.text" +msgid "Show Columns" +msgstr "" + #. 9hBja #: 00000405.xhp msgctxt "" @@ -1825,6 +2095,42 @@ msgctxt "" msgid "Choose Format - Print Ranges." msgstr "" +#. jBnaP +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id661700524225883\n" +"help.text" +msgid "Choose Layout tab." +msgstr "" + +#. btSnC +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id231700521865773\n" +"help.text" +msgid "On the Layout menu of the Layout tab, choose Print Ranges." +msgstr "" + +#. gwyHA +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id251700524311207\n" +"help.text" +msgid "Icon Print Ranges" +msgstr "" + +#. RJgUA +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id561700524311211\n" +"help.text" +msgid "Print Ranges" +msgstr "" + #. 8mFPE #: 00000405.xhp msgctxt "" @@ -1834,6 +2140,42 @@ msgctxt "" msgid "Choose Format - Print Ranges - Define." msgstr "" +#. N5w3k +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id191700524851592\n" +"help.text" +msgid "Choose Layout - Print Area tab." +msgstr "" + +#. FTVBr +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id881700524946114\n" +"help.text" +msgid "On the Layout menu of the Layout tab, choose Print Ranges - Define" +msgstr "" + +#. CJZZb +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id211700525060553\n" +"help.text" +msgid "Icon Define Print Area" +msgstr "" + +#. E3f4m +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id951700525060557\n" +"help.text" +msgid "Define Print Area" +msgstr "" + #. BneiE #: 00000405.xhp msgctxt "" @@ -1843,6 +2185,42 @@ msgctxt "" msgid "Choose Format - Print Ranges - Add." msgstr "" +#. mkAMG +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id421700526081438\n" +"help.text" +msgid "Choose Layout - Add Print Ranges tab." +msgstr "" + +#. ELmmn +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id231700526084582\n" +"help.text" +msgid "On the Layout menu of the Layout tab, choose Print Ranges - Add." +msgstr "" + +#. FRNDM +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id931700526048362\n" +"help.text" +msgid "Icon Add Print Area" +msgstr "" + +#. DMqKC +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id481700526048365\n" +"help.text" +msgid "Add Print Area" +msgstr "" + #. KgEb2 #: 00000405.xhp msgctxt "" @@ -1852,6 +2230,42 @@ msgctxt "" msgid "Choose Format - Print Ranges - Clear." msgstr "" +#. DWc8F +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id991700526162503\n" +"help.text" +msgid "Choose Layout - Clear Print Ranges tab." +msgstr "" + +#. 5WrWM +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id931700526168487\n" +"help.text" +msgid "On the Layout menu of the Layout tab, choose Print Ranges - Clear." +msgstr "" + +#. ZaqGh +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id931700525434547\n" +"help.text" +msgid "Icon Clear Print Ranges " +msgstr "" + +#. jVGy3 +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id251700525434551\n" +"help.text" +msgid "Clear Print Ranges" +msgstr "" + #. n6cmd #: 00000405.xhp msgctxt "" @@ -1861,6 +2275,42 @@ msgctxt "" msgid "Choose Format - Print Ranges - Edit." msgstr "" +#. poHUh +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id161700525483226\n" +"help.text" +msgid "Choose Layout - Edit tab." +msgstr "" + +#. 6nAjp +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id381700525487691\n" +"help.text" +msgid "On the Layout menu of the Layout tab, choose Print Ranges - Edit." +msgstr "" + +#. Wkb5m +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id611700525855095\n" +"help.text" +msgid "Icon Edit Print Ranges" +msgstr "" + +#. YxHpp +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id901700525855099\n" +"help.text" +msgid "Edit Print Ranges" +msgstr "" + #. 2mGMo #: 00000405.xhp msgctxt "" @@ -1870,13 +2320,13 @@ msgctxt "" msgid "Choose Format - Conditional - Condition." msgstr "" -#. 36aUL +#. sdp2e #: 00000405.xhp msgctxt "" "00000405.xhp\n" -"par_id141663543112100\n" +"par_id741700682477729\n" "help.text" -msgid "On the Formatting bar, click" +msgid "Choose Home - Conditional - Condition." msgstr "" #. VqVh2 @@ -1906,13 +2356,13 @@ msgctxt "" msgid "Choose Format - Conditional - Color Scale" msgstr "" -#. QPRux +#. 5siAY #: 00000405.xhp msgctxt "" "00000405.xhp\n" -"par_id211663543104186\n" +"par_id201700683098791\n" "help.text" -msgid "On the Formatting bar, click" +msgid "Choose Home - Conditional - Color Scale." msgstr "" #. ZHE33 @@ -1942,13 +2392,13 @@ msgctxt "" msgid "Choose Format - Conditional - Data Bar" msgstr "" -#. YJvXG +#. 7xadU #: 00000405.xhp msgctxt "" "00000405.xhp\n" -"par_id81663543094977\n" +"par_id631700683863203\n" "help.text" -msgid "On the Formatting bar, click" +msgid "Choose Home - Conditional - Data Bar." msgstr "" #. qKAB8 @@ -1978,13 +2428,13 @@ msgctxt "" msgid "Choose Format - Conditional - Icon Set" msgstr "" -#. j6oAH +#. cUBFo #: 00000405.xhp msgctxt "" "00000405.xhp\n" -"par_id501663543087343\n" +"par_id951700683459372\n" "help.text" -msgid "On the Formatting bar, click" +msgid "Choose Home - Conditional - Icon Set." msgstr "" #. BKDA9 @@ -2014,13 +2464,13 @@ msgctxt "" msgid "Choose Format - Conditional - Date" msgstr "" -#. bETCm +#. r8S4c #: 00000405.xhp msgctxt "" "00000405.xhp\n" -"par_id351663543077670\n" +"par_id291700683578336\n" "help.text" -msgid "On the Formatting bar, click" +msgid "Choose Home - Conditional - Date." msgstr "" #. dUBco @@ -2050,6 +2500,15 @@ msgctxt "" msgid "Choose Format - Conditional - Manage" msgstr "" +#. 56dYe +#: 00000405.xhp +msgctxt "" +"00000405.xhp\n" +"par_id801700683657730\n" +"help.text" +msgid "Choose Home - Conditional - Manage." +msgstr "" + #. aFWLc #: 00000406.xhp msgctxt "" diff --git a/source/ja/helpcontent2/source/text/scalc/01.po b/source/ja/helpcontent2/source/text/scalc/01.po index 461dc5aecd7..07120eb3742 100644 --- a/source/ja/helpcontent2/source/text/scalc/01.po +++ b/source/ja/helpcontent2/source/text/scalc/01.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2023-07-23 17:35+0000\n" "Last-Translator: Shinji Enoki \n" "Language-Team: Japanese \n" @@ -43117,14 +43117,14 @@ msgctxt "" msgid "Hide" msgstr "非表示" -#. B8BUx +#. bUuCe #: 05030300.xhp msgctxt "" "05030300.xhp\n" "bm_id3147265\n" "help.text" -msgid "spreadsheets; hiding functionshiding; rowshiding; columnshiding; sheetssheets;hidingcolumns;hidingrows;hiding" -msgstr "表計算ドキュメント; 関数を表示しない非表示; 行非表示; 列非表示; シートシート; 非表示列; 非表示行; 非表示" +msgid "spreadsheets; hiding functionshiding; rowshiding; columnscolumns;hidingrows;hiding" +msgstr "" #. eY759 #: 05030300.xhp @@ -43135,33 +43135,15 @@ msgctxt "" msgid "Hide" msgstr "非表示" -#. efsZE +#. dvAWs #: 05030300.xhp msgctxt "" "05030300.xhp\n" "par_id3156281\n" "help.text" -msgid "Hides selected rows, columns or individual sheets." +msgid "Hides selected rows or columns" msgstr "" -#. MJRUG -#: 05030300.xhp -msgctxt "" -"05030300.xhp\n" -"par_id3148645\n" -"help.text" -msgid "Select the rows or columns that you want to hide, and then choose Format - Rows - Hide or Format - Columns - Hide." -msgstr "" - -#. 8yKmD -#: 05030300.xhp -msgctxt "" -"05030300.xhp\n" -"par_id3147427\n" -"help.text" -msgid "You can hide a sheet by selecting the sheet tab and then choosing Format - Sheet - Hide. Hidden sheets are not printed unless they occur within a print range." -msgstr "シートを非表示にするには、シート見出しを選択した上で、メニュー 書式 → シート → 非表示 を選択します。隠されたシートは、印刷範囲に含まれていない場合は印刷されません。" - #. 6Abxr #: 05030300.xhp msgctxt "" @@ -43171,31 +43153,31 @@ msgctxt "" msgid "A break in the row or column header indicates whether the row or column is hidden." msgstr "行や列が表示されていない部分は、行番号や列番号が途切れていることで確認できます。" -#. bEAFm +#. j6BHD #: 05030300.xhp msgctxt "" "05030300.xhp\n" "par_id3145251\n" "help.text" -msgid "To display hidden rows, columns or sheets" -msgstr "表示されていない行や列を再び表示する" +msgid "To display hidden rows or columns" +msgstr "" -#. FGnsj +#. XGN2E #: 05030300.xhp msgctxt "" "05030300.xhp\n" "par_id8337046\n" "help.text" -msgid "Select the range that includes the hidden objects. You can also use the box in the corner above row 1 and beside column A. For sheets, this step is not necessary." -msgstr "隠しオブジェクトを含む範囲を選択します。また、行 1 の上、列 A の隣の角にあるボックスも使用できます。シートについては、この手順を実行する必要はありません。" +msgid "Select the range that includes the hidden objects. You can also use the box in the corner above row 1 and beside column A." +msgstr "" -#. 7fkiG +#. jAJmG #: 05030300.xhp msgctxt "" "05030300.xhp\n" "par_id5532090\n" "help.text" -msgid "Choose Format - Rows/Columns - Show or Format - Sheet - Show." +msgid "Choose Format - Rows/Columns - Show." msgstr "" #. cGFcB @@ -43207,14 +43189,14 @@ msgctxt "" msgid "Show" msgstr "表示" -#. SEBHD +#. PvPE3 #: 05030400.xhp msgctxt "" "05030400.xhp\n" "bm_id3147264\n" "help.text" -msgid "spreadsheets; showing columnsshowing; columnsshowing; rows" -msgstr "表計算ドキュメント; 列を表示する表示; 列表示; 行" +msgid "spreadsheets; showing columnsspreadsheets; showing rowsshowing; columnsshowing; rows" +msgstr "" #. i3RrD #: 05030400.xhp @@ -43234,13 +43216,13 @@ msgctxt "" msgid "Choose this command to show previously hidden rows or columns." msgstr "" -#. 2G8WY +#. 8zThH #: 05030400.xhp msgctxt "" "05030400.xhp\n" "par_id3155131\n" "help.text" -msgid "To show a column or row, select the range of rows or columns containing the hidden elements, then choose Format - Rows - Show or Format - Columns - Show." +msgid "To show a column or row, select the range of rows or columns containing the hidden elements, then apply the command." msgstr "" #. wUVHJ @@ -44791,13 +44773,22 @@ msgctxt "" msgid "Conditional Formatting" msgstr "" -#. VzSfF +#. JahDT #: 05120000.xhp msgctxt "" "05120000.xhp\n" "par_id3163710\n" "help.text" -msgid "Use Conditional Formatting to define range-based conditions that determine which cell style will be applied to each cell in a given range based on its contents. The cell style corresponding to the first condition that evaluates to true is applied. Cell styles applied through Conditional Formatting override cell styles applied manually using the Formatting Bar or the Styles sidebar." +msgid "Use Conditional Formatting to define range-based conditions that determine which cell style will be applied to each cell in a given range based on its contents." +msgstr "" + +#. j6gFF +#: 05120000.xhp +msgctxt "" +"05120000.xhp\n" +"par_id411701538725496\n" +"help.text" +msgid "The cell style corresponding to the first condition that evaluates to true is applied. Cell styles applied through Conditional Formatting override cell styles applied manually using the Formatting Bar or the Styles sidebar." msgstr "" #. 2GWTv @@ -48139,14 +48130,14 @@ msgctxt "" msgid "Ascending" msgstr "昇順" -#. MHKGY +#. VJB3T #: 12030100.xhp msgctxt "" "12030100.xhp\n" "par_id3148645\n" "help.text" -msgid "Sorts the selection from the lowest value to the highest value. The sorting rules are given by the locale. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "選択したデータを最小値から最大値の順番で並べ替えます。並べ替え規則はロケールに依存します。並べ替え規則はデータ → 並べ替え → オプションで定義することができます。デフォルトの設定は%PRODUCTNAME → Preferencesツール → オプション → 言語設定 → 言語から設定できます。" +msgid "Sorts the selection from the lowest value to the highest value. The sorting rules are given by the locale. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. hcoG8 #: 12030100.xhp @@ -48157,14 +48148,14 @@ msgctxt "" msgid "Descending" msgstr "降順" -#. dPy9g +#. mBbPD #: 12030100.xhp msgctxt "" "12030100.xhp\n" "par_id3151075\n" "help.text" -msgid "Sorts the selection from the highest value to the lowest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "選択したデータを最大値から最小値の順番で並べ替えます。並べ替え規則はロケールに依存します。並べ替え規則はデータ → 並べ替え → オプションで定義することができます。デフォルトの設定は%PRODUCTNAME → Preferencesツール → オプション → 言語設定 → 言語から設定できます。" +msgid "Sorts the selection from the highest value to the lowest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. 7N7QL #: 12030100.xhp @@ -48193,14 +48184,14 @@ msgctxt "" msgid "Ascending" msgstr "昇順" -#. SHV5X +#. WZh4v #: 12030100.xhp msgctxt "" "12030100.xhp\n" "par_id3154018\n" "help.text" -msgid "Sorts the selection from the lowest value to the highest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages." -msgstr "選択したデータを最小値から最大値の順番で並べ替えます。並べ替え規則はデータ → 並べ替え → オプションで定義することができます。デフォルトの設定は%PRODUCTNAME → Preferencesツール → オプション → 言語設定 → 言語から設定できます。" +msgid "Sorts the selection from the lowest value to the highest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. tvLMc #: 12030100.xhp @@ -48211,14 +48202,14 @@ msgctxt "" msgid "Descending" msgstr "降順" -#. M4Ygg +#. ykbJS #: 12030100.xhp msgctxt "" "12030100.xhp\n" "par_id3145640\n" "help.text" -msgid "Sorts the selection from the highest value to the lowest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages." -msgstr "選択したデータを最高値から最低値の順番で並べ替えます。並べ替え規則はデータ → 並べ替え → オプションで定義することができます。デフォルトの設定は%PRODUCTNAME → 設定ツール → オプション → 言語設定 → 言語から設定できます。" +msgid "Sorts the selection from the highest value to the lowest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. i3uEU #: 12030100.xhp @@ -48229,13 +48220,13 @@ msgctxt "" msgid "Sort Ascending/Descending" msgstr "並べ替え" -#. S9fGF +#. hbqiZ #: 12030100.xhp msgctxt "" "12030100.xhp\n" "par_id3158212\n" "help.text" -msgid "Sorts the selection from the highest to the lowest value, or from the lowest to the highest value. Number fields are sorted by size and text fields by the order of the characters. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages." +msgid "Sorts the selection from the highest to the lowest value, or from the lowest to the highest value. Number fields are sorted by size and text fields by the order of the characters. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. cAFdw @@ -49516,13 +49507,13 @@ msgctxt "" msgid "Ascending" msgstr "昇順" -#. BEhw7 +#. VQE4y #: 12050200.xhp msgctxt "" "12050200.xhp\n" "par_id3155068\n" "help.text" -msgid "Sorts beginning with the lowest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages." +msgid "Sorts beginning with the lowest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. FFhB3 @@ -49534,13 +49525,13 @@ msgctxt "" msgid "Descending" msgstr "降順" -#. cSLHu +#. mGbUj #: 12050200.xhp msgctxt "" "12050200.xhp\n" "par_id3153766\n" "help.text" -msgid "Sorts beginning with the highest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages." +msgid "Sorts beginning with the highest value. You can define the sort rules on Data - Sort - Options. You define the default on %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. qjwrH @@ -53404,6 +53395,141 @@ msgctxt "" msgid "Insert the document title in the cell. The document title is set in the document properties in File - Properties - Description tab." msgstr "" +#. JfG9p +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"tit\n" +"help.text" +msgid "FormatSparklineMenu" +msgstr "" + +#. CGFJG +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id171701544913091\n" +"help.text" +msgid "Sparkline" +msgstr "" + +#. R9bK6 +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id341701544913094\n" +"help.text" +msgid "Opens a menu for sparklines formatting." +msgstr "" + +#. SwZrq +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id291701553478320\n" +"help.text" +msgid "Delete Sparkline" +msgstr "" + +#. iQPET +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id351701562068834\n" +"help.text" +msgid "Deletes the sparkline of the current cell, if any." +msgstr "" + +#. UwT6h +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id781701553493248\n" +"help.text" +msgid "Delete Sparkline Group" +msgstr "" + +#. CeS6X +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id381701562072857\n" +"help.text" +msgid "Deletes all sparklines of the group at the current cell or selection." +msgstr "" + +#. MDB2t +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id521701553498239\n" +"help.text" +msgid "Edit Sparkline Group" +msgstr "" + +#. jbHXJ +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id801701562077297\n" +"help.text" +msgid "Edits the properties of the sparkline group. The properties applies to all sparklines in the group." +msgstr "" + +#. 2crMd +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id311701553503214\n" +"help.text" +msgid "Edit Sparkline" +msgstr "" + +#. j86nH +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id241701562081481\n" +"help.text" +msgid "Edits the properties of the sparkline at the current cell, if any." +msgstr "" + +#. VqZDJ +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id651701553509911\n" +"help.text" +msgid "Group Sparklines" +msgstr "" + +#. UbWec +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id141701562085848\n" +"help.text" +msgid "Creates a group for all sparklines selected." +msgstr "" + +#. AYn7w +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"hd_id721701553532678\n" +"help.text" +msgid "Ungroup Sparklines" +msgstr "" + +#. 4VpjR +#: FormatSparklineMenu.xhp +msgctxt "" +"FormatSparklineMenu.xhp\n" +"par_id571701562089666\n" +"help.text" +msgid "Ungroup the sparklines previously grouped." +msgstr "" + #. M4zk3 #: InsertCurrentDate.xhp msgctxt "" @@ -55186,13 +55312,13 @@ msgctxt "" msgid "Number Format" msgstr "" -#. vtUUF +#. uUnUT #: default_number_formats.xhp msgctxt "" "default_number_formats.xhp\n" "par_id211674498160040\n" "help.text" -msgid "Default number formats" +msgid "Default number formats." msgstr "" #. PddvV @@ -55213,6 +55339,15 @@ msgctxt "" msgid "Applies the default number format to the selected cells." msgstr "" +#. AE9V7 +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id701698931147179\n" +"help.text" +msgid "Choose Format - Number Format - General." +msgstr "" + #. acBdB #: default_number_formats.xhp msgctxt "" @@ -55231,6 +55366,15 @@ msgctxt "" msgid "Number Format: General" msgstr "" +#. qraYt +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id41698931229411\n" +"help.text" +msgid "CommandCtrl + Shift + 6" +msgstr "" + #. E7GxE #: default_number_formats.xhp msgctxt "" @@ -55249,6 +55393,15 @@ msgctxt "" msgid "Applies the default decimal number format to the selected cells." msgstr "" +#. BHE9g +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id631698936613282\n" +"help.text" +msgid "Choose Format - Number Format - Number." +msgstr "" + #. hbYJM #: default_number_formats.xhp msgctxt "" @@ -55267,6 +55420,15 @@ msgctxt "" msgid "Number format: Number" msgstr "" +#. 5Uq97 +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id781698936664807\n" +"help.text" +msgid "CommandCtrl + Shift + 1" +msgstr "" + #. w2Sfo #: default_number_formats.xhp msgctxt "" @@ -55285,6 +55447,15 @@ msgctxt "" msgid "Applies the percentage format to the selected cells." msgstr "" +#. VLkoL +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id91698936822420\n" +"help.text" +msgid "Choose Format - Number Format - Percent." +msgstr "" + #. WJkBh #: default_number_formats.xhp msgctxt "" @@ -55303,6 +55474,15 @@ msgctxt "" msgid "Number Format: Percent" msgstr "" +#. qQYYN +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id311698936803456\n" +"help.text" +msgid "CommandCtrl + Shift + 5" +msgstr "" + #. P67mA #: default_number_formats.xhp msgctxt "" @@ -55321,6 +55501,15 @@ msgctxt "" msgid "Applies the default currency format to the selected cells." msgstr "" +#. LPjD3 +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id241698937039687\n" +"help.text" +msgid "Choose Format - Number Format - Currency." +msgstr "" + #. wNvKY #: default_number_formats.xhp msgctxt "" @@ -55339,6 +55528,15 @@ msgctxt "" msgid "Number Format: Currency" msgstr "" +#. LBG9L +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id231698937034449\n" +"help.text" +msgid "CommandCtrl + Shift + 4" +msgstr "" + #. VmqXg #: default_number_formats.xhp msgctxt "" @@ -55357,6 +55555,15 @@ msgctxt "" msgid "Applies the default date format to the selected cells." msgstr "" +#. SpPj2 +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id781698937156995\n" +"help.text" +msgid "Choose Format - Number Format - Date." +msgstr "" + #. LLviv #: default_number_formats.xhp msgctxt "" @@ -55375,6 +55582,15 @@ msgctxt "" msgid "Number Format : Date" msgstr "" +#. n7D8Y +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id111698937176318\n" +"help.text" +msgid "CommandCtrl + Shift + 3" +msgstr "" + #. Gx3sL #: default_number_formats.xhp msgctxt "" @@ -55393,6 +55609,15 @@ msgctxt "" msgid "Applies the default time format to the selected cells." msgstr "" +#. zCtGD +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id971698937239126\n" +"help.text" +msgid "Choose Format - Number Format - Time." +msgstr "" + #. o3DWb #: default_number_formats.xhp msgctxt "" @@ -55429,6 +55654,15 @@ msgctxt "" msgid "Applies the default scientific format to the selected cells." msgstr "" +#. ntySr +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id451698937503910\n" +"help.text" +msgid "Choose Format - Number Format - Scientific." +msgstr "" + #. gCjsN #: default_number_formats.xhp msgctxt "" @@ -55447,6 +55681,60 @@ msgctxt "" msgid "Number Format: Scientific" msgstr "" +#. e3cfe +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id221698937519539\n" +"help.text" +msgid "CommandCtrl + Shift + 2" +msgstr "" + +#. 58fR5 +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"hd_id561698937896512\n" +"help.text" +msgid "Number Format: Thousands Separator" +msgstr "" + +#. uutvg +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id171698938218575\n" +"help.text" +msgid "Applies the thousand separator to the number in the selected cells." +msgstr "" + +#. YNCMi +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id541698938166667\n" +"help.text" +msgid "Choose Format - Number Format - Thousands Separator." +msgstr "" + +#. NN4JJ +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id741698938025705\n" +"help.text" +msgid "Icon Number Format: Thousands Separator" +msgstr "" + +#. kkACB +#: default_number_formats.xhp +msgctxt "" +"default_number_formats.xhp\n" +"par_id971698938025711\n" +"help.text" +msgid "Number Format: Thousands Separator" +msgstr "" + #. SFQkA #: default_number_formats.xhp msgctxt "" @@ -70117,13 +70405,13 @@ msgctxt "" msgid "=YEAR(33333.33) returns 1991" msgstr "=YEAR(33333.33) は、1991 を返します。" -#. YXa5g +#. GUGFE #: func_year.xhp msgctxt "" "func_year.xhp\n" "par_id141577548861101\n" "help.text" -msgid "=YEAR(DATEVALUE('2010-09-28')) returns 2010." +msgid "=YEAR(DATEVALUE(\"2010-09-28\")) returns 2010." msgstr "" #. 6QEEQ @@ -70351,6 +70639,15 @@ msgctxt "" msgid "The hidden sheet does not show in the sheet navigation bar on the bottom of the screen. However the hidden sheets are listed in the Navigator sidebar under Sheets category. Double clicking on a hidden sheet from the Navigator sidebar position the viewing on the first sheet visible on the right." msgstr "" +#. ocxGD +#: hide_sheet.xhp +msgctxt "" +"hide_sheet.xhp\n" +"par_id3147427\n" +"help.text" +msgid "Hidden sheets are not printed unless they occur within a print range." +msgstr "" + #. keAF3 #: live_data_stream.xhp msgctxt "" diff --git a/source/ja/helpcontent2/source/text/scalc/02.po b/source/ja/helpcontent2/source/text/scalc/02.po index 47d8898e00a..b488722fa31 100644 --- a/source/ja/helpcontent2/source/text/scalc/02.po +++ b/source/ja/helpcontent2/source/text/scalc/02.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-03-13 11:38+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-03-20 12:48+0000\n" "Last-Translator: AAAA <20001722@protonmail.com>\n" "Language-Team: Japanese \n" @@ -448,24 +448,6 @@ msgctxt "" msgid "Applies a formatting style to the selected cells. The styles include font, border, and background color information." msgstr "選択したセルに書式設定スタイル (テーマ) を適用します。 スタイルには、フォント、外枠、および背景の色情報が含まれます。" -#. SEmnU -#: 06080000.xhp -msgctxt "" -"06080000.xhp\n" -"par_id3155132\n" -"help.text" -msgid "Icon" -msgstr "アイコン" - -#. cgZs2 -#: 06080000.xhp -msgctxt "" -"06080000.xhp\n" -"par_id3153953\n" -"help.text" -msgid "Choose Themes" -msgstr "テーマの選択" - #. xWp4x #: 06080000.xhp msgctxt "" diff --git a/source/ja/helpcontent2/source/text/scalc/guide.po b/source/ja/helpcontent2/source/text/scalc/guide.po index a971e7791a1..f6d099dd141 100644 --- a/source/ja/helpcontent2/source/text/scalc/guide.po +++ b/source/ja/helpcontent2/source/text/scalc/guide.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-05-10 09:33+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -4120,14 +4120,14 @@ msgctxt "" msgid "Cells in Currency Format" msgstr "通貨書式のセル" -#. Tq9vD +#. 5uRt9 #: currency_format.xhp msgctxt "" "currency_format.xhp\n" "par_id3153968\n" "help.text" -msgid "In %PRODUCTNAME Calc you can give numbers any currency format. When you click the Currency icon Icon in the Formatting bar to format a number, the cell is given the default currency format set under %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "%PRODUCTNAME Calc では、数値に任意の通貨書式を設定できます。 書式設定 バーの 通貨 アイコン アイコン をクリックして数値の書式設定を行なった場合、%PRODUCTNAME → 設定ツール → オプション → 言語設定 → 言語 で設定された標準の通貨書式がセルに設定されます。" +msgid "In %PRODUCTNAME Calc you can give numbers any currency format. When you click the Currency icon Icon in the Formatting bar to format a number, the cell is given the default currency format set under %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. UWxwb #: currency_format.xhp @@ -5605,14 +5605,14 @@ msgctxt "" msgid "theme selection for sheetslayout;spreadsheetscell styles; selectingselecting;formatting themessheets;formatting themesformats;themes for sheetsformatting;themes for sheets" msgstr "シートのテーマを選択するレイアウト;表計算ドキュメントセルスタイル; 選択する選択;テーマの書式設定表;テーマの書式設定書式;表のテーマ書式設定;表のテーマ" -#. dt6vR +#. qn4Wm #: design.xhp msgctxt "" "design.xhp\n" "hd_id3150791\n" "help.text" -msgid "Selecting Themes for Sheets " -msgstr "シートのテーマを選択する " +msgid "Selecting Themes for Sheets" +msgstr "" #. axrVR #: design.xhp diff --git a/source/ja/helpcontent2/source/text/schart/01.po b/source/ja/helpcontent2/source/text/schart/01.po index dfadb13fa60..978f4960c5e 100644 --- a/source/ja/helpcontent2/source/text/schart/01.po +++ b/source/ja/helpcontent2/source/text/schart/01.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2022-12-07 19:22+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-03-11 16:10+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -610,13 +610,13 @@ msgctxt "" msgid "Text Orientation" msgstr "文字の方向" -#. zgASX +#. F3eph #: 04020000.xhp msgctxt "" "04020000.xhp\n" "par_id1106200812072653\n" "help.text" -msgid "This feature is only available if complex text layout support is enabled in %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages." +msgid "This feature is only available if complex text layout support is enabled in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. P8c8j diff --git a/source/ja/helpcontent2/source/text/shared/00.po b/source/ja/helpcontent2/source/text/shared/00.po index 5291927e705..bd1603250ff 100644 --- a/source/ja/helpcontent2/source/text/shared/00.po +++ b/source/ja/helpcontent2/source/text/shared/00.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2023-02-08 15:34+0000\n" "Last-Translator: AAAA \n" "Language-Team: Japanese \n" @@ -2518,13 +2518,13 @@ msgctxt "" msgid "Currently, $[officename] supports Hindi, Thai, Hebrew, and Arabic as CTL languages." msgstr "現行の $[officename] がサポートする CTL には、ヒンディー語、タイ語、ヘブライ語、アラビア語があります。" -#. 44SU7 +#. RLKoE #: 00000005.xhp msgctxt "" "00000005.xhp\n" "par_id3151176\n" "help.text" -msgid "Enable CTL support using %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." +msgid "Enable CTL support using %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. hfzNy @@ -3463,14 +3463,14 @@ msgctxt "" msgid "Asian Language Support" msgstr "アジア諸言語のサポート" -#. QmBV9 +#. DQj68 #: 00000007.xhp msgctxt "" "00000007.xhp\n" "par_id3156326\n" "help.text" -msgid "These commands can only be accessed after you enable support for Asian languages in %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "これらのコマンドは、%PRODUCTNAME - 設定ツール - オプション - 言語設定 - 言語のアジア諸言語のサポートが有効である場合にのみ使用可能です。" +msgid "These commands can only be accessed after you enable support for Asian languages in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. A9MQV #: 00000010.xhp @@ -11365,76 +11365,76 @@ msgctxt "" msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Load/Save - HTML Compatibility." msgstr "" -#. YHyBe +#. X5F95 #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3146792\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales." msgstr "" -#. gKe5o +#. uMYtL #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3157965\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" -#. 5siZv +#. uefXD #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3155446\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages - Complex Text Layout." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General - Complex Text Layout." msgstr "" -#. NyrwR +#. FSnAv #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3150745\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" -#. wnqM4 +#. PnzDU #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3148407\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Writing Aids,
in the Available language modules list, select one of the language modules and then click Edit." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Writing Aids,
in the Available language modules list, select one of the language modules and then click Edit." msgstr "" -#. kiJ8R +#. 5EP4j #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3150324\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Writing Aids." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Writing Aids." msgstr "" -#. 4MxDV +#. CB2Ge #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3145620\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Searching in Japanese." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Searching in Japanese." msgstr "" -#. GfKWG +#. faAbr #: 00000406.xhp msgctxt "" "00000406.xhp\n" "par_id3147341\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Asian Layout." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Asian Layout." msgstr "" #. xGRHT @@ -17512,6 +17512,42 @@ msgctxt "" msgid "Open context menu of a row header in an open database table - choose Row Height." msgstr "" +#. WmroD +#: 00040503.xhp +msgctxt "" +"00040503.xhp\n" +"par_id201700500586824\n" +"help.text" +msgid "Choose Layout - Row - Row Height." +msgstr "" + +#. 3WiCf +#: 00040503.xhp +msgctxt "" +"00040503.xhp\n" +"par_id281700502637222\n" +"help.text" +msgid "Choose Home - Row - Row Height." +msgstr "" + +#. EMxGG +#: 00040503.xhp +msgctxt "" +"00040503.xhp\n" +"par_id31700500898395\n" +"help.text" +msgid "Icon Row Height" +msgstr "" + +#. zEqrY +#: 00040503.xhp +msgctxt "" +"00040503.xhp\n" +"par_id511700500898399\n" +"help.text" +msgid "Row Height" +msgstr "" + #. pZBTt #: 00040503.xhp msgctxt "" diff --git a/source/ja/helpcontent2/source/text/shared/01.po b/source/ja/helpcontent2/source/text/shared/01.po index fe4047c508a..420addf8495 100644 --- a/source/ja/helpcontent2/source/text/shared/01.po +++ b/source/ja/helpcontent2/source/text/shared/01.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-05-10 09:33+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -15946,14 +15946,14 @@ msgctxt "" msgid "Character" msgstr "記号" -#. Wnwwa +#. cUkuV #: 05020000.xhp msgctxt "" "05020000.xhp\n" "hd_id3150347\n" "help.text" -msgid "Character" -msgstr "記号" +msgid "Character" +msgstr "" #. hFndG #: 05020000.xhp @@ -16063,13 +16063,13 @@ msgctxt "" msgid "Complex text layout font - right-to-left text direction" msgstr "複合文字言語 (CTL) - 文字の方向右から左へ" -#. iVVkD +#. saFHp #: 05020100.xhp msgctxt "" "05020100.xhp\n" "par_id3153663\n" "help.text" -msgid "To enable support for complex text layout and Asian character sets, choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages, and then select the Enabled box in the corresponding area." +msgid "To enable support for complex text layout and Asian character sets, choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General, and then select the Enabled box in the corresponding area." msgstr "" #. Uf2n9 @@ -16954,13 +16954,13 @@ msgctxt "" msgid "Thousands separator" msgstr "" -#. ZZLrB +#. vADBt #: 05020300.xhp msgctxt "" "05020300.xhp\n" "par_id3146148\n" "help.text" -msgid "Inserts a separator between thousands. The type of separator that is used depends on your language settings." +msgid "Inserts a separator between thousands. The type of separator that is used depends on your locale settings." msgstr "" #. 2GVUQ @@ -18124,13 +18124,13 @@ msgctxt "" msgid "To enter a date in a cell, use the Gregorian calendar format. For example, in an English locale, enter 1/2/2002 for Jan 2, 2002." msgstr "" -#. 5XpSD +#. G3QCz #: 05020301.xhp msgctxt "" "05020301.xhp\n" "par_id3153274\n" "help.text" -msgid "All date formats are dependent on the locale that is set in %PRODUCTNAME - PreferencesTools - Options - Language settings - Languages. For example, if your locale is set to 'Japanese', then the Gengou calendar is used. The default date format in %PRODUCTNAME uses the Gregorian Calendar." +msgid "All date formats are dependent on the locale that is set in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General. For example, if your locale is set to 'Japanese', then the Gengou calendar is used. The default date format in %PRODUCTNAME uses the Gregorian Calendar." msgstr "" #. AQoi2 @@ -21598,13 +21598,13 @@ msgctxt "" msgid "Asian Typography" msgstr "日本語文の体裁" -#. 7qAta +#. 4vq7o #: 05020700.xhp msgctxt "" "05020700.xhp\n" "par_id3153124\n" "help.text" -msgid "Set the typographic options for cells or paragraphs in Asian language files. To enable Asian language support, choose Language Settings - Languages in the Options dialog box, and then select the Enabled box in the Asian language support area. The Asian typography options are ignored in HTML documents." +msgid "Set the typographic options for cells or paragraphs in Asian language files. To enable Asian language support, choose Languages and Locales - General in the Options dialog box, and then select the Enabled box in the Asian language support area. The Asian typography options are ignored in HTML documents." msgstr "" #. qgmeT @@ -21634,14 +21634,14 @@ msgctxt "" msgid "Apply list of forbidden characters to the beginning and end of line" msgstr "行頭および行末の禁則文字のリストで禁則処理を行う" -#. 2JDnf +#. 2ARfb #: 05020700.xhp msgctxt "" "05020700.xhp\n" "par_id3153683\n" "help.text" -msgid "Prevents the characters in the list from starting or ending a line. The characters are relocated to either the previous or the next line. To edit the list of restricted characters, choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Asian Layout." -msgstr "このリストで指定した文字が行頭や行末にならないように調整します。そのような文字は前後の行に移動されます。禁則文字のリストの変更は、%PRODUCTNAME → 設定ツール → オプション → 言語設定 → 日本語レイアウト で設定します。" +msgid "Prevents the characters in the list from starting or ending a line. The characters are relocated to either the previous or the next line. To edit the list of restricted characters, choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Asian Layout." +msgstr "" #. fjYBm #: 05020700.xhp @@ -21697,22 +21697,31 @@ msgctxt "" msgid "Paragraph" msgstr "段落" -#. Spx9H +#. YPAQN #: 05030000.xhp msgctxt "" "05030000.xhp\n" "hd_id3150467\n" "help.text" -msgid "Paragraph" -msgstr "段落" +msgid "Paragraph" +msgstr "" -#. w6EvU +#. JgzCz #: 05030000.xhp msgctxt "" "05030000.xhp\n" "par_id3148668\n" "help.text" -msgid "Modifies the format of the current paragraph, such as indents and alignment. To modify the font of the current paragraph, select the entire paragraph, choose Format - Character, and then click on the Font tab." +msgid "Modifies the format of the current paragraph, such as indents and alignment." +msgstr "" + +#. mSJeA +#: 05030000.xhp +msgctxt "" +"05030000.xhp\n" +"par_id871700518278884\n" +"help.text" +msgid "To modify the font of the current paragraph, select the entire paragraph, choose Format - Character, and then click on the Font tab." msgstr "" #. PvcTF @@ -37303,13 +37312,13 @@ msgctxt "" msgid "Chinese Conversion" msgstr "中国語変換" -#. p2u2r +#. VH5zB #: 06010600.xhp msgctxt "" "06010600.xhp\n" "par_idN10557\n" "help.text" -msgid "Converts the selected Chinese text from one Chinese writing system to the other. If no text is selected, the entire document is converted. You can only use this command if you enable Asian language support in %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." +msgid "Converts the selected Chinese text from one Chinese writing system to the other. If no text is selected, the entire document is converted. You can only use this command if you enable Asian language support in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. vV8HV @@ -44908,13 +44917,13 @@ msgctxt "" msgid "Hangul/Hanja Conversion" msgstr "ハングル/ハンチャ 変換" -#. B7EXU +#. FNJxp #: 06200000.xhp msgctxt "" "06200000.xhp\n" "par_id3146060\n" "help.text" -msgid "Converts the selected Korean text from Hangul to Hanja or from Hanja to Hangul. The menu command can only be called if you enable Asian language support under %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages, and if a text formatted in Korean language is selected." +msgid "Converts the selected Korean text from Hangul to Hanja or from Hanja to Hangul. The menu command can only be called if you enable Asian language support under %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General, and if a text formatted in Korean language is selected." msgstr "" #. 6EGdk @@ -54736,13 +54745,13 @@ msgctxt "" msgid "First page is left" msgstr "" -#. VunCm +#. kLZVx #: ref_pdf_export_initial_view.xhp msgctxt "" "ref_pdf_export_initial_view.xhp\n" "par_id9596850\n" "help.text" -msgid "Select to generate a PDF file that shows pages side by side in a continuous column. For more than two pages, the first page is displayed on the left. You must enable support for complex text layout on Language settings - Languages in the Options dialog box." +msgid "Select to generate a PDF file that shows pages side by side in a continuous column. For more than two pages, the first page is displayed on the left. You must enable support for complex text layout on Languages and Locales - General in the Options dialog box." msgstr "" #. 5DSPy diff --git a/source/ja/helpcontent2/source/text/shared/02.po b/source/ja/helpcontent2/source/text/shared/02.po index fa1867426e8..25a49211ab0 100644 --- a/source/ja/helpcontent2/source/text/shared/02.po +++ b/source/ja/helpcontent2/source/text/shared/02.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-05-10 09:33+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -13399,24 +13399,15 @@ msgctxt "" msgid "Internet" msgstr "インターネット" -#. qYWYQ +#. n9yuo #: 09070100.xhp msgctxt "" "09070100.xhp\n" "par_id3154230\n" "help.text" -msgid "Use the Internet page of the Hyperlink dialog to edit hyperlinks with WWW or FTP addresses." +msgid "Use the Internet page of the Hyperlink dialog to edit hyperlinks with WWW addresses." msgstr "" -#. T2DCR -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"par_id3147291\n" -"help.text" -msgid "The fields for the login name, password and anonymous user are only available for FTP addresses." -msgstr "ログイン名、パスワード、匿名ユーザーのフィールドは、FTPアドレスの場合だけ使用できます。" - #. bDHXN #: 09070100.xhp msgctxt "" @@ -13444,24 +13435,6 @@ msgctxt "" msgid "Creates an \"http://\" hyperlink." msgstr "" -#. 2HJFk -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"hd_id3153683\n" -"help.text" -msgid "FTP" -msgstr "FTP" - -#. Cq35W -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"par_id3150693\n" -"help.text" -msgid "Creates an \"FTP://\" hyperlink." -msgstr "" - #. AJC9F #: 09070100.xhp msgctxt "" @@ -13507,60 +13480,6 @@ msgctxt "" msgid "Once the hyperlink has been completely entered, click on Close to set the link and leave the dialog." msgstr "ハイパーリンクの入力を完了し、 閉じる をクリックすると、リンクが設定され、ダイアログが終了されます。" -#. 9rG9A -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"hd_id3153320\n" -"help.text" -msgid "Login name" -msgstr "ログイン名" - -#. byBAR -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"par_id3151384\n" -"help.text" -msgid "Specifies your login name, if you are working with FTP addresses." -msgstr "" - -#. w6BD3 -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"hd_id3148944\n" -"help.text" -msgid "Password" -msgstr "パスワード" - -#. ANGGA -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"par_id3145069\n" -"help.text" -msgid "Specifies your password, if you are working with FTP addresses." -msgstr "" - -#. nGHkf -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"hd_id3149046\n" -"help.text" -msgid "Anonymous user" -msgstr "匿名のユーザー" - -#. tXn4B -#: 09070100.xhp -msgctxt "" -"09070100.xhp\n" -"par_id3152771\n" -"help.text" -msgid "Allows you to log in to the FTP address as an anonymous user." -msgstr "" - #. TBSuR #: 09070100.xhp msgctxt "" diff --git a/source/ja/helpcontent2/source/text/shared/guide.po b/source/ja/helpcontent2/source/text/shared/guide.po index 9d4ba7d1f0c..7aad3352918 100644 --- a/source/ja/helpcontent2/source/text/shared/guide.po +++ b/source/ja/helpcontent2/source/text/shared/guide.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-11 14:17+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-12-12 13:30+0000\n" "Last-Translator: serval2412 \n" "Language-Team: Japanese \n" @@ -6748,23 +6748,23 @@ msgctxt "" msgid "Use the Right or Left Arrow key to jump to the next or previous whole composite character. To position the cursor into a composite character, use OptionAlt+Arrow key." msgstr "右または左矢印キーを使用して、次または前の複合文字全体にジャンプできます。カーソルを複合文字に合わせるには、(Option)(Alt) + 矢印キーを使用します。" -#. uBEpB +#. bEG2m #: ctl.xhp msgctxt "" "ctl.xhp\n" "par_id3145786\n" "help.text" -msgid "%PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages" -msgstr "%PRODUCTNAME → 設定ツール → オプション言語設定 → 言語" +msgid "%PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General" +msgstr "" -#. CvDdf +#. nCFsH #: ctl.xhp msgctxt "" "ctl.xhp\n" "par_id3153770\n" "help.text" -msgid "%PRODUCTNAME - PreferencesTools - Options - Language Settings - Complex Text Layout" -msgstr "%PRODUCTNAME → 設定ツール → オプション言語設定 → 複合文字レイアウト" +msgid "%PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Complex Text Layout" +msgstr "" #. E7xSj #: data_addressbook.xhp @@ -16747,13 +16747,13 @@ msgctxt "" msgid "Selecting a language for the whole document" msgstr "ドキュメント全体に適用する言語を選択する" -#. E76wE +#. gRekC #: language_select.xhp msgctxt "" "language_select.xhp\n" "par_id3083443\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options. Go to Language Settings - Languages." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options. Go to Languages and Locales - General." msgstr "" #. K5mG8 @@ -17017,13 +17017,13 @@ msgctxt "" msgid "Most users download the American English version, which gives you English menu commands and English application help. If you want another language for the menus (and for the application help, if available in that language), change the UI language as follows." msgstr "ほとんどのユーザーは、米語バージョンをダウンロードします。このバージョンでは、メニューコマンドおよびアプリケーションヘルプが米語で表示されます。別の言語でメニュー (可能であれば、アプリケーションヘルプも) を表示する場合は、次のように、UI 言語を変更します。" -#. aiEFa +#. 6NBGF #: language_select.xhp msgctxt "" "language_select.xhp\n" "par_id3163853\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. m3uwf @@ -17188,14 +17188,14 @@ msgctxt "" msgid "Install the language pack by double-clicking the dmg file." msgstr "dmg ファイルをダブルクリックして言語パックをインストールしてください。" -#. 23McT +#. NEQFe #: language_select.xhp msgctxt "" "language_select.xhp\n" "par_id3150043\n" "help.text" -msgid "%PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages" -msgstr "%PRODUCTNAME → 設定ツール → オプション言語設定 → 言語" +msgid "%PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General" +msgstr "" #. Z2TFq #: language_select.xhp @@ -22291,22 +22291,22 @@ msgctxt "" msgid "Default Value" msgstr "" -#. rBQAU +#. cV4E5 #: pdf_params.xhp msgctxt "" "pdf_params.xhp\n" "par_id21682092689099\n" "help.text" -msgid "If this property is set, it indicates the range of pages to be printed." +msgid "If this property is set, it indicates the range of pages to be exported." msgstr "" -#. cB3D9 +#. TtPCS #: pdf_params.xhp msgctxt "" "pdf_params.xhp\n" "par_id611682092936607\n" "help.text" -msgid "To print all the pages, leave this property unset." +msgid "To export all the pages, leave this property unset." msgstr "" #. DzQF3 @@ -22318,13 +22318,13 @@ msgctxt "" msgid "To export a selection, leave this property unset and set only the property Selection." msgstr "" -#. HGGvb +#. 7GBX9 #: pdf_params.xhp msgctxt "" "pdf_params.xhp\n" "par_id72682092689100\n" "help.text" -msgid "Empty (all pages are printed)" +msgid "Empty (all pages are exported)" msgstr "" #. EP7tx @@ -22579,15 +22579,6 @@ msgctxt "" msgid "Specifies that a stream is inserted to the PDF file which contains the original document for archiving purposes." msgstr "" -#. j6ioN -#: pdf_params.xhp -msgctxt "" -"pdf_params.xhp\n" -"par_id851682097384813\n" -"help.text" -msgid "This option is active only if the PDF Import extension is installed." -msgstr "" - #. R4f6x #: pdf_params.xhp msgctxt "" @@ -22840,13 +22831,13 @@ msgctxt "" msgid "User Interface" msgstr "" -#. Tp3hh +#. nyGzt #: pdf_params.xhp msgctxt "" "pdf_params.xhp\n" "par_id331682103608212\n" "help.text" -msgid "Specifies that the PDF viewer window is opened full screen when the document is opened." +msgid "Specifies that the PDF viewer window is opened showing whole initial page when the document is opened." msgstr "" #. rRaEB @@ -26053,6 +26044,15 @@ msgctxt "" msgid "Replace {install} with the path to your installation of %PRODUCTNAME software (for example, /opt/%PRODUCTNAME in UNIX)" msgstr "" +#. fdsgu +#: start_parameters.xhp +msgctxt "" +"start_parameters.xhp\n" +"par_id3147010\n" +"help.text" +msgid "$[officename] requires write access to its user profile directory." +msgstr "" + #. 4EMfS #: start_parameters.xhp msgctxt "" @@ -26737,13 +26737,13 @@ msgctxt "" msgid "Opens and starts the following presentation documents of each immediately. Files are closed after the showing. Files other than Impress documents are opened in default mode , regardless of previous mode." msgstr "" -#. 7WGYA +#. 5R6iA #: start_parameters.xhp msgctxt "" "start_parameters.xhp\n" "par_id2016120401222926\n" "help.text" -msgid "If --convert-to is used more than once, last value of OutputFileExtension[:OutputFilterName[:OutputFilterParams]] is effective. If --outdir is used more than once, only its last value is effective. For example:" +msgid "If --convert-to is used more than once, last value of OutputFileExtension[:OutputFilterName[:OutputFilterParams]] is effective. If --outdir is used more than once, only its last value is effective. In absence of --outdir, current working directory is used for the result. For example:" msgstr "" #. wBsd4 diff --git a/source/ja/helpcontent2/source/text/shared/optionen.po b/source/ja/helpcontent2/source/text/shared/optionen.po index 35f6a3363e0..ab13acf25ef 100644 --- a/source/ja/helpcontent2/source/text/shared/optionen.po +++ b/source/ja/helpcontent2/source/text/shared/optionen.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-05-22 12:50+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -142,14 +142,14 @@ msgctxt "" msgid "Load/Save" msgstr "読み込みと保存" -#. inAys +#. twRpi #: 01000000.xhp msgctxt "" "01000000.xhp\n" "hd_id3153726\n" "help.text" -msgid "Language Settings" -msgstr "言語設定" +msgid "Languages and Locales" +msgstr "" #. KdFsr #: 01000000.xhp @@ -4993,24 +4993,6 @@ msgctxt "" msgid "Type the name of the proxy server for HTTPS. Type the port in the right-hand field." msgstr "HTTPS用のプロキシサーバーの名前を指定します。 右側のフィールドにはポートを指定します。" -#. DFjVB -#: 01020100.xhp -msgctxt "" -"01020100.xhp\n" -"hd_id3150543\n" -"help.text" -msgid "FTP proxy" -msgstr "FTPプロキシ" - -#. wZpCz -#: 01020100.xhp -msgctxt "" -"01020100.xhp\n" -"par_id3154138\n" -"help.text" -msgid "Type the name of the proxy server for FTP. Type the port in the right-hand field." -msgstr "FTP用のプロキシサーバーを指定します。 右側のフィールドにはポートを指定します。" - #. 2XBfa #: 01020100.xhp msgctxt "" @@ -5038,14 +5020,14 @@ msgctxt "" msgid "You can also use placeholders for the names of hosts and domains. For example, type *.sun.com to address all the hosts in the sun.com domain without proxy." msgstr "ホストやドメインの名前には、プレースホルダーを使用できます。たとえばプロキシを使わずに sun.com 内のホストへ接続する場合は、*.sun.com とします。" -#. sFv3y +#. pgv7r #: 01020100.xhp msgctxt "" "01020100.xhp\n" "par_id3153666\n" "help.text" -msgid "Type the port for the corresponding proxy server. The maximum value of a port number is fixed at 65535." -msgstr "対応するプロキシサーバーのポートを指定します。 ポート番号の最大値は 65535 です。" +msgid "Type the port for the corresponding proxy server. The maximum value of a port number is fixed at 65535." +msgstr "" #. 7oGRX #: 01020300.xhp @@ -5515,14 +5497,14 @@ msgctxt "" msgid "When importing numbers from an HTML page, the decimal separator and the thousands separator characters differ according to the locale of the HTML page. The clipboard however contains no information about the locale. For example, the characters \"1.000\" copied from a German Web page most possibly mean \"one thousand\" because the period is the thousands separator in a German locale. If copied from an English Web page, the same characters stand for the number 1 as in \"one dot zero zero zero\"." msgstr "HTML ページから数字をインポートする場合、10 進数区切り子と千単位の桁区切り記号は HTML ページのロケールによって異なります。 ただし、クリップボードにはロケールに関する情報は含まれていません。 たとえば、ドイツ語ではピリオドが千単位の桁区切り記号を表すため、ドイツ語の Web ページからコピーした「1.000」という文字は、「千」を意味する可能性が高くなります。 同じ文字列を英語の Web ページからコピーした場合は、「1、ドット、0、0、0」なので、数字の 1 を意味します。" -#. Rrotr +#. qYftB #: 01030500.xhp msgctxt "" "01030500.xhp\n" "par_id7658314\n" "help.text" -msgid "If not checked, numbers will be interpreted according to the setting in Language Settings - Language of - Locale setting in the Options dialog box. If checked, numbers will be interpreted as 'English (USA)' locale." -msgstr "チェックされない場合、数字は ツール → オプション → 言語設定 → 言語 → ロケール設定 の設定に従って解釈されます。チェックされる場合、数字は「米国英語」ロケールとして解釈されます。" +msgid "If not checked, numbers will be interpreted according to the setting in Languages and Locales - General - Locale setting in the Options dialog box. If checked, numbers will be interpreted as 'English (USA)' locale." +msgstr "" #. iqsD6 #: 01030500.xhp @@ -5704,14 +5686,14 @@ msgctxt "" msgid "Basic Fonts (Asian)" msgstr "既定のフォント(アジア諸言語)" -#. GdUHr +#. rCXYs #: 01040000.xhp msgctxt "" "01040000.xhp\n" "par_id3147304\n" "help.text" -msgid "Specifies the settings for the basic Asian fonts if Asian language support has been activated under %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "アジア諸言語のサポートが %PRODUCTNAME → 設定ツール → オプション → 言語設定 → 言語 で有効になっている場合に、アジア諸言語の基本フォントを設定します。" +msgid "Specifies the settings for the basic Asian fonts if Asian language support has been activated under %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. Lkg7A #: 01040000.xhp @@ -5722,14 +5704,14 @@ msgctxt "" msgid "Basic Fonts (CTL)" msgstr "既定のフォント(複合文字言語)" -#. RSYFa +#. xiQjD #: 01040000.xhp msgctxt "" "01040000.xhp\n" "par_id3150792\n" "help.text" -msgid "Specifies the settings for basic fonts for complex text layout languages if their support has been activated under %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "複合文字言語 (CTL) のサポートが%PRODUCTNAME → 設定ツール → オプション → 言語設定 → 言語 で有効になっている場合に、CTL の基本フォントを設定します。" +msgid "Specifies the settings for basic fonts for complex text layout languages if their support has been activated under %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. DrtAF #: 01040200.xhp @@ -6172,14 +6154,14 @@ msgctxt "" msgid "Specifies the settings for the basic fonts in your documents." msgstr "" -#. GeU8F +#. sXBnC #: 01040300.xhp msgctxt "" "01040300.xhp\n" "par_id3152349\n" "help.text" -msgid "You can also change the basic fonts for Asian and complex text layout languages if their support is enabled in %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." -msgstr "アジア諸言語と複合文字言語(CTL)での既定のフォントも、そのサポートがオンになっていれば%PRODUCTNAME → 設定ツール → オプション → 言語設定 → 言語 で設定できます。" +msgid "You can also change the basic fonts for Asian and complex text layout languages if their support is enabled in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." +msgstr "" #. AVdy9 #: 01040300.xhp @@ -6586,13 +6568,13 @@ msgctxt "" msgid "Check to print the pages of the brochure in the correct order for a right-to-left script." msgstr "パンフレットのページが右から左へのスクリプト用の正しい順序で印刷されていることを確認します。" -#. YCF2u +#. EDkAS #: 01040400.xhp msgctxt "" "01040400.xhp\n" "par_id251602857011343\n" "help.text" -msgid "This control appears only if Complex text layout is set in %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages." +msgid "This control appears only if Complex text layout is set in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General." msgstr "" #. ap5FC @@ -13003,51 +12985,6 @@ msgctxt "" msgid "Defines the spacing between tab stops." msgstr "" -#. 3AjAp -#: 01070500.xhp -msgctxt "" -"01070500.xhp\n" -"hd_id3156383\n" -"help.text" -msgid "Presentation" -msgstr "" - -#. FZfh5 -#: 01070500.xhp -msgctxt "" -"01070500.xhp\n" -"hd_id3155903\n" -"help.text" -msgid "Enable remote control" -msgstr "" - -#. DZQWN -#: 01070500.xhp -msgctxt "" -"01070500.xhp\n" -"par_id3155963\n" -"help.text" -msgid "Specifies that you want to enable Bluetooth remote control while Impress is running. Unmark Enable remote control to disable remote controlling." -msgstr "" - -#. 4UBYG -#: 01070500.xhp -msgctxt "" -"01070500.xhp\n" -"hd_id3155904\n" -"help.text" -msgid "Enable Presenter Console" -msgstr "" - -#. uBhWx -#: 01070500.xhp -msgctxt "" -"01070500.xhp\n" -"par_id3155964\n" -"help.text" -msgid "Specifies that you want to enable the Presenter Console during slideshows." -msgstr "" - #. apYhx #: 01070500.xhp msgctxt "" @@ -13939,13 +13876,13 @@ msgctxt "" msgid "Languages (Options)" msgstr "" -#. 7peEQ +#. TdLCw #: 01140000.xhp msgctxt "" "01140000.xhp\n" "bm_id3154751\n" "help.text" -msgid "languages; locale settings locale settings Asian languages; enabling languages; Asian support complex text layout; enabling Arabic;language settings Hebrew;language settings Thai;language settings Hindi;language settings decimal separator key date acceptance patterns" +msgid "languages; locale settings locale settings Asian languages; enabling languages; Asian support complex text layout; enabling Arabic;languages and locales Hebrew;languages and locales Thai;languages and locales Hindi;languages and locales decimal separator key date acceptance patterns" msgstr "" #. Wi3qD @@ -15397,13 +15334,13 @@ msgctxt "" msgid "Enable code completion" msgstr "" -#. CBgJZ +#. DdXPf #: BasicIDE.xhp msgctxt "" "BasicIDE.xhp\n" "par_id2507201509570245\n" "help.text" -msgid "Display methods of a Basic object. Code completion will display the methods of a Basic object, provided the object is a UNO extended type. Its does not work on a generic Object or Variant Basic types." +msgid "Display methods of a Basic object. Code completion will display the methods of a Basic object, provided the object is a UNO extended type, and the option \"Use extended types\" is also on. It does not work on a generic Object or Variant Basic types." msgstr "" #. sCyPU @@ -15586,13 +15523,13 @@ msgctxt "" msgid "Use extended types" msgstr "" -#. SBhMP +#. PjU5g #: BasicIDE.xhp msgctxt "" "BasicIDE.xhp\n" "par_id2507201516150463\n" "help.text" -msgid "Allow UNO object types as valid Basic types. This feature extend the Basic programming language standard types with the %PRODUCTNAME UNO types. This allows the programmer to define variables with the right UNO type and is necessary for the code completion feature." +msgid "Allow UNO object types as valid Basic types. This feature extends the Basic programming language standard types with the %PRODUCTNAME UNO types. This allows the programmer to define variables with the right UNO type and is necessary for the code completion feature." msgstr "" #. oHXGe @@ -16711,13 +16648,13 @@ msgctxt "" msgid "Defines the properties for the LanguageTool server." msgstr "" -#. vWhks +#. JrHXb #: languagetools.xhp msgctxt "" "languagetools.xhp\n" "par_id801673456554456\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - LanguageTool Server" +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - LanguageTool Server" msgstr "" #. JcJES @@ -18187,13 +18124,13 @@ msgctxt "" msgid "DeepL Translator is a machine translation service. DeepL Translator is available as a web-based service." msgstr "" -#. Z4Dk2 +#. xXXnE #: translatetools.xhp msgctxt "" "translatetools.xhp\n" "par_id131673460329000\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language settings - DeepL Server" +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - DeepL Server" msgstr "" #. N6Dod diff --git a/source/ja/helpcontent2/source/text/simpress/01.po b/source/ja/helpcontent2/source/text/simpress/01.po index 90642a12d0b..78fec5fafd0 100644 --- a/source/ja/helpcontent2/source/text/simpress/01.po +++ b/source/ja/helpcontent2/source/text/simpress/01.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-02 11:34+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-03-31 22:24+0000\n" "Last-Translator: AAAA <20001722@protonmail.com>\n" "Language-Team: Japanese \n" @@ -6235,14 +6235,14 @@ msgctxt "" msgid "Slide Show Settings" msgstr "スライドショーの設定" -#. ZM6x4 +#. PJD3o #: 06080000.xhp msgctxt "" "06080000.xhp\n" "par_id3148606\n" "help.text" -msgid "Defines settings for your slide show, including which slide to start from, the way you advance the slides, the type of presentation, and pointer options." -msgstr "スライドショーの設定を定義します。開始スライド、スライド間の移動の方法、プレゼンテーションの種類、ポインターオブジェクトなどを指定できます。" +msgid "Defines settings for your slide show, including how to display it, which slide to start from, the way you advance the slides, and whether you want to use the presenter console or control it remotely." +msgstr "" #. iEAKy #: 06080000.xhp @@ -6424,23 +6424,23 @@ msgctxt "" msgid "Displays the $[officename] logo on the pause slide. The logo cannot be exchanged." msgstr "休止ページに $[officename] のロゴを表示します。このロゴは交換できません。" -#. WCd5n +#. sWkYG #: 06080000.xhp msgctxt "" "06080000.xhp\n" "hd_id3150130\n" "help.text" -msgid "Options" -msgstr "オプション" +msgid "Presentation Options" +msgstr "" -#. CE4gb +#. ALZps #: 06080000.xhp msgctxt "" "06080000.xhp\n" "hd_id3149883\n" "help.text" -msgid "Change slides manually" -msgstr "スライドを手動で変更" +msgid "Disable automatic change of slide" +msgstr "" #. gjhEC #: 06080000.xhp @@ -6451,6 +6451,24 @@ msgctxt "" msgid "Slides never change automatically when this box is selected." msgstr "このボックスを選択している場合、スライドは自動的に変更されません。" +#. VzERx +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"hd_id3152478\n" +"help.text" +msgid "Change slides by clicking on background" +msgstr "背景をクリックして画面切り替え" + +#. 6GKwg +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"par_id3156305\n" +"help.text" +msgid "Advances to the next slide when you click on the background of a slide." +msgstr "スライドの背景をクリックすると、次のスライドに移動します。" + #. oVyJ6 #: 06080000.xhp msgctxt "" @@ -6496,14 +6514,14 @@ msgctxt "" msgid "Anything you write with the pen will appear in your slides after exiting the slideshow. The properties of the pen can be changed by choosing the Pen Width or Change pen Color command in the context menu of the running slide show." msgstr "" -#. LGpvd +#. wxPk5 #: 06080000.xhp msgctxt "" "06080000.xhp\n" "hd_id3153718\n" "help.text" -msgid "Animations allowed" -msgstr "アニメーションを入れる" +msgid "Enable animated images" +msgstr "" #. FwfCe #: 06080000.xhp @@ -6514,32 +6532,14 @@ msgctxt "" msgid "Displays all frames of animated GIF files during the slide show. If this option is not selected, only the first frame of an animated GIF file is displayed." msgstr "スライドショーの際にアニメーション化された GIF ファイルの枠をすべて表示します。 このオプションを選択しないと、アニメーション化された GIF ファイルの最初の枠だけが表示されます。" -#. VzERx -#: 06080000.xhp -msgctxt "" -"06080000.xhp\n" -"hd_id3152478\n" -"help.text" -msgid "Change slides by clicking on background" -msgstr "背景をクリックして画面切り替え" - -#. 6GKwg -#: 06080000.xhp -msgctxt "" -"06080000.xhp\n" -"par_id3156305\n" -"help.text" -msgid "Advances to the next slide when you click on the background of a slide." -msgstr "スライドの背景をクリックすると、次のスライドに移動します。" - -#. qNZEM +#. mVrvA #: 06080000.xhp msgctxt "" "06080000.xhp\n" "hd_id3150960\n" "help.text" -msgid "Presentation always on top" -msgstr "スライドショーが常に前景" +msgid "Keep presentation always on top" +msgstr "" #. batkj #: 06080000.xhp @@ -6550,13 +6550,13 @@ msgctxt "" msgid "The $[officename] window remains on top during the presentation. No other program will show its window in front of your presentation." msgstr " $[officename] ウィンドウは、プレゼンテーションの実行中、前面に表示されます。その他のプログラムでは、このウィンドウがプレゼンテーションの前面に表示されることはありません。" -#. 7TEDr +#. dnXCx #: 06080000.xhp msgctxt "" "06080000.xhp\n" "hd_id6086611\n" "help.text" -msgid "Multiple Displays" +msgid "Display" msgstr "" #. CyE4H @@ -6568,6 +6568,15 @@ msgctxt "" msgid "By default the primary display is used for slide show mode. If the current desktop is displayed on more than one display, you can select which display to use for full screen slide show mode. If the current desktop spans only one display, or if the multi display feature is not supported on the current system, you cannot select another display." msgstr "" +#. tksDe +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"par_id2321543\n" +"help.text" +msgid "These settings are saved in the user configuration and not inside the document." +msgstr "" + #. 3nodF #: 06080000.xhp msgctxt "" @@ -6595,14 +6604,77 @@ msgctxt "" msgid "If the system allows the user to span a window over all available displays, you can also select \"All displays\". In this case the presentation is spanned over all available displays." msgstr "" -#. Zy6y4 +#. 5dDNP #: 06080000.xhp msgctxt "" "06080000.xhp\n" -"par_id2321543\n" +"hd_id801700814088862\n" +"help.text" +msgid "Presenter console" +msgstr "" + +#. Mjgig +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"par_id811700817391617\n" +"help.text" +msgid "The Presenter console provides extra controls and tools useful to the presenter. You can choose to use it in windowed or full screen mode, or disable it entirely." +msgstr "" + +#. ffBZD +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"hd_id841700817775313\n" +"help.text" +msgid "Show navigation bar" +msgstr "" + +#. N27Mg +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"par_id971700817802604\n" +"help.text" +msgid "The navigation bar allows the presenter to control the presentation with buttons at the bottom left of the screen, either with the mouse pointer or directly on display if a touch screen is used." +msgstr "" + +#. VfvEF +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"hd_id591700817455799\n" +"help.text" +msgid "Remote control" +msgstr "" + +#. Be9xm +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"hd_id141700819107315\n" "help.text" -msgid "This setting is saved in the user configuration and not inside the document." -msgstr "この設定はユーザー設定に保存され、ドキュメント内には保存されません。" +msgid "Enable remote control" +msgstr "" + +#. 95kM6 +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"par_id3155963\n" +"help.text" +msgid "Specifies that you want to enable Bluetooth remote control while Impress is running. Unmark Enable remote control to disable remote controlling." +msgstr "" + +#. 2tZxn +#: 06080000.xhp +msgctxt "" +"06080000.xhp\n" +"par_id941700818283800\n" +"help.text" +msgid "A link directs you to the available options to install the application on your device." +msgstr "" #. w2iqM #: 06100000.xhp diff --git a/source/ja/helpcontent2/source/text/simpress/02.po b/source/ja/helpcontent2/source/text/simpress/02.po index 4b54240c12a..b2ef99150e7 100644 --- a/source/ja/helpcontent2/source/text/simpress/02.po +++ b/source/ja/helpcontent2/source/text/simpress/02.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-05-10 12:32+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2021-12-20 07:38+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -1105,13 +1105,13 @@ msgctxt "" msgid "Modifies the gradient fill of the selected object. This command is only available if you applied a gradient to the selected object in Format - Area. Drag the handles of the gradient line to change the direction of the gradient or the length of the gradient. You can also drag and drop colors onto the handles from the Color Bar to change the color of the gradient endpoints." msgstr "" -#. GTj8X +#. XREtB #: 10030000.xhp msgctxt "" "10030000.xhp\n" "par_id3151311\n" "help.text" -msgid "To display the Color Bar, choose View - Toolbars - Color Bar." +msgid "To display the Color Bar, choose View - Color Bar." msgstr "" #. HMYUP diff --git a/source/ja/helpcontent2/source/text/simpress/guide.po b/source/ja/helpcontent2/source/text/simpress/guide.po index 48023e33813..7cdd68b7263 100644 --- a/source/ja/helpcontent2/source/text/simpress/guide.po +++ b/source/ja/helpcontent2/source/text/simpress/guide.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-09-28 12:40+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2021-12-08 09:39+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -4543,22 +4543,22 @@ msgctxt "" msgid "To enable the Presenter Console:" msgstr "" -#. 5rxMR +#. kzpEE #: presenter_console.xhp msgctxt "" "presenter_console.xhp\n" "par_id351512577323192\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - %PRODUCTNAME Impress - General." +msgid "Choose Slide Show - Slide Show Settings." msgstr "" -#. wDfL5 +#. 5KZzc #: presenter_console.xhp msgctxt "" "presenter_console.xhp\n" "par_id411512577389978\n" "help.text" -msgid "Select Enable Presenter Console in the Presentation area." +msgid "In the Display - Presenter console dropdown, select either Full screen or Windowed." msgstr "" #. uvjdu diff --git a/source/ja/helpcontent2/source/text/swriter/00.po b/source/ja/helpcontent2/source/text/swriter/00.po index c8111c08e40..edbed35b3be 100644 --- a/source/ja/helpcontent2/source/text/swriter/00.po +++ b/source/ja/helpcontent2/source/text/swriter/00.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-02 11:34+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2021-11-19 08:37+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -817,13 +817,13 @@ msgctxt "" msgid "Choose Home - Toggle Formatting Marks." msgstr "" -#. xT6wC +#. YDXiu #: 00000403.xhp msgctxt "" "00000403.xhp\n" "par_id641686925453807\n" "help.text" -msgid "Choose Insert - Formatting Marks." +msgid "Choose View - Formatting Marks." msgstr "" #. V9wCc @@ -3643,13 +3643,13 @@ msgctxt "" msgid "Choose Table - Select Table." msgstr "" -#. zvXAG +#. GMg7y #: 00000405.xhp msgctxt "" "00000405.xhp\n" "par_id471693738650304\n" "help.text" -msgid "Icon Select Row" +msgid "Icon Select Table" msgstr "" #. GDfNw diff --git a/source/ja/helpcontent2/source/text/swriter/01.po b/source/ja/helpcontent2/source/text/swriter/01.po index c5d3d834219..852592a90fc 100644 --- a/source/ja/helpcontent2/source/text/swriter/01.po +++ b/source/ja/helpcontent2/source/text/swriter/01.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-11-02 14:48+0100\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2022-05-10 09:32+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -18142,14 +18142,14 @@ msgctxt "" msgid "Text Grid" msgstr "行数と文字数" -#. MtvTq +#. hxADK #: 05040800.xhp msgctxt "" "05040800.xhp\n" "par_id3151171\n" "help.text" -msgid "Adds a text grid to the current page style. This option is only available if Asian language support is enabled under Language Settings - Languages in the Options dialog box." -msgstr "現在のページスタイルに文字の罫線を追加します。 このオプションは、ツール → オプション → 言語設定 → 言語 でアジア諸言語のサポートが有効な場合のみ使用できます。" +msgid "Adds a text grid to the current page style. This option is only available if Asian language support is enabled under Languages and Locales - General in the Options dialog box." +msgstr "" #. hfZYE #: 05040800.xhp @@ -25180,13 +25180,13 @@ msgctxt "" msgid "To exclude paragraphs from the automatic hyphenation, select the paragraphs, choose Format - Paragraph, click the Text Flow tab, and then clear the Automatically check box in the Hyphenation area." msgstr "段落を自動ハイフネーションの対象から外すには、メニュー 書式 → 段落 を選択し、体裁 タブをクリックして、ハイフネーション 領域の 自動 チェックボックスをオフにします。" -#. JePq2 +#. FhJNz #: 06030000.xhp msgctxt "" "06030000.xhp\n" "par_id3154276\n" "help.text" -msgid "To disable the Hyphenation dialog and always hyphenate automatically, choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Writing Aids, and select the Hyphenate without inquiry check box." +msgid "To disable the Hyphenation dialog and always hyphenate automatically, choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Writing Aids, and select the Hyphenate without inquiry check box." msgstr "" #. nxwSz @@ -32812,13 +32812,13 @@ msgctxt "" msgid "Using title pages in your document" msgstr "" -#. 5BAgZ +#. WbiuW #: title_page.xhp msgctxt "" "title_page.xhp\n" "bm_id300920161717389897\n" "help.text" -msgid "page;title pagetitle page;numberingtitle page;numbering" +msgid "page;title pagetitle page;numbering" msgstr "" #. efYTZ @@ -33109,13 +33109,13 @@ msgctxt "" msgid "Translate" msgstr "" -#. xrbs9 +#. uqwfp #: translate.xhp msgctxt "" "translate.xhp\n" "bm_id891673478687650\n" "help.text" -msgid "translate language settings;translate" +msgid "translate languages and locales;translate" msgstr "" #. tQKCM @@ -33136,13 +33136,13 @@ msgctxt "" msgid "Translate the selected text or the whole document using DeepL automatic translation." msgstr "" -#. TRFFb +#. KKfqA #: translate.xhp msgctxt "" "translate.xhp\n" "par_id441673471361857\n" "help.text" -msgid "To enable the Translate command, set the server URL and API key in %PRODUCTNAME - PreferencesTools - Options - Language Settings - DeepL Server." +msgid "To enable the Translate command, set the server URL and API key in %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - DeepL Server." msgstr "" #. YfnQC @@ -33262,13 +33262,13 @@ msgctxt "" msgid "View Images and Charts" msgstr "" -#. AvAbE +#. RATeZ #: view_resolved_comments.xhp msgctxt "" "view_resolved_comments.xhp\n" "tit\n" "help.text" -msgid "page_title" +msgid "View Resolved Comments" msgstr "" #. nRpQa diff --git a/source/ja/helpcontent2/source/text/swriter/guide.po b/source/ja/helpcontent2/source/text/swriter/guide.po index 7da4c095b7b..bf6b13f45d0 100644 --- a/source/ja/helpcontent2/source/text/swriter/guide.po +++ b/source/ja/helpcontent2/source/text/swriter/guide.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-02 11:34+0200\n" +"POT-Creation-Date: 2023-12-04 15:06+0100\n" "PO-Revision-Date: 2023-02-08 15:33+0000\n" "Last-Translator: AAAA \n" "Language-Team: Japanese \n" @@ -4120,14 +4120,14 @@ msgctxt "" msgid "Removing Words From a User-Defined Dictionary" msgstr "ユーザー辞書の登録単語の削除" -#. 9CQEx +#. zKD5g #: delete_from_dict.xhp msgctxt "" "delete_from_dict.xhp\n" "par_id3153417\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Writing Aids." -msgstr "%PRODUCTNAME → 設定ツール → オプション → 言語設定 → 文章作成支援 を選択します。" +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Writing Aids." +msgstr "" #. SEGSf #: delete_from_dict.xhp @@ -5650,14 +5650,14 @@ msgctxt "" msgid "Check the Similarity search option and optionally click the Similarities button to change the settings. (Setting all three numbers to 1 works fine for English text.)" msgstr "類似スペルの検索 オプションをチェックし、必要に応じて 「...」 ボタンをクリックして設定を変更します (3 つの数値をすべて 1 にする設定は英語の文字列に適する)。" -#. G6VBU +#. HY7CC #: finding.xhp msgctxt "" "finding.xhp\n" "par_id4646748\n" "help.text" -msgid "When you have enabled Asian language support under %PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages, the Find & Replace dialog offers options to search Asian text." -msgstr "%PRODUCTNAME → 設定ツール → オプション → 言語設定 →言語 でアジア言語サポートを有効にしてある場合、アジア言語のテキストを検索するオプションが「検索と置換」ダイアログに表示されます。" +msgid "When you have enabled Asian language support under %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General, the Find & Replace dialog offers options to search Asian text." +msgstr "" #. o9DHE #: finding.xhp @@ -8026,13 +8026,13 @@ msgctxt "" msgid "If your text is automatically hyphenated and certain hyphenated words look ugly, or if you want specific words never to be hyphenated you can switch off hyphenation for those words:" msgstr "テキストに 自動的にハイフンが付けられて、特定の単語が適切に表示されない場合や、特定の単語にハイフンを付けたくない場合は、これらの単語のハイフネーションをオフにできます。" -#. Xpjd2 +#. HQFEq #: hyphen_prevent.xhp msgctxt "" "hyphen_prevent.xhp\n" "par_id3153634\n" "help.text" -msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Language Settings - Writing Aids" +msgid "Choose %PRODUCTNAME - PreferencesTools - Options - Languages and Locales - Writing Aids" msgstr "" #. EkpCP diff --git a/source/ja/helpcontent2/source/text/swriter/librelogo.po b/source/ja/helpcontent2/source/text/swriter/librelogo.po index 4b6433d46ef..f24679b90d5 100644 --- a/source/ja/helpcontent2/source/text/swriter/librelogo.po +++ b/source/ja/helpcontent2/source/text/swriter/librelogo.po @@ -3,7 +3,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: https://bugs.libreoffice.org/enter_bug.cgi?product=LibreOffice&bug_status=UNCONFIRMED&component=UI\n" -"POT-Creation-Date: 2023-10-11 14:17+0200\n" +"POT-Creation-Date: 2023-12-04 15:07+0100\n" "PO-Revision-Date: 2022-05-22 12:50+0000\n" "Last-Translator: JO3EMC \n" "Language-Team: Japanese \n" @@ -160,13 +160,13 @@ msgctxt "" msgid "Program editor/Syntax highlighting/Translating" msgstr "プログラムの編集/構文強調表示/翻訳" -#. vwPnb +#. 5FEvG #: LibreLogo.xhp msgctxt "" "LibreLogo.xhp\n" "par_345\n" "help.text" -msgid "The “magic wand” icon sets 2-page layout for program editing, expands and converts to uppercase the abbreviated, lowercase Logo commands in the Writer document. Change the language of the document (%PRODUCTNAME - PreferencesTools - Options - Language Settings - Languages - Western) and click on this icon to translate the Logo program to the selected language." +msgid "The “magic wand” icon sets 2-page layout for program editing, expands and converts to uppercase the abbreviated, lowercase Logo commands in the Writer document. Change the language of the document (%PRODUCTNAME - PreferencesTools - Options - Languages and Locales - General - Western) and click on this icon to translate the Logo program to the selected language." msgstr "" #. UXKqW -- cgit