src/log4qt/layout.h

Go to the documentation of this file.

/******************************************************************************
 *
 * package:     Log4Qt
 * file:        layout.h
 * created:     September 2007
 * author:      Martin Heinrich
 *
 * 
 * Copyright 2007 Martin Heinrich
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 ******************************************************************************/

#ifndef LOG4QT_LAYOUT_H
#define LOG4QT_LAYOUT_H


/******************************************************************************
 * Dependencies
 ******************************************************************************/

#include "log4qt/helpers/logobject.h"

#include "log4qt/helpers/logobjectptr.h"
#include "log4qt/log4qt.h"


/******************************************************************************
 * Declarations
 ******************************************************************************/

namespace Log4Qt
{    
    
    class LoggingEvent;
    
    class Layout : public LogObject
    {
        Q_OBJECT
    
        Q_PROPERTY(QString footercontentType READ contentType)
        Q_PROPERTY(QString footer READ footer WRITE setFooter)
        Q_PROPERTY(QString header READ header WRITE setHeader)
        
    public:
        Layout(QObject *pParent = 0);
        virtual ~Layout();
    private:
        Layout(const Layout &rOther); // Not implemented
        Layout &operator=(const Layout &rOther); // Not implemented
            
    public:
        virtual QString contentType() const;
        QString footer() const;
        QString header() const;
        // JAVA: virtual bool ignoresThrowable() const;
        QString name() const;
        void setFooter(const QString &rFooter);
        void setHeader(const QString &rHeader);
        void setName(const QString &rName);
        // JAVA: void setIgnoresThrowable(bool) const;
    
        virtual void activateOptions();
        virtual QString format(const LoggingEvent &rEvent) = 0;
        
        static QString endOfLine();
        
        // Member variables
    private:
        QString mFooter;
        QString mHeader;
    };
    
    
    /**************************************************************************
     * Operators, Helper
     **************************************************************************/
    
    
    /**************************************************************************
     * Inline
     **************************************************************************/
    
    inline Layout::Layout(QObject *pParent) :
        LogObject(pParent)
    {}
    
    inline Layout::~Layout()
    {}
    
    inline QString Layout::footer() const
    {   return mFooter; }
    
    inline QString Layout::header() const
    {   return mHeader; }
    
    inline QString Layout::name() const
    {   return objectName();    }
    
    inline void Layout::setFooter(const QString &rFooter)
    {   mFooter = rFooter;  }
    
    inline void Layout::setHeader(const QString &rHeader)
    {   mHeader = rHeader;  }
    
    inline void Layout::setName(const QString &rName)
    {   setObjectName(rName);  }
    
    
} // namespace Log4Qt


// Q_DECLARE_TYPEINFO(Log4Qt::Layout, Q_COMPLEX_TYPE); // Use default
Q_DECLARE_TYPEINFO(Log4Qt::LogObjectPtr<Log4Qt::Layout>, Q_MOVABLE_TYPE);


#endif // LOG4QT_LAYOUT_H

---