Home | History | Annotate | Download | only in x
      1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef UI_BASE_X_SELECTION_OWNER_H_
      6 #define UI_BASE_X_SELECTION_OWNER_H_
      7 
      8 #include <X11/Xlib.h>
      9 
     10 // Get rid of a macro from Xlib.h that conflicts with Aura's RootWindow class.
     11 #undef RootWindow
     12 
     13 #include <vector>
     14 
     15 #include "base/basictypes.h"
     16 #include "base/callback.h"
     17 #include "ui/base/ui_base_export.h"
     18 #include "ui/base/x/selection_utils.h"
     19 #include "ui/gfx/x/x11_atom_cache.h"
     20 
     21 namespace ui {
     22 
     23 // Owns a specific X11 selection on an X window.
     24 //
     25 // The selection owner object keeps track of which xwindow is the current
     26 // owner, and when its |xwindow_|, offers different data types to other
     27 // processes.
     28 class UI_BASE_EXPORT SelectionOwner {
     29  public:
     30   SelectionOwner(Display* xdisplay,
     31                  ::Window xwindow,
     32                  ::Atom selection_name);
     33   ~SelectionOwner();
     34 
     35   // Returns the current selection data. Useful for fast paths.
     36   const SelectionFormatMap& selection_format_map() { return format_map_; }
     37 
     38   // Appends a list of types we're offering to |targets|.
     39   void RetrieveTargets(std::vector<Atom>* targets);
     40 
     41   // Attempts to take ownership of the selection. If we're successful, present
     42   // |data| to other windows.
     43   void TakeOwnershipOfSelection(const SelectionFormatMap& data);
     44 
     45   // Clears our internal format map and clears the selection owner, whether we
     46   // own the selection or not.
     47   void ClearSelectionOwner();
     48 
     49   // It is our owner's responsibility to plumb X11 events on |xwindow_| to us.
     50   void OnSelectionRequest(const XSelectionRequestEvent& event);
     51   void OnSelectionClear(const XSelectionClearEvent& event);
     52   // TODO(erg): Do we also need to follow PropertyNotify events? We currently
     53   // don't, but there were open todos in the previous implementation.
     54 
     55  private:
     56   // Attempts to convert the selection to |target|. If the conversion is
     57   // successful, true is returned and the result is stored in the |property|
     58   // of |requestor|.
     59   bool ProcessTarget(::Atom target, ::Window requestor, ::Atom property);
     60 
     61   // Our X11 state.
     62   Display* x_display_;
     63   ::Window x_window_;
     64 
     65   // The X11 selection that this instance communicates on.
     66   ::Atom selection_name_;
     67 
     68   // The data we are currently serving.
     69   SelectionFormatMap format_map_;
     70 
     71   X11AtomCache atom_cache_;
     72 
     73   DISALLOW_COPY_AND_ASSIGN(SelectionOwner);
     74 };
     75 
     76 }  // namespace ui
     77 
     78 #endif  // UI_BASE_X_SELECTION_OWNER_H_
     79