Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up #28

Merged
merged 2 commits into from
Sep 28, 2023
Merged

Clean up #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62195ed
CleanUp
mlipok Sep 28, 2023
2b79f88
; Remarks .......: Note:
mlipok Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
541 changes: 191 additions & 350 deletions LibreOfficeWriter.au3
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions LibreOfficeWriter_Char.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -950,7 +950,7 @@ EndFunc ;==>_LOWriter_CharStyleOrganizer
; + settings in a 4 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: OverLine line style uses the same constants as underline style.
; Remarks .......: OverLine line style uses the same constants as underline style.
; Call this function with only the required parameters (or with all other parameters set to Null keyword), to
; get the current settings.
; Call any optional parameter with Null keyword to skip it.
Expand Down Expand Up @@ -1204,7 +1204,7 @@ EndFunc ;==>_LOWriter_CharStyleSet
; + returned.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Five Character styles have two separate names, Footnote Characters is also internally called
; Remarks .......: Five Character styles have two separate names, Footnote Characters is also internally called
; "Footnote Symbol"; Bullets, is internally called "Bullet Symbol"; Endnote Characters is internally called
; "Endnote Symbol"; Quotation is internally called "Citation"; and "No Character Style is internally called
; "Standard". Either name works when setting a Character Style, but on certain functions that return a
Expand Down
2 changes: 1 addition & 1 deletion LibreOfficeWriter_DirectFormating.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3029,7 +3029,7 @@ EndFunc ;==>_LOWriter_DirFrmtParTabStopCreate
; @Error 0 @Extended 0 Return Boolean = Returns true if the TabStop was successfully deleted.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $iTabStop refers to the position, or essential the "length" of a TabStop from the edge of a page margin.
; Remarks .......: $iTabStop refers to the position, or essential the "length" of a TabStop from the edge of a page margin.
; This is the only reliable way to identify a Tabstop to be able to interact with it, as there can only be
; one of a certain length per document.
; Related .......: _LOWriter_DirFrmtParTabStopCreate, _LOWriter_DirFrmtParTabStopList, _LOWriter_DocGetViewCursor,
Expand Down
14 changes: 7 additions & 7 deletions LibreOfficeWriter_Doc.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ EndFunc ;==>_LOWriter_DocConnect
; @Error 0 @Extended 0 Return 1 = Success. Table was successfully converted to text.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: This function temporarily moves the Viewcursor to the Table indicated, and then attempts to restore the ViewCursor to its former position.
; Remarks .......: This function temporarily moves the Viewcursor to the Table indicated, and then attempts to restore the ViewCursor to its former position.
; This could cause a COM error if the Cursor was presently in the Table.
; Related .......: _LOWriter_DocConvertTextToTable, _LOWriter_TableGetObjByName, _LOWriter_TableGetObjByCursor,
; _LOWriter_TableInsert
Expand Down Expand Up @@ -747,7 +747,7 @@ EndFunc ;==>_LOWriter_DocConvertTableToText
; @Error 0 @Extended 0 Return Object = Success. Text was successfully converted to a Table, returning the new Table's Object.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: This function temporarily moves the Viewcursor to and selectes the Text, and then attempts to restore the ViewCursor to its former position.
; Remarks .......: This function temporarily moves the Viewcursor to and selectes the Text, and then attempts to restore the ViewCursor to its former position.
; Related .......: _LOWriter_DocGetViewCursor, _LOWriter_DocCreateTextCursor, _LOWriter_CellCreateTextCursor,
; _LOWriter_FrameCreateTextCursor, _LOWriter_DocHeaderGetTextCursor,
; _LOWriter_DocFooterGetTextCursor, _LOWriter_ParObjCreateList, _LOWriter_DocConvertTableToText
Expand Down Expand Up @@ -1406,7 +1406,7 @@ EndFunc ;==>_LOWriter_DocExport
; @Error 0 @Extended ? Return Array = Success. Search was Successful, returning 1 dimensional array containing the objects to each match, @Exteneded is set to the number of matches.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: The Objects returned can be used in any of the functions accepting a Paragraph or Cursor Object etc.,
; Remarks .......: The Objects returned can be used in any of the functions accepting a Paragraph or Cursor Object etc.,
; to modify their properties or even the text itself.
; Related .......: _LOWriter_SearchDescriptorCreate, _LOWriter_DocFindAllInRange, _LOWriter_DocFindNext,
; _LOWriter_DocReplaceAll, _LOWriter_DocReplaceAllInRange, _LOWriter_FindFormatModifyAlignment,
Expand Down Expand Up @@ -2297,7 +2297,7 @@ EndFunc ;==>_LOWriter_DocGetPath
; @Error 0 @Extended 0 Return String = Success. The selected text in String format.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Libre Office documentation states that when used in Libre Basic, GetString is limited to 64kb's in size.
; Remarks .......: Libre Office documentation states that when used in Libre Basic, GetString is limited to 64kb's in size.
; I do not know if the same limitation applies to any outside use of GetString (such as through Autoit).
; Also, if there are multiple selections, the returned value will be an empty string ("").
; Related .......: _LOWriter_DocGetViewCursor, _LOWriter_DocCreateTextCursor, _LOWriter_CellCreateTextCursor,
Expand Down Expand Up @@ -2815,7 +2815,7 @@ EndFunc ;==>_LOWriter_DocIsModified
; @Error 0 @Extended 0 Return Boolean = Success. Returns True is document is currently Read Only, else False.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Only documents that have been saved to a location, will ever be "ReadOnly".
; Remarks .......: Only documents that have been saved to a location, will ever be "ReadOnly".
; Related .......:
; Link ..........:
; Example .......: Yes
Expand Down Expand Up @@ -3562,7 +3562,7 @@ EndFunc ;==>_LOWriter_DocPrintPageSettings
; @Error 0 @Extended 1 Return Array = Success. All optional parameters were set to Null, returning current settings in a 3 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Due to slight inaccuracies in unit conversion, there may be false errors thrown while attempting to
; Remarks .......: Due to slight inaccuracies in unit conversion, there may be false errors thrown while attempting to
; set paper size.
; Call this function with only the required parameters (or with all other parameters set to Null keyword), to
; get the current settings.
Expand Down Expand Up @@ -3941,7 +3941,7 @@ EndFunc ;==>_LOWriter_DocReplaceAll
; + in @Extended.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Libre Office does not offer a Function to call to replace only results within a selection,
; Remarks .......: Libre Office does not offer a Function to call to replace only results within a selection,
; consequently I have had to create my own. This function uses the "FindAllInRange" function,
; so any errors with Find/Replace formatting causing deletions will cause problems here. As best
; as I can tell all options for find and replace should be available, Formatting, Paragraph styles
Expand Down
2 changes: 1 addition & 1 deletion LibreOfficeWriter_Field.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6102,7 +6102,7 @@ EndFunc ;==>_LOWriter_FieldsGetList
; + Show Variable Field Object.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: This function checks if there is a Set Variable matching the name called in $sSetVarName.
; Remarks .......: This function checks if there is a Set Variable matching the name called in $sSetVarName.
; Related .......: _LOWriter_FieldShowVarModify, _LOWriter_FieldSetVarInsert, _LOWriter_FieldsGetList,
; _LOWriter_FormatKeyCreate _LOWriter_FormatKeyList, _LOWriter_DocGetViewCursor,
; _LOWriter_DocCreateTextCursor, _LOWriter_CellCreateTextCursor, _LOWriter_FrameCreateTextCursor,
Expand Down
8 changes: 4 additions & 4 deletions LibreOfficeWriter_Frame.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,7 +993,7 @@ EndFunc ;==>_LOWriter_FrameColumnSettings
; + settings in a 4 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: NOTE: This function will work fine for setting AutoWidth, and Spacing values, however Width will not work the
; Remarks .......: This function will work fine for setting AutoWidth, and Spacing values, however Width will not work the
; best, Spacing etc is set in plain micrometer values, however width is set in a relative value, and I am
; unable to find a way to be able to convert a specific value, such as 1" (2540 Micrometers) etc, to the
; appropriate relative value, especially when spacing is set.
Expand Down Expand Up @@ -1737,7 +1737,7 @@ EndFunc ;==>_LOWriter_FrameOptionsName
; + returned.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: in Docx (and possibly other formats) Frames seem to be saved as "Shapes" instead of "Frames", if this
; Remarks .......: in Docx (and possibly other formats) Frames seem to be saved as "Shapes" instead of "Frames", if this
; function returns no results, or not the ones you expect, try setting $bSearchShapes to true.
; Related .......: _LOWriter_FrameGetObjByName
; Link ..........:
Expand Down Expand Up @@ -2849,7 +2849,7 @@ EndFunc ;==>_LOWriter_FrameStyleColumnSettings
; + settings in a 4 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: NOTE: This function will work fine for setting AutoWidth, and Spacing values, however Width will not work
; Remarks .......: This function will work fine for setting AutoWidth, and Spacing values, however Width will not work
; the best, Spacing etc is set in plain micrometer values, however width is set in a relative value, and I am
; unable to find a way to be able to convert a specific value, such as 1" (2540 Micrometers) etc, to the
; appropriate relative value, especially when spacing is set.
Expand Down Expand Up @@ -5396,7 +5396,7 @@ EndFunc ;==>_LOWriter_FrameWrap
; + settings in a 3 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Contour and Outside only, though shown on the L.O. UI, are not available for frames, as stated in the
; Remarks .......: Contour and Outside only, though shown on the L.O. UI, are not available for frames, as stated in the
; L.O. Offline help file.
; Call this function with only the required parameters (or with all other parameters set to Null keyword), to
; get the current settings.
Expand Down
18 changes: 9 additions & 9 deletions LibreOfficeWriter_Internal.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,7 +921,7 @@ EndFunc ;==>__LOWriter_CharFontColor
; + settings in a 4 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: OverLine line style uses the same constants as underline style.
; Remarks .......: OverLine line style uses the same constants as underline style.
; Call this function with only the Object parameter and all other parameters set to Null keyword, to
; get the current settings.
; Call any optional parameter with Null keyword to skip it.
Expand Down Expand Up @@ -3910,7 +3910,7 @@ EndFunc ;==>__LOWriter_PageStyleNameToggle
; + settings in a 6 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $iHorAlign must be set to $LOW_PAR_ALIGN_HOR_JUSTIFIED(2) before you can set $iLastLineAlign, and
; Remarks .......: $iHorAlign must be set to $LOW_PAR_ALIGN_HOR_JUSTIFIED(2) before you can set $iLastLineAlign, and
; $iLastLineAlign must be set to $LOW_PAR_LAST_LINE_JUSTIFIED(2) before $bExpandSingleWord can be set.
; Note: $iTxtDirection constants 2,3, and 5 may not be available depending on your language settings.
; Call this function with only the Object parameter and all other parameters set to Null keyword, to
Expand Down Expand Up @@ -4360,7 +4360,7 @@ EndFunc ;==>__LOWriter_ParHasTabStop
; + available.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $bAutoHyphen set to True for the rest of the settings to be activated, but they will be still
; Remarks .......: $bAutoHyphen set to True for the rest of the settings to be activated, but they will be still
; successfully set regardless.
; Call this function with only the Object parameter and all other parameters set to Null keyword, to
; get the current settings.
Expand Down Expand Up @@ -4459,7 +4459,7 @@ EndFunc ;==>__LOWriter_ParHyphenation
; + settings in a 4 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $iFirstLine Indent cannot be set if $bAutoFirstLine is set to True.
; Remarks .......: $iFirstLine Indent cannot be set if $bAutoFirstLine is set to True.
; Call this function with only the Object parameter and all other parameters set to Null keyword, to
; get the current settings.
; Call any optional parameter with Null keyword to skip it.
Expand Down Expand Up @@ -4632,7 +4632,7 @@ EndFunc ;==>__LOWriter_ParOutLineAndList
; + settings in a 3 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: Break Type must be set before PageStyle will be able to be set, and page style needs set before
; Remarks .......: Break Type must be set before PageStyle will be able to be set, and page style needs set before
; $iPgNumOffSet can be set.
; Libre doesn't directly show in its User interface options for Break type constants #3 and #6 (Column both)
; and (Page both), but doesn't throw an error when being set to either one, so they are included here,
Expand Down Expand Up @@ -4861,7 +4861,7 @@ EndFunc ;==>__LOWriter_ParShadow
; + settings in a 6 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $bPageLineSpc(Register mode) is only used if the register mode property of the page style is switched
; Remarks .......: $bPageLineSpc(Register mode) is only used if the register mode property of the page style is switched
; on. $bPageLineSpc(Register Mode) Aligns the baseline of each line of text to a vertical document grid,
; so that each line is the same height.
; Note: The settings in Libre Office, (Single,1.15, 1.5, Double,) Use the Proportional mode, and are just
Expand Down Expand Up @@ -5039,7 +5039,7 @@ EndFunc ;==>__LOWriter_ParStyleNameToggle
; + is returned.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $iPosition once set can vary +/- 1 uM. To ensure you can identify the tabstop to modify it again,
; Remarks .......: $iPosition once set can vary +/- 1 uM. To ensure you can identify the tabstop to modify it again,
; This function returns the new TabStop position in @Extended when $iPosition is set, return value will
; be set to 2. See Return Values.
; Note: Since $iPosition can fluctuate +/- 1 uM when it is inserted into LibreOffice, it is possible to
Expand Down Expand Up @@ -5157,7 +5157,7 @@ EndFunc ;==>__LOWriter_ParTabStopCreate
; @Error 0 @Extended 0 Return Boolean = Returns true if TabStop was successfully deleted.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $iTabStop refers to the position, or essential the "length" of a TabStop from the edge of a page
; Remarks .......: $iTabStop refers to the position, or essential the "length" of a TabStop from the edge of a page
; margin. This is the only reliable way to identify a Tabstop to be able to interact with it, as there
; can only be one of a certain length per document.
; Related .......:
Expand Down Expand Up @@ -5293,7 +5293,7 @@ EndFunc ;==>__LOWriter_ParTabStopList
; + returned in @Extended.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: $iTabStop refers to the position, or essential the "length" of a TabStop from the edge of a page margin.
; Remarks .......: $iTabStop refers to the position, or essential the "length" of a TabStop from the edge of a page margin.
; This is the only reliable way to identify a Tabstop to be able to interact with it, as there can only be
; one of a certain length per document.
; Note: $iPosition once set can vary +/- 1 uM. To ensure you can identify the tabstop to modify it again,
Expand Down
4 changes: 2 additions & 2 deletions LibreOfficeWriter_Page.au3
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@ EndFunc ;==>_LOWriter_PageStyleColumnSettings
; + settings in a 4 Element Array with values in order of function parameters.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: NOTE: This function will work fine for setting AutoWidth, and Spacing values, however Width will not work the
; Remarks .......: This function will work fine for setting AutoWidth, and Spacing values, however Width will not work the
; best, Spacing etc is set in plain micrometer values, however width is set in a relative value, and I am
; unable to find a way to be able to convert a specific value, such as 1" (2540 Micrometers) etc, to the
; appropriate relative value, especially when spacing is set.
Expand Down Expand Up @@ -4564,7 +4564,7 @@ EndFunc ;==>_LOWriter_PageStyleSet
; + true then only User-Created Page styles that are applied are returned.
; Author ........: donnyh13
; Modified ......:
; Remarks .......: Note: One Page style has two separate names, Default Page Style is also internally called "Standard" Either
; Remarks .......: One Page style has two separate names, Default Page Style is also internally called "Standard" Either
; name works when setting a Page Style, but on certain functions that return a Page Style Name, you may see
; the alternative name.
; Related .......: _LOWriter_PageStyleGetObj
Expand Down
Loading