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_export.h"
     18 #include "ui/base/x/selection_utils.h"
     19 #include "ui/base/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_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   // Retrieves a list of types we're offering.
     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   // Releases the selection (if we own it) and clears any data we own.
     46   void Clear();
     47 
     48   // It is our owner's responsibility to plumb X11 events on |xwindow_| to us.
     49   void OnSelectionRequest(const XSelectionRequestEvent& event);
     50   void OnSelectionClear(const XSelectionClearEvent& event);
     51   // TODO(erg): Do we also need to follow PropertyNotify events? We currently
     52   // don't, but there were open todos in the previous implementation.
     53 
     54  private:
     55   // Our X11 state.
     56   Display* x_display_;
     57   ::Window x_window_;
     58 
     59   // The X11 selection that this instance communicates on.
     60   ::Atom selection_name_;
     61 
     62   // The data we are currently serving.
     63   SelectionFormatMap format_map_;
     64 
     65   X11AtomCache atom_cache_;
     66 
     67   DISALLOW_COPY_AND_ASSIGN(SelectionOwner);
     68 };
     69 
     70 }  // namespace ui
     71 
     72 #endif  // UI_BASE_X_SELECTION_OWNER_H_
     73