include/svtools/inettbc.hxx

   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 #ifndef _SVTOOLS_INETTBC_HXX
  21 #define _SVTOOLS_INETTBC_HXX
  22
  23 #include "rtl/ref.hxx"
  24 #include "svtools/svtdllapi.h"
  25 #include <tools/string.hxx>
  26 #include <tools/urlobj.hxx>
  27
  28 #include <vcl/combobox.hxx>
  29
  30 class SvtMatchContext_Impl;
  31 class SvtURLBox_Impl;
  32 class SVT_DLLPUBLIC SvtURLBox : public ComboBox
  33 {
  34 friend class SvtMatchContext_Impl;
  35 friend class SvtURLBox_Impl;
  36     Link                            aOpenHdl;
  37     String                          aBaseURL;
  38     String                          aPlaceHolder;
  39     rtl::Reference< SvtMatchContext_Impl > pCtx;
  40     SvtURLBox_Impl*                 pImp;
  41     INetProtocol                    eSmartProtocol;
  42     sal_Bool                            bAutoCompleteMode   : 1;
  43     sal_Bool                            bOnlyDirectories    : 1;
  44     sal_Bool                            bCtrlClick          : 1;
  45     sal_Bool                            bHistoryDisabled    : 1;
  46     sal_Bool                            bNoSelection        : 1;
  47     sal_Bool                            bIsAutoCompleteEnabled : 1;
  48
  49     SVT_DLLPRIVATE sal_Bool                         ProcessKey( const KeyCode& rCode );
  50     SVT_DLLPRIVATE void                         TryAutoComplete();
  51     SVT_DLLPRIVATE void                            UpdatePicklistForSmartProtocol_Impl();
  52     DECL_DLLPRIVATE_LINK(                      AutoCompleteHdl_Impl, void* );
  53     SVT_DLLPRIVATE void             Init(bool bSetDefaultHelpID);
  54
  55 protected:
  56     virtual long                    Notify( NotifyEvent& rNEvt );
  57     virtual void                    Select();
  58     virtual void                    Modify();
  59     virtual long                    PreNotify( NotifyEvent& rNEvt );
  60
  61 public:
  62                                     SvtURLBox( Window* pParent, INetProtocol eSmart = INET_PROT_NOT_VALID, bool bSetDefaultHelpID = true );
  63                                     SvtURLBox( Window* pParent, WinBits _nStyle, INetProtocol eSmart = INET_PROT_NOT_VALID, bool bSetDefaultHelpID = true );
  64                                     SvtURLBox( Window* pParent, const ResId& _rResId, INetProtocol eSmart = INET_PROT_NOT_VALID, bool bSetDefaultHelpID = true );
  65                                     ~SvtURLBox();
  66
  67     void                            SetBaseURL( const String& rURL );
  68     const String&                   GetBaseURL() const { return aBaseURL; }
  69     void                            SetOpenHdl( const Link& rLink ) { aOpenHdl = rLink; }
  70     const Link&                     GetOpenHdl() const { return aOpenHdl; }
  71     void                            SetOnlyDirectories( sal_Bool bDir = sal_True );
  72     void                            SetNoURLSelection( sal_Bool bSet = sal_True );
  73     INetProtocol                    GetSmartProtocol() const { return eSmartProtocol; }
  74     void                            SetSmartProtocol( INetProtocol eProt );
  75     sal_Bool                            IsCtrlOpen()
  76                                         { return bCtrlClick; }
  77     String                          GetURL();
  78     void                            DisableHistory();
  79
  80     void                            UpdatePickList( );
  81
  82     static String                   ParseSmart( String aText, String aBaseURL, String aWorkDir );
  83
  84     void                            SetFilter(const String& _sFilter);
  85
  86     inline void                     EnableAutocompletion( sal_Bool _bEnable = sal_True )
  87                                         { bIsAutoCompleteEnabled = _bEnable; }
  88     void SetPlaceHolder( const String& sPlaceHolder ) { aPlaceHolder = sPlaceHolder; }
  89     String GetPlaceHolder() { return aPlaceHolder; }
  90     bool MatchesPlaceHolder( const String& sToMatch ) { return ( ( aPlaceHolder.Len() > 0 ) && ( aPlaceHolder == sToMatch ) ); }
  91 };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */