LibreOffice Module sc (master)  1
xlstring.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #pragma once
21 
22 #include <vector>
23 #include <o3tl/typed_flags_set.hxx>
24 
25 // Constants and enumerations =================================================
26 
28 enum class XclStrFlags : sal_uInt16 {
29  NONE = 0x0000,
30  ForceUnicode = 0x0001,
31  EightBitLength = 0x0002,
32  SmartFlags = 0x0004,
33  SeparateFormats = 0x0008,
34  NoHeader = 0x0010,
35 };
36 namespace o3tl {
37  template<> struct typed_flags<XclStrFlags> : is_typed_flags<XclStrFlags, 0x001f> {};
38 }
39 
40 
41 const sal_uInt16 EXC_STR_MAXLEN_8BIT = 0x00FF;
42 const sal_uInt16 EXC_STR_MAXLEN = 0x7FFF;
43 
46 const sal_uInt8 EXC_STRF_RICH = 0x08;
48 
49 // Fixed-size characters
50 const sal_uInt8 EXC_LF_C = '\x0A';
51 const sal_uInt16 EXC_LF = EXC_LF_C;
52 const sal_uInt8 EXC_NUL_C = '\x00';
53 const sal_uInt16 EXC_NUL = EXC_NUL_C;
54 
55 // Rich-string formatting runs ================================================
56 
64 {
65  sal_uInt16 mnChar;
66  sal_uInt16 mnFontIdx;
67 
68  explicit XclFormatRun() : mnChar( 0 ), mnFontIdx( 0 ) {}
69  explicit XclFormatRun( sal_uInt16 nChar, sal_uInt16 nFontIdx ) :
70  mnChar( nChar ), mnFontIdx( nFontIdx ) {}
71 };
72 
73 inline bool operator==( const XclFormatRun& rLeft, const XclFormatRun& rRight )
74 {
75  return (rLeft.mnChar == rRight.mnChar) && (rLeft.mnFontIdx == rRight.mnFontIdx);
76 }
77 
78 inline bool operator<( const XclFormatRun& rLeft, const XclFormatRun& rRight )
79 {
80  return (rLeft.mnChar < rRight.mnChar) || ((rLeft.mnChar == rRight.mnChar) && (rLeft.mnFontIdx < rRight.mnFontIdx));
81 }
82 
84 typedef ::std::vector< XclFormatRun > XclFormatRunVec;
85 
86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const sal_uInt16 EXC_STR_MAXLEN
Definition: xlstring.hxx:42
XclStrFlags
Flags used to specify import/export mode of strings.
Definition: xlstring.hxx:28
const sal_uInt8 EXC_LF_C
Definition: xlstring.hxx:50
XclFormatRun(sal_uInt16 nChar, sal_uInt16 nFontIdx)
Definition: xlstring.hxx:69
const sal_uInt16 EXC_STR_MAXLEN_8BIT
Definition: xlstring.hxx:41
NUL character (unicode).
Definition: xlstring.hxx:63
Omit flags on empty string (default: read/write always). BIFF8 only.
Import: Keep old formats when reading unformatted string (default: clear formats); Export: Write unfo...
::std::vector< XclFormatRun > XclFormatRunVec
A vector with all formatting runs for a rich-string.
Definition: xlstring.hxx:84
8-bit string length field (default: 16-bit).
const sal_uInt16 EXC_NUL
NUL character.
Definition: xlstring.hxx:53
const sal_uInt8 EXC_STRF_16BIT
Definition: xlstring.hxx:44
bool operator<(const XclFormatRun &rLeft, const XclFormatRun &rRight)
Definition: xlstring.hxx:78
const sal_uInt8 EXC_STRF_RICH
Definition: xlstring.hxx:46
bool operator==(const XclFormatRun &rLeft, const XclFormatRun &rRight)
Definition: xlstring.hxx:73
Default string settings.
const sal_uInt16 EXC_LF
LF character (used for line break).
Definition: xlstring.hxx:51
const sal_uInt8 EXC_STRF_FAREAST
Definition: xlstring.hxx:45
const sal_uInt8 EXC_NUL_C
LF character (unicode).
Definition: xlstring.hxx:52
unsigned char sal_uInt8
Always use UCS-2 characters (default: try to compress). BIFF8 only.
const sal_uInt8 EXC_STRF_UNKNOWN
Definition: xlstring.hxx:47
sal_uInt16 mnFontIdx
First character this format applies to.
Definition: xlstring.hxx:66
sal_uInt16 mnChar
Definition: xlstring.hxx:65
XclFormatRun()
Excel font index for the next characters.
Definition: xlstring.hxx:68