GridBase Class

Member Function Documentation

GridBase::GridBase(QWidget *parent = Q_NULL)

Constructor of the class GridBase. The parameter parent is a widget which will be parent and owner for the grid.

[override virtual noexcept] GridBase::~GridBase()

Destuctor of the class Qtitan::GridBase.

GridHitInfo GridBase::hitInfo(const QPoint &pos)

Returns a hint info by given point. The method is used to determine the type of element which is located at the given point of the grid.

QList<GridHitInfo> GridBase::hitInfoAll() const

Returns a list of GridHitInfo for all grid's elements that are visible on the view.

bool GridBase::loadLayoutFromDevice(QIODevice *device)

Load from XML of the internals view from the given device.

See also loadLayoutFromFile() and loadLayoutFromXML().

bool GridBase::loadLayoutFromFile(const QString &fileName)

Load from XML of the internals view from the given fileName.

See also loadLayoutFromDevice() and loadLayoutFromXML().

bool GridBase::loadLayoutFromXML(IXmlStreamReader *xmlreader)

Load from XML of the internals view from the XML reader - xmlreader.

See also loadLayoutFromDevice() and loadLayoutFromFile().

[static] bool GridBase::loadTranslation(const QString &country = QString())

Installs translator to QApplication based on country variable. Format variable is de_de, ru_ru, fr_fr. If country is empty then loaded QTranslator based on current locale setting.

GridViewBase *GridBase::rootView() const

Returns a reference to a base class of the view. This reference must be converted into the desired type of view by youself.

Qtitan::Grid* grid = new Qtitan::Grid();
grid->setViewType(Qtitan::Grid::TableView);
GridTableView* view = qobject_cast<GridTableView *>(grid->rootView());

See also setRootView().

bool GridBase::saveLayoutToDevice(QIODevice *device, GridBase::SaveOption option = SaveAll)

Save to XML of the internals view to the given device and option. The layout includes column's or band's sizing, order of grouping, visual position of the elements and etc. Additionally, the filter state and filter history can be stored. To do this, it is necessary to pass the flags GridSaveOption::SaveFilter | GridSaveOption::SaveFilterHistory via option parameter.

See also saveLayoutToFile() and saveLayoutToXML().

bool GridBase::saveLayoutToFile(const QString &fileName, GridBase::SaveOption option = SaveAll)

Save to XML of the internals view to the file given by fileName and option. For the details see saveLayoutToDevice().

See also saveLayoutToDevice() and saveLayoutToXML().

bool GridBase::saveLayoutToXML(IXmlStreamWriter *xmlwriter, GridBase::SaveOption option = SaveAll)

Save to XML of the internals view to the XML writer - xmlwriter with the given option.

See also saveLayoutToDevice() and saveLayoutToFile().

[protected] void GridBase::setRootView(GridViewBase *view)

Sets the view instance to the grid. For internal purpose only.

See also rootView().

[override virtual] QSize GridBase::sizeHint() const

Reimplements: QAbstractScrollArea::sizeHint() const.

Returns an optimal size of the grid.

template <typename View> View *GridBase::view() const

Returns the instance of the view for the current grid. The function is a C++ template. It's allow you to get the view desired type.

Qtitan::Grid* grid = new Qtitan::Grid();
grid->setViewType(Qtitan::Grid::TableView);
GridTableView* view = grid->view<GridTableView>();

Alternatively, there is a method rootView() which returns a reference to a base class of the view. This reference must be converted into the desired type of view by youself. If the viewType is UndefinedView then this function return NULL.

See also setViewType() and viewType().