vcl/inc/salsys.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 INCLUDED_VCL_INC_SALSYS_HXX
  21 #define INCLUDED_VCL_INC_SALSYS_HXX
  22
  23 #include <tools/gen.hxx>
  24 #include <vcl/dllapi.h>
  25 #include <rtl/ustring.hxx>
  26
  27 // Button identifier for ShowNativeMessageBox
  28 const int SALSYSTEM_SHOWNATIVEMSGBOX_BTN_OK = 1;
  29
  30 class VCL_PLUGIN_PUBLIC SalSystem
  31 {
  32 public:
  33     SalSystem() {}
  34     virtual ~SalSystem();
  35
  36     // get info about the display
  37
  38     /*  Gets the number of active screens attached to the display
  39
  40         @returns the number of active screens
  41     */
  42     virtual unsigned int GetDisplayScreenCount() = 0;
  43     /*  Queries whether multiple screens are part of one bigger display
  44
  45         @returns true if screens form one big display
  46                  false if screens are distinct and windows cannot
  47                  be moved between, or span multiple screens
  48     */
  49     virtual bool IsUnifiedDisplay() { return true; }
  50     /*  Queries the default screen number. The default screen is the
  51         screen on which windows will appear if no special positioning
  52         is made.
  53
  54         @returns the default screen number
  55     */
  56     virtual unsigned int GetDisplayBuiltInScreen() { return 0; }
  57     /*  Gets relative position and size of the screens attached to the display
  58
  59         @param nScreen
  60         The screen number to be queried
  61
  62         @returns position: (0,0) in case of IsMultiscreen() == true
  63                            else position relative to whole display
  64                  size: size of the screen
  65     */
  66     virtual tools::Rectangle GetDisplayScreenPosSizePixel(unsigned int nScreen) = 0;
  67
  68     /*  Shows a native message box with the specified title, message and button
  69         combination.
  70
  71         @param  rTitle
  72         The title to be shown by the dialog box.
  73
  74         @param  rMessage
  75         The message to be shown by the dialog box.
  76
  77         @returns the identifier of the button that was pressed by the user.
  78         See button identifier above. If the function fails the
  79         return value is 0.
  80     */
  81     virtual int ShowNativeMessageBox(const OUString& rTitle, const OUString& rMessage) = 0;
  82 };
  83
  84 VCL_DLLPUBLIC SalSystem* ImplGetSalSystem();
  85
  86 #endif // INCLUDED_VCL_INC_SALSYS_HXX
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */