kde-extraapps/kdevplatform/plugins/subversion/kdevsvncpp/context.hpp
2015-07-26 14:23:17 +03:00

165 lines
3.5 KiB
C++

/*
* ====================================================================
* Copyright (c) 2002-2009 The RapidSvn Group. All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program (in the file GPL.txt.
* If not, see <http://www.gnu.org/licenses/>.
*
* This software consists of voluntary contributions made by many
* individuals. For exact contribution history, see the revision
* history and logs, available at http://rapidsvn.tigris.org/.
* ====================================================================
*/
#ifndef _SVNCPP_CONTEXT_HPP_
#define _SVNCPP_CONTEXT_HPP_
// stl
#include "kdevsvncpp/string_wrapper.hpp"
// Subversion api
#include "svn_client.h"
// svncpp
#include "kdevsvncpp/pool.hpp"
namespace svn
{
// forward declarations
class ContextListener;
/**
* This class will hold the client context
* and replace the old notification and baton
* stuff
*/
class Context
{
public:
/**
* default constructor
*
* @param configDir location where the
* subversion api stores its
* configuration
*/
Context(const std::string & configDir = "");
/**
* copy constructor
*
* @param src
*/
Context(const Context &src);
/**
* destructor
*/
virtual ~Context();
/**
* enable/disable authentication caching
*
* @param value true=enable/false=disable
*/
void setAuthCache(bool value);
/**
* set username/password for authentication
*/
void setLogin(const char * username, const char * password);
/**
* operator to get svn_client_ctx object
*/
operator svn_client_ctx_t * ();
/**
* return the svn_client_ctx object
*/
svn_client_ctx_t * ctx();
/**
* this will be called at the beginning of an action.
* the log message will be reset.
*/
void reset();
/**
* set log message
*
* @param msg
*/
void setLogMessage(const char * msg);
/**
* get log message
*
* @return log message
*/
const char *
getLogMessage() const;
/**
* get username
*
* @return username
*/
const char *
getUsername() const;
/**
* get password
*
* @return password
*/
const char *
getPassword() const;
/**
* set the listener for the context. The listener will be
* called to poll authentication information and other
* information like this
*
* @param listener
*/
void
setListener(ContextListener * listener);
/**
* get the listener
*
* @return the listener
*/
ContextListener *
getListener() const;
private:
struct Data;
Data * m;
/**
* disable assignment operator
*/
Context & operator = (const Context &);
};
}
#endif
/* -----------------------------------------------------------------
* local variables:
* eval: (load-file "../../rapidsvn-dev.el")
* end:
*/