summaryrefslogtreecommitdiff
path: root/binfilter/inc/bf_sfx2/timestamp.hxx
blob: bf53e319b74d33b88d17d763770d5256b20c017f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef _SFX2_TIMESTAMP_HXX
#define _SFX2_TIMESTAMP_HXX

#include <bf_svtools/bf_solar.h>

#include <bf_tools/string.hxx>

#include <tools/stream.hxx>

#include <tools/datetime.hxx>

namespace binfilter {

#define TIMESTAMP_MAXLENGTH             31                                                      /// Max. length of valid timestamp in stream.

//______________________________________________________________________________________________________________________________
//  classes, structs
//______________________________________________________________________________________________________________________________

class TimeStamp
{
    //--------------------------------------------------------------------------------
    //  public method
    //--------------------------------------------------------------------------------
    public:

        //--------------------------------------------------------------------------------
        //  construct / destruct
        //--------------------------------------------------------------------------------

        TimeStamp (                                                 ) ;
        TimeStamp ( const String& rName                             ) ;
        TimeStamp ( const DateTime& rDateTime                       ) ;
        TimeStamp ( const String& rName, const DateTime& rDateTime  ) ;

        //--------------------------------------------------------------------------------
        //  operator methods
        //--------------------------------------------------------------------------------

        const TimeStamp&    operator=   ( const TimeStamp& rCopy    )       ;
        BOOL                operator==  ( const TimeStamp& rCompare ) const ;
        int                 operator!=  ( const TimeStamp& rCompare ) const ;

        //--------------------------------------------------------------------------------
        //  other methods
        //--------------------------------------------------------------------------------

        BOOL                IsValid (                           ) const ;
        void                SetInvalid();
        BOOL                Load    ( SvStream& rStream         )       ;
        BOOL                Save    ( SvStream& ) const {return false;}
        void                SetName ( const String& rName       )       ;
        void                SetTime ( const DateTime& rDateTime )       ;
        const String&       GetName (                           ) const ;
        const DateTime&     GetTime (                           ) const ;

    //--------------------------------------------------------------------------------
    //  protected methods
    //--------------------------------------------------------------------------------
    protected:

    //--------------------------------------------------------------------------------
    //  private methods
    //--------------------------------------------------------------------------------
    private:

        void    impl_adjustName     ( String& rName ) ;

        //--------------------------------------------------------------------------------
        //  debug methods
        //--------------------------------------------------------------------------------

        #ifdef DBG_UTIL

        BOOL    impl_debug_checkParameter   ( const String& rString                             ) const ;
        BOOL    impl_debug_checkParameter   ( const String& rString, const DateTime& rDateTime  ) const ;
        BOOL    impl_debug_checkParameter   ( const TimeStamp& rTimeStamp                       ) const ;
        BOOL    impl_debug_checkParameter   ( SvStream& rSvStream                               ) const ;
        BOOL    impl_debug_checkParameter   ( const DateTime& rDateTime                         ) const ;

        #endif // DBG_UTIL

    //--------------------------------------------------------------------------------
    //  private variables
    //--------------------------------------------------------------------------------
    private:

        String      m_sModifiedByName   ;   /// Name of stamp
        DateTime    m_aModifiedDateTime ;   /// Time and date of stamp
} ;

}
#endif // _TIMESTAMP_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */